Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.core.io
Interface IOProvider

All Known Subinterfaces:
AlignmentReader, AlignmentWriter, CodeListReader, ExportProvider, ImportProvider, InstanceReader, InstanceValidator, InstanceWriter, ProjectReader, ProjectWriter, SchemaReader, StyleReader, StyleWriter, XmlWriterBase
All Known Implementing Classes:
AbstractAlignmentReader, AbstractAlignmentWriter, AbstractExportProvider, AbstractImportProvider, AbstractInstanceReader, AbstractInstanceValidator, AbstractInstanceWriter, AbstractIOProvider, AbstractProjectReader, AbstractProjectWriter, AbstractSchemaReader, AbstractStyleWriter, ArchiveProjectReader, ArchiveProjectWriter, CityGMLInstanceWriter, CSVInstanceReader, CSVSchemaReader, DefaultAlignmentReader, DefaultAlignmentWriter, DefaultProjectReader, DefaultProjectWriter, GmlInstanceReader, GmlInstanceWriter, GZipEnabledExport, GZipEnabledImport, HtmlMappingExporter, OmlReader, ProjectParser, ShapeInstanceReader, ShapeSchemaReader, SLDStyleReader, SLDStyleWriter, StreamGmlReader, StreamGmlWriter, XmlCodeListReader, XmlInstanceReader, XmlInstanceValidator, XmlInstanceWriter, XMLProjectReader, XMLProjectWriter, XmlSchemaReader, ZipProjectReader, ZipProjectWriter

public interface IOProvider

Interface for I/O providers

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

Field Summary
static String PARAM_CONTENT_TYPE
          The configuration parameter name for the content type
 
Method Summary
 IOReporter createReporter()
          Create a reporter configured for the execution of this I/O provider.
 IOReport execute(ProgressIndicator progress)
          Execute the I/O provider.
 org.eclipse.core.runtime.content.IContentType getContentType()
          Get the content type
 String getParameter(String name)
          Get the value for the given parameter name
 Set<String> getSupportedParameters()
          Get the supported configuration parameters.
 boolean isCancelable()
          States if the execution of the provider is cancelable
 void loadConfiguration(Map<String,String> configuration)
          Load the configuration from a map of key/value pairs
 void setContentType(org.eclipse.core.runtime.content.IContentType contentType)
          Set the content type.
 void setParameter(String name, String value)
          Set a parameter
 void storeConfiguration(Map<String,String> configuration)
          Store the configuration in a map of key/value pairs
 void validate()
          Validate the I/O provider configuration
 

Field Detail

PARAM_CONTENT_TYPE

static final String PARAM_CONTENT_TYPE
The configuration parameter name for the content type

See Also:
Constant Field Values
Method Detail

execute

IOReport execute(ProgressIndicator progress)
                 throws IOProviderConfigurationException,
                        IOException
Execute the I/O provider.

Parameters:
progress - the progress indicator, may be null
Returns:
the execution report
Throws:
IOProviderConfigurationException - if the I/O provider was not configured properly
IOException - if an I/O operation fails

createReporter

IOReporter createReporter()
Create a reporter configured for the execution of this I/O provider. This method can also be used internally in the implementation of execute(ProgressIndicator).

Returns:
the I/O reporter

isCancelable

boolean isCancelable()
States if the execution of the provider is cancelable

Returns:
if the execution is cancelable

validate

void validate()
              throws IOProviderConfigurationException
Validate the I/O provider configuration

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

setContentType

void setContentType(org.eclipse.core.runtime.content.IContentType contentType)
Set the content type. This may be optional if the I/O provider doesn't differentiate between content types.

Parameters:
contentType - the content type

getContentType

org.eclipse.core.runtime.content.IContentType getContentType()
Get the content type

Returns:
the content type, may be null

getSupportedParameters

Set<String> getSupportedParameters()
Get the supported configuration parameters.

Returns:
the supported parameters

setParameter

void setParameter(String name,
                  String value)
Set a parameter

Parameters:
name - the parameter name
value - the parameter value

getParameter

String getParameter(String name)
Get the value for the given parameter name

Parameters:
name - the parameter name
Returns:
the parameter value or null

loadConfiguration

void loadConfiguration(Map<String,String> configuration)
Load the configuration from a map of key/value pairs

Parameters:
configuration - the configuration to load

storeConfiguration

void storeConfiguration(Map<String,String> configuration)
Store the configuration in a map of key/value pairs

Parameters:
configuration - the configuration to populate

Humboldt Alignment Editor 2.5.0

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