de.tudarmstadt.ukp.dkpro.core.testing.dumper

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

de.tudarmstadt.ukp.dkpro.core.testing.dumper.CasDumpWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class CasDumpWriter
extends org.apache.uima.fit.component.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 and Description
static String	EXCLUDE_PREFIX Pattern exclusion prefix.
static String	INCLUDE_PREFIX Pattern inclusion prefix.
static String	PARAM_FEATURE_PATTERNS Include/exclude features according to the following patterns.
static String	PARAM_SORT Sort increasing by begin, decreasing by end, increasing by name instead of relying on index order.
static String	PARAM_TARGET_ENCODING Output encoding.
static String	PARAM_TARGET_LOCATION Output file.
static String	PARAM_TYPE_PATTERNS Include/exclude specified UIMA types in the output.
static String	PARAM_WRITE_DOCUMENT_META_DATA Whether to dump the content of the CAS.getDocumentAnnotation().
static String	PATTERN_ANY
static String	PATTERN_COLLECTION_ID
static String	PATTERN_DOCUMENT_BASE_URI
static String	PATTERN_DOCUMENT_URI
static String	PATTERN_NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
CasDumpWriter()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.cas.CAS aCAS)

Methods inherited from class org.apache.uima.fit.component.CasConsumer_ImplBase

getLogger

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, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

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

PATTERN_ANY

public static final String PATTERN_ANY

See Also:

Constant Field Values

PATTERN_NULL_VALUE

public static final String PATTERN_NULL_VALUE

See Also:

Constant Field Values

PATTERN_COLLECTION_ID

public static final String PATTERN_COLLECTION_ID

See Also:

Constant Field Values

PATTERN_DOCUMENT_URI

public static final String PATTERN_DOCUMENT_URI

See Also:

Constant Field Values

PATTERN_DOCUMENT_BASE_URI

public static final String PATTERN_DOCUMENT_BASE_URI

See Also:

Constant Field Values

PARAM_TARGET_LOCATION

public static final String PARAM_TARGET_LOCATION

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_TARGET_ENCODING

public static final String PARAM_TARGET_ENCODING

Output encoding. If unset, this defaults to UTF-8 if the target is a file and to the system default encoding if the target is the console.

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 Detail

CasDumpWriter

public CasDumpWriter()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.cas.CAS aCAS)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.CasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

collectionProcessComplete

public void collectionProcessComplete()

Specified by:

collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase