InlineXmlCasConsumer (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.cpe.InlineXmlCasConsumer

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 InlineXmlCasConsumer
extends org.apache.uima.collection.CasConsumer_ImplBase
```
A simple CAS consumer that generates inline XML and writes it to a file. UTF-8 encoding is used.
This CAS Consumer takes one parameter:
- OutputDirectory - path to directory into which output files will be written

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.

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

InlineXmlCasConsumer()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`initialize()`
`void`	`processCas(org.apache.uima.cas.CAS aCAS)` Processes the CasContainer which was populated by the TextAnalysisEngines.

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
- Constructor Detail
  - InlineXmlCasConsumer
```
public InlineXmlCasConsumer()
```
- 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 the CasContainer which was populated by the TextAnalysisEngines.
    In this case, the CAS is converted to XML and written into the output file .
    
    Parameters:
    aCAS - CasContainer which has been populated by the TAEs
    
    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.