Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.instance.io.impl
Class AbstractInstanceWriter

java.lang.Object
  extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
      extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractExportProvider
          extended by eu.esdihumboldt.hale.common.core.io.impl.GZipEnabledExport
              extended by eu.esdihumboldt.hale.common.instance.io.impl.AbstractInstanceWriter
All Implemented Interfaces:
ExportProvider, IOProvider, InstanceWriter
Direct Known Subclasses:
StreamGmlWriter

public abstract class AbstractInstanceWriter
extends GZipEnabledExport
implements InstanceWriter

Abstract InstanceWriter base implementation

Since:
2.5
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.GZipEnabledExport
GZipEnabledExport.GZipOutputSupplier
 
Field Summary
 
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.ExportProvider
PARAM_TARGET
 
Fields inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
PARAM_CONTENT_TYPE
 
Constructor Summary
AbstractInstanceWriter()
           
 
Method Summary
 void checkCompatibility()
          Validate the basic InstanceWriter configuration, to determine if the target schema (and instances if set) are compatible to the writer.
protected  InstanceCollection getInstances()
           
 SchemaSpace getTargetSchema()
          Get the target schema.
 List<? extends Locatable> getValidationSchemas()
          Returns the target schema; override to return another set of schemas
 void setInstances(InstanceCollection instances)
          Set the instances to write.
 void setTargetSchema(SchemaSpace targetSchema)
          Set the target schema for the output.
 void validate()
          Additionally checks for instances.
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.GZipEnabledExport
getTarget
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractExportProvider
createReporter, setParameter, setTarget, storeConfiguration
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
addSupportedParameter, execute, execute, fail, getContentType, getDefaultTypeName, 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.ExportProvider
getTarget, setTarget
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
createReporter, execute, getContentType, getParameter, getSupportedParameters, isCancelable, loadConfiguration, setContentType, setParameter, storeConfiguration
 

Constructor Detail

AbstractInstanceWriter

public AbstractInstanceWriter()
Method Detail

validate

public void validate()
              throws IOProviderConfigurationException
Additionally checks for instances.

Specified by:
validate in interface IOProvider
Overrides:
validate in class AbstractExportProvider
Throws:
IOProviderConfigurationException - if the I/O provider was not configured properly
See Also:
AbstractExportProvider.validate()

checkCompatibility

public void checkCompatibility()
                        throws IOProviderConfigurationException
Description copied from interface: InstanceWriter
Validate the basic InstanceWriter configuration, to determine if the target schema (and instances if set) are compatible to the writer. Other parameters should be ignored for the check.

Specified by:
checkCompatibility in interface InstanceWriter
Throws:
IOProviderConfigurationException - if the I/O provider was not configured properly
See Also:
InstanceWriter.checkCompatibility()

getValidationSchemas

public List<? extends Locatable> getValidationSchemas()
Returns the target schema; override to return another set of schemas

Specified by:
getValidationSchemas in interface InstanceWriter
Returns:
the schemas needed for validation
See Also:
InstanceWriter.getValidationSchemas()

setInstances

public void setInstances(InstanceCollection instances)
Description copied from interface: InstanceWriter
Set the instances to write.

Specified by:
setInstances in interface InstanceWriter
Parameters:
instances - the instances to write
See Also:
InstanceWriter.setInstances(InstanceCollection)

setTargetSchema

public void setTargetSchema(SchemaSpace targetSchema)
Description copied from interface: InstanceWriter
Set the target schema for the output.

Specified by:
setTargetSchema in interface InstanceWriter
Parameters:
targetSchema - the target schema
See Also:
InstanceWriter.setTargetSchema(SchemaSpace)

getInstances

protected InstanceCollection getInstances()
Returns:
the instances

getTargetSchema

public SchemaSpace getTargetSchema()
Description copied from interface: InstanceWriter
Get the target schema.

Specified by:
getTargetSchema in interface InstanceWriter
Returns:
the target schema
See Also:
InstanceWriter.getTargetSchema()

Humboldt Alignment Editor 2.5.0

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