Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.core.io.impl
Class AbstractExportProvider

java.lang.Object
  extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
      extended by eu.esdihumboldt.hale.common.core.io.impl.AbstractExportProvider
All Implemented Interfaces:
ExportProvider, IOProvider
Direct Known Subclasses:
AbstractAlignmentWriter, AbstractProjectWriter, AbstractStyleWriter, GZipEnabledExport

public abstract class AbstractExportProvider
extends AbstractIOProvider
implements ExportProvider

Abstract ExportProvider implementation

Since:
2.2
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
 
Constructor Summary
AbstractExportProvider()
           
 
Method Summary
 IOReporter createReporter()
          Create a reporter configured for the execution of this I/O provider.
 LocatableOutputSupplier<? extends OutputStream> getTarget()
          Get the export target
 void setParameter(String name, String value)
          Set a parameter
 void setTarget(LocatableOutputSupplier<? extends OutputStream> target)
          Set the export target
 void storeConfiguration(Map<String,String> configuration)
          Stores all parameters that were set using AbstractIOProvider.setParameter(String, String) in the configuration.
 void validate()
          Validate the I/O provider configuration
 
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.IOProvider
execute, getContentType, getParameter, getSupportedParameters, isCancelable, loadConfiguration, setContentType
 

Constructor Detail

AbstractExportProvider

public AbstractExportProvider()
Method Detail

setTarget

public void setTarget(LocatableOutputSupplier<? extends OutputStream> target)
Description copied from interface: ExportProvider
Set the export target

Specified by:
setTarget in interface ExportProvider
Parameters:
target - the target output supplier
See Also:
ExportProvider.setTarget(LocatableOutputSupplier)

getTarget

public LocatableOutputSupplier<? extends OutputStream> getTarget()
Description copied from interface: ExportProvider
Get the export target

Specified by:
getTarget in interface ExportProvider
Returns:
the target output supplier
See Also:
ExportProvider.getTarget()

validate

public void validate()
              throws IOProviderConfigurationException
Description copied from interface: IOProvider
Validate the I/O provider configuration

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

storeConfiguration

public void storeConfiguration(Map<String,String> configuration)
Description copied from class: AbstractIOProvider
Stores all parameters that were set using AbstractIOProvider.setParameter(String, String) in the configuration. For changing the behavior please override this method.

Specified by:
storeConfiguration in interface IOProvider
Overrides:
storeConfiguration in class AbstractIOProvider
Parameters:
configuration - the configuration to populate
See Also:
AbstractIOProvider.storeConfiguration(Map)

setParameter

public void setParameter(String name,
                         String value)
Description copied from interface: IOProvider
Set a parameter

Specified by:
setParameter in interface IOProvider
Overrides:
setParameter in class AbstractIOProvider
Parameters:
name - the parameter name
value - the parameter value
See Also:
AbstractIOProvider.setParameter(String, String)

createReporter

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

Specified by:
createReporter in interface IOProvider
Returns:
the I/O reporter
See Also:
IOProvider.createReporter()

Humboldt Alignment Editor 2.5.0

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