Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.io.gml.reader.internal
Class StreamGmlReader

java.lang.Object
  extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
      extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
          extended by eu.esdihumboldt.hale.common.core.io.impl.GZipEnabledImport
              extended by eu.esdihumboldt.hale.common.instance.io.impl.AbstractInstanceReader
                  extended by eu.esdihumboldt.hale.io.gml.reader.internal.StreamGmlReader
All Implemented Interfaces:
ImportProvider, IOProvider, InstanceReader
Direct Known Subclasses:
GmlInstanceReader, XmlInstanceReader

public class StreamGmlReader
extends AbstractInstanceReader

Reads XML/GML from a stream

Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Nested Class Summary
 
Nested classes/interfaces inherited from class eu.esdihumboldt.hale.common.core.io.impl.GZipEnabledImport
GZipEnabledImport.GZipInputSupplier
 
Field Summary
static String PARAM_IGNORE_ROOT
          The name of the parameter specifying if the root element should be ignored and thus not be loaded as an instance.
static String PARAM_STRICT
          The name of the parameter specifying if parsing of the XML instances should happen strictly according to the schema or if also invalid property paths will be allowed.
 
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.ImportProvider
PARAM_RESOURCE_ID, PARAM_SOURCE
 
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
PARAM_CONTENT_TYPE
 
Constructor Summary
StreamGmlReader(boolean restrictToFeatures)
          Constructor
 
Method Summary
protected  IOReport execute(ProgressIndicator progress, IOReporter reporter)
          Execute the I/O provider.
protected  String getDefaultTypeName()
          Get the default type name if no content type is provided
 InstanceCollection getInstances()
          Get the instances
 boolean isCancelable()
          States if the execution of the provider is cancelable
 
Methods inherited from class eu.esdihumboldt.hale.common.instance.io.impl.AbstractInstanceReader
getCrsProvider, getSourceSchema, setCRSProvider, setSourceSchema, validate
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.GZipEnabledImport
getSource
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
createReporter, execute, generateResourceId, getResourceIdentifier, setParameter, setSource, storeConfiguration
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
addSupportedParameter, fail, getContentType, getParameter, getSupportedParameters, getTypeName, loadConfiguration, setContentType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.ImportProvider
getResourceIdentifier, getSource, setSource
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
createReporter, execute, getContentType, getParameter, getSupportedParameters, loadConfiguration, setContentType, setParameter, storeConfiguration
 

Field Detail

PARAM_IGNORE_ROOT

public static final String PARAM_IGNORE_ROOT
The name of the parameter specifying if the root element should be ignored and thus not be loaded as an instance. Parameter value defaults to true.

See Also:
Constant Field Values

PARAM_STRICT

public static final String PARAM_STRICT
The name of the parameter specifying if parsing of the XML instances should happen strictly according to the schema or if also invalid property paths will be allowed. Parameter value defaults to false.

See Also:
Constant Field Values
Constructor Detail

StreamGmlReader

public StreamGmlReader(boolean restrictToFeatures)
Constructor

Parameters:
restrictToFeatures - if only instances that are GML features shall be loaded
Method Detail

execute

protected IOReport execute(ProgressIndicator progress,
                           IOReporter reporter)
                    throws IOProviderConfigurationException,
                           IOException
Description copied from class: AbstractIOProvider
Execute the I/O provider.

Specified by:
execute in class AbstractIOProvider
Parameters:
progress - the progress indicator
reporter - the reporter to use for the execution report
Returns:
the execution report
Throws:
IOProviderConfigurationException - if the I/O provider was not configured properly
IOException - if an I/O operation fails
See Also:
AbstractIOProvider.execute(ProgressIndicator, IOReporter)

getInstances

public InstanceCollection getInstances()
Description copied from interface: InstanceReader
Get the instances

Returns:
the instance collection
See Also:
InstanceReader.getInstances()

getDefaultTypeName

protected String getDefaultTypeName()
Description copied from class: AbstractIOProvider
Get the default type name if no content type is provided

Specified by:
getDefaultTypeName in class AbstractIOProvider
Returns:
the default content type
See Also:
AbstractIOProvider.getDefaultTypeName()

isCancelable

public boolean isCancelable()
Description copied from interface: IOProvider
States if the execution of the provider is cancelable

Returns:
if the execution is cancelable
See Also:
IOProvider.isCancelable()

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d