Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.io.oml
Class OmlReader

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.align.io.impl.AbstractAlignmentReader
              extended by eu.esdihumboldt.hale.io.oml.OmlReader
All Implemented Interfaces:
AlignmentReader, ImportProvider, IOProvider

public class OmlReader
extends AbstractAlignmentReader
implements AlignmentReader

This class reads the OML Document into Java Object.

Author:
Kevin Mais

Field Summary
 
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
OmlReader()
          Default Constructor
 
Method Summary
protected  IOReport execute(ProgressIndicator progress, IOReporter reporter)
          Execute the I/O provider.
 MutableAlignment getAlignment()
          Get the loaded alignment
protected  String getDefaultTypeName()
          Get the default type name if no content type is provided
 boolean isCancelable()
          States if the execution of the provider is cancelable
 
Methods inherited from class eu.esdihumboldt.hale.common.align.io.impl.AbstractAlignmentReader
getSourceSchema, getTargetSchema, setSourceSchema, setTargetSchema, validate
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractImportProvider
createReporter, execute, generateResourceId, getResourceIdentifier, getSource, 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.align.io.AlignmentReader
setSourceSchema, setTargetSchema
 
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, validate
 

Constructor Detail

OmlReader

public OmlReader()
Default Constructor

Method Detail

isCancelable

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

Specified by:
isCancelable in interface IOProvider
Returns:
if the execution is cancelable
See Also:
IOProvider.isCancelable()

getAlignment

public MutableAlignment getAlignment()
Description copied from interface: AlignmentReader
Get the loaded alignment

Specified by:
getAlignment in interface AlignmentReader
Returns:
the loaded alignment
See Also:
AlignmentReader.getAlignment()

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(eu.esdihumboldt.hale.common.core.io.ProgressIndicator, eu.esdihumboldt.hale.common.core.io.report.IOReporter)

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()

Humboldt Alignment Editor 2.5.0

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