Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.io.html
Class HtmlMappingExporter

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.align.io.impl.AbstractAlignmentWriter
              extended by eu.esdihumboldt.hale.io.html.HtmlMappingExporter
All Implemented Interfaces:
AlignmentWriter, ExportProvider, IOProvider, ProjectInfoAware

public class HtmlMappingExporter
extends AbstractAlignmentWriter
implements ProjectInfoAware

Export a Mapping to HTML for documentation purposes.

Author:
Kevin Mais

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
HtmlMappingExporter()
           
 
Method Summary
protected  IOReport execute(ProgressIndicator progress, IOReporter reporter)
          Execute the I/O provider.
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
 void setProjectInfo(ProjectInfo projectInfo)
          Set information about the current project.
 
Methods inherited from class eu.esdihumboldt.hale.common.align.io.impl.AbstractAlignmentWriter
getAlignment, getSourceSchema, getTargetSchema, setAlignment, setSourceSchema, setTargetSchema, validate
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractExportProvider
createReporter, getTarget, setParameter, setTarget, storeConfiguration
 
Methods inherited from class eu.esdihumboldt.hale.common.core.io.impl.AbstractIOProvider
addSupportedParameter, execute, 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.core.io.ExportProvider
getTarget, setTarget
 
Methods inherited from interface eu.esdihumboldt.hale.common.core.io.IOProvider
createReporter, execute, getContentType, getParameter, getSupportedParameters, loadConfiguration, setContentType, setParameter, storeConfiguration
 

Constructor Detail

HtmlMappingExporter

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

setProjectInfo

public void setProjectInfo(ProjectInfo projectInfo)
Description copied from interface: ProjectInfoAware
Set information about the current project.

Specified by:
setProjectInfo in interface ProjectInfoAware
Parameters:
projectInfo - the project information, may be null if no project is available
See Also:
ProjectInfoAware.setProjectInfo(eu.esdihumboldt.hale.common.core.io.project.ProjectInfo)

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

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

Humboldt Alignment Editor 2.5.0

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