XmiEcoreCasConsumer (Apache UIMA Base: uimaj-examples: SDK Examples 2.5.0 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.uima.resource.Resource_ImplBase
- - org.apache.uima.resource.ConfigurableResource_ImplBase
  - - org.apache.uima.collection.CasConsumer_ImplBase
    - - org.apache.uima.examples.xmi.XmiEcoreCasConsumer

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasObjectProcessor, org.apache.uima.collection.base_cpm.CasProcessor, org.apache.uima.collection.CasConsumer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource
```
public class XmiEcoreCasConsumer
extends org.apache.uima.collection.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:
- OutputDirectory - path to directory into which output files will be written
- WriteEcoreTypeSystem - if true, writes the type system to an Ecore file and links all of the XMI files to it via their schemaLocation attribute. Requires EMF libraries in the classpath if this option is set to true.

Field Summary

Fields
Modifier and Type	Field and Description
`static 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 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_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors
Constructor and Description

XmiEcoreCasConsumer()

Method Summary

Methods
Modifier and Type Method and Description

void initialize()

void processCas(org.apache.uima.cas.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 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 String PARAM_WRITE_ECORE_TYPESYSTEM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - XmiEcoreCasConsumer
```
public XmiEcoreCasConsumer()
```
- Method Detail
  - initialize
```
public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException
```
    Overrides:
    
    initialize in class org.apache.uima.collection.CasConsumer_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - processCas
```
public void processCas(org.apache.uima.cas.CAS aCAS)
                throws org.apache.uima.resource.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:
    
    org.apache.uima.resource.ResourceProcessException - if there is an error in processing the Resource
    See Also:
    CasObjectProcessor.processCas(org.apache.uima.cas.CAS)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2006–2014 The Apache Software Foundation. All rights reserved.