Package org.apache.uima.fit.component

Class CasDumpWriter

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.CasAnnotator_ImplBase

org.apache.uima.fit.component.CasConsumer_ImplBase

org.apache.uima.fit.component.CasDumpWriter

All Implemented Interfaces:

AnalysisComponent

public class CasDumpWriter
extends CasConsumer_ImplBase

Dumps CAS content to a text file. This is useful when setting up test cases which contain a reference output to which an actually produced CAS is compared. The format produced by this component is more easily comparable than a XCAS or XMI format.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCLUDE_PREFIX	Pattern exclusion prefix.
static final String	INCLUDE_PREFIX	Pattern inclusion prefix.
static final String	PARAM_FEATURE_PATTERNS	Include/exclude features according to the following patterns.
static final String	PARAM_OUTPUT_FILE	Output file.
static final String	PARAM_SORT	Sort increasing by begin, decreasing by end, increasing by name instead of relying on index order.
static final String	PARAM_TYPE_PATTERNS	Include/exclude specified UIMA types in the output.
static final String	PARAM_WRITE_DOCUMENT_META_DATA	Whether to dump the content of the CAS.getDocumentAnnotation().

Constructor Summary

Constructors

Constructor	Description
CasDumpWriter()

Method Summary

Modifier and Type	Method	Description
void	collectionProcessComplete()	Notifies this AnalysisComponent that processing of an entire collection has been completed.
void	initialize(UimaContext context)	Performs any startup tasks required by this component.
void	process(CAS aCAS)	Inputs a CAS to the AnalysisComponent.

Methods inherited from class org.apache.uima.analysis_component.CasAnnotator_ImplBase

getRequiredCasInterface, process, typeSystemInit

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, destroy, getContext, getLogger, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INCLUDE_PREFIX

public static final String INCLUDE_PREFIX

Pattern inclusion prefix.

See Also:

• Constant Field Values

EXCLUDE_PREFIX

public static final String EXCLUDE_PREFIX

Pattern exclusion prefix.

See Also:

• Constant Field Values

PARAM_OUTPUT_FILE

public static final String PARAM_OUTPUT_FILE

Output file. If multiple CASes as processed, their contents are concatenated into this file. Mind that a test case using this consumer with multiple CASes requires a reader which produced the CASes always in the same order. When this file is set to "-", the dump does to System.out (default).

See Also:

• Constant Field Values

PARAM_WRITE_DOCUMENT_META_DATA

public static final String PARAM_WRITE_DOCUMENT_META_DATA

Whether to dump the content of the CAS.getDocumentAnnotation().

See Also:

• Constant Field Values

PARAM_FEATURE_PATTERNS

public static final String PARAM_FEATURE_PATTERNS

Include/exclude features according to the following patterns. Mind that the patterns do not actually match feature names but lines produced by FeatureStructure.toString().

See Also:

• Constant Field Values

PARAM_TYPE_PATTERNS

public static final String PARAM_TYPE_PATTERNS

Include/exclude specified UIMA types in the output.

See Also:

• Constant Field Values

PARAM_SORT

public static final String PARAM_SORT

Sort increasing by begin, decreasing by end, increasing by name instead of relying on index order.

See Also:

• Constant Field Values

Constructor Details

CasDumpWriter

public CasDumpWriter()

Method Details

initialize

public void initialize(UimaContext context)
                throws ResourceInitializationException

Description copied from interface: AnalysisComponent

Performs any startup tasks required by this component. The framework calls this method only once, just after the AnalysisComponent has been instantiated.

The framework supplies this AnalysisComponent with a reference to the UimaContext that it will use, for example to access configuration settings or resources. This AnalysisComponent should store a reference to its the UimaContext for later use.

Specified by:

initialize in interface AnalysisComponent

Overrides:

initialize in class CasConsumer_ImplBase

Parameters:

context - Provides access to services and resources managed by the framework. This includes configuration parameters, logging, and access to external resources.

Throws:

ResourceInitializationException - if this AnalysisComponent cannot initialize successfully.

process

public void process(CAS aCAS)
             throws AnalysisEngineProcessException

Description copied from class: CasAnnotator_ImplBase

Inputs a CAS to the AnalysisComponent. This method should be overriden by subclasses to perform analysis of the CAS.

Specified by:

process in class CasAnnotator_ImplBase

Parameters:

aCAS - A CAS that this AnalysisComponent should process.

Throws:

AnalysisEngineProcessException - if a problem occurs during processing

collectionProcessComplete

public void collectionProcessComplete()

Description copied from interface: AnalysisComponent

Notifies this AnalysisComponent that processing of an entire collection has been completed. In this method, this component should finish writing any output relating to the current collection.

Specified by:

collectionProcessComplete in interface AnalysisComponent

Overrides:

collectionProcessComplete in class AnalysisComponent_ImplBase