Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.instance.io
Interface InstanceWriter

All Superinterfaces:
ExportProvider, IOProvider
All Known Implementing Classes:
AbstractInstanceWriter, CityGMLInstanceWriter, GmlInstanceWriter, StreamGmlWriter, XmlInstanceWriter

public interface InstanceWriter
extends ExportProvider

Provides support for writing instances

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

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
 
Method Summary
 void checkCompatibility()
          Validate the basic InstanceWriter configuration, to determine if the target schema (and instances if set) are compatible to the writer.
 SchemaSpace getTargetSchema()
          Get the target schema.
 List<? extends Locatable> getValidationSchemas()
          Get the schemas needed for validation of the output written using IOProvider.execute(ProgressIndicator), this usually is at least the target schema.
 void setInstances(InstanceCollection instances)
          Set the instances to write.
 void setTargetSchema(SchemaSpace targetSchema)
          Set the target schema for the output.
 
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, validate
 

Method Detail

setInstances

void setInstances(InstanceCollection instances)
Set the instances to write.

Parameters:
instances - the instances to write

setTargetSchema

void setTargetSchema(SchemaSpace targetSchema)
Set the target schema for the output.

Parameters:
targetSchema - the target schema

getTargetSchema

SchemaSpace getTargetSchema()
Get the target schema.

Returns:
the target schema

getValidationSchemas

List<? extends Locatable> getValidationSchemas()
Get the schemas needed for validation of the output written using IOProvider.execute(ProgressIndicator), this usually is at least the target schema.

Returns:
the schemas needed for validation

checkCompatibility

void checkCompatibility()
                        throws IOProviderConfigurationException
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.

Throws:
IOProviderConfigurationException - if the I/O provider was not configured properly

Humboldt Alignment Editor 2.5.0

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