org.apache.uima.examples.xmi
Class XmiEcoreCasConsumer

java.lang.Object
  extended by org.apache.uima.resource.Resource_ImplBase
      extended by org.apache.uima.resource.ConfigurableResource_ImplBase
          extended by org.apache.uima.collection.CasConsumer_ImplBase
              extended by org.apache.uima.examples.xmi.XmiEcoreCasConsumer
All Implemented Interfaces:
CasObjectProcessor, CasProcessor, CasConsumer, ConfigurableResource, Resource

public class XmiEcoreCasConsumer
extends CasConsumer_ImplBase

A variation of the XmiWriterCasConsumer that also saves the Type System to an Ecore file and links all of the XMI files to it via their schemaLocation attribute. This allows integration with the Eclipse Modeling Framework (EMF). This class requires the EMF libraries common.jar, ecore.jar, and ecore.xmi.jar to be in the classpath.

This CAS Consumer takes two parameters:


Field Summary
static java.lang.String PARAM_OUTPUTDIR
          Name of configuration parameter that must be set to the path of a directory into which the output files will be written.
static java.lang.String PARAM_WRITE_ECORE_TYPESYSTEM
           
 
Fields inherited from interface org.apache.uima.resource.Resource
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
 
Constructor Summary
XmiEcoreCasConsumer()
           
 
Method Summary
 void initialize()
          This method is called during initialization, and does nothing by default.
 void processCas(CAS aCAS)
          Processes a CAS.
 
Methods inherited from class org.apache.uima.collection.CasConsumer_ImplBase
batchProcessComplete, collectionProcessComplete, destroy, getProcessingResourceMetaData, initialize, isReadOnly, isStateless, processCas, reconfigure, typeSystemInit
 
Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
 
Methods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
 
Methods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
 

Field Detail

PARAM_OUTPUTDIR

public static final java.lang.String PARAM_OUTPUTDIR
Name of configuration parameter that must be set to the path of a directory into which the output files will be written.

See Also:
Constant Field Values

PARAM_WRITE_ECORE_TYPESYSTEM

public static final java.lang.String PARAM_WRITE_ECORE_TYPESYSTEM
See Also:
Constant Field Values
Constructor Detail

XmiEcoreCasConsumer

public XmiEcoreCasConsumer()
Method Detail

initialize

public void initialize()
                throws ResourceInitializationException
Description copied from class: CasConsumer_ImplBase
This method is called during initialization, and does nothing by default. Subclasses should override it to perform one-time startup logic.

Overrides:
initialize in class CasConsumer_ImplBase
Throws:
ResourceInitializationException - if a failure occurs during initialization.

processCas

public void processCas(CAS aCAS)
                throws ResourceProcessException
Processes a CAS. In this case, the CAS is converted to XMI and written into the output file .

Parameters:
aCAS - The CAS to write to XMI
Throws:
ResourceProcessException - if there is an error in processing the Resource
See Also:
CasObjectProcessor.processCas(org.apache.uima.cas.CAS)


Copyright © 2013. All Rights Reserved.