de.tudarmstadt.ukp.dkpro.core.io.imscwb

Class ImsCwbWriter

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

de.tudarmstadt.ukp.dkpro.core.io.imscwb.ImsCwbWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class ImsCwbWriter
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

This Consumer outputs the content of all CASes into the IMS workbench format. This writer produces a text file which needs to be converted to the binary IMS CWB index files using the command line tools that come with the CWB. It is possible to set the parameter PARAM_CQP_HOME to directly create output in the native binary CQP format via the original CWB command line tools.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_BEGIN
static String	ATTR_CPOS
static String	ATTR_END
static String	ATTR_ID
static String	ATTR_LEMMA
static String	ATTR_POS
static String	ATTR_URI
static String	E_DOCUMENT
static String	E_SENTENCE
static String	E_TEXT
static String	PARAM_ADDITIONAL_FEATURES Write additional token-level annotation features.
static String	PARAM_CORPUS_NAME The name of the generated corpus.
static String	PARAM_CQP_COMPRESS Set this parameter to compress the token streams and the indexes using cwb-huffcode and cwb-compress-rdx.
static String	PARAM_CQP_HOME Set this parameter to the directory containing the cwb-encode and cwb-makeall commands if you want the write to directly encode into the CQP binary format.
static String	PARAM_CQPWEB_COMPATIBILITY Make document IDs compatible with CQPweb.
static String	PARAM_SENTENCE_TAG
static String	PARAM_TARGET_ENCODING Character encoding of the output data.
static String	PARAM_TARGET_LOCATION Location to which the output is written.
static String	PARAM_WRITE_CPOS Write coarse-grained part-of-speech tags.
static String	PARAM_WRITE_DOC_ID Write the document ID for each token.
static String	PARAM_WRITE_DOCUMENT_TAG Write a pseudo-XML tag with the name document to mark the start and end of a document.
static String	PARAM_WRITE_LEMMA Write lemmata.
static String	PARAM_WRITE_OFFSETS Write the start and end position of each token.
static String	PARAM_WRITE_POS Write part-of-speech tags.
static String	PARAM_WRITE_TEXT_TAG Write a pseudo-XML tag with the name text to mark the start and end of a document.

Constructor Summary

Constructors

Constructor and Description
ImsCwbWriter()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
String	getCoveredAnnotationFeatureValue(String aFeaturePath, org.apache.uima.cas.text.AnnotationFS aCoveringAnnotation) Get the feature value of an annotation which is covered by another annotation.
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas jcas)

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

getLogger

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

getRequiredCasInterface, process

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

E_SENTENCE

public static final String E_SENTENCE

See Also:

Constant Field Values

E_TEXT

public static final String E_TEXT

See Also:

Constant Field Values

E_DOCUMENT

public static final String E_DOCUMENT

See Also:

Constant Field Values

ATTR_BEGIN

public static final String ATTR_BEGIN

See Also:

Constant Field Values

ATTR_END

public static final String ATTR_END

See Also:

Constant Field Values

ATTR_POS

public static final String ATTR_POS

See Also:

Constant Field Values

ATTR_CPOS

public static final String ATTR_CPOS

See Also:

Constant Field Values

ATTR_LEMMA

public static final String ATTR_LEMMA

See Also:

Constant Field Values

ATTR_ID

public static final String ATTR_ID

See Also:

Constant Field Values

ATTR_URI

public static final String ATTR_URI

See Also:

Constant Field Values

PARAM_TARGET_LOCATION

public static final String PARAM_TARGET_LOCATION

Location to which the output is written.

See Also:

Constant Field Values

PARAM_TARGET_ENCODING

public static final String PARAM_TARGET_ENCODING

Character encoding of the output data.

See Also:

Constant Field Values

PARAM_WRITE_DOC_ID

public static final String PARAM_WRITE_DOC_ID

Write the document ID for each token. It is usually a better idea to generate a document tag or a text tag which also contain the document ID that can be queried in CQP.

See Also:

Constant Field Values

PARAM_WRITE_POS

public static final String PARAM_WRITE_POS

Write part-of-speech tags.

See Also:

Constant Field Values

PARAM_WRITE_CPOS

public static final String PARAM_WRITE_CPOS

Write coarse-grained part-of-speech tags. These are the simple names of the UIMA types used to represent the part-of-speech tag.

See Also:

Constant Field Values

PARAM_WRITE_LEMMA

public static final String PARAM_WRITE_LEMMA

Write lemmata.

See Also:

Constant Field Values

PARAM_WRITE_DOCUMENT_TAG

public static final String PARAM_WRITE_DOCUMENT_TAG

Write a pseudo-XML tag with the name document to mark the start and end of a document.

See Also:

Constant Field Values

PARAM_WRITE_TEXT_TAG

public static final String PARAM_WRITE_TEXT_TAG

Write a pseudo-XML tag with the name text to mark the start and end of a document. This is used by CQPweb.

See Also:

Constant Field Values

PARAM_WRITE_OFFSETS

public static final String PARAM_WRITE_OFFSETS

Write the start and end position of each token.

See Also:

Constant Field Values

PARAM_ADDITIONAL_FEATURES

public static final String PARAM_ADDITIONAL_FEATURES

Write additional token-level annotation features. These have to be given as an array of fully qualified feature paths (fully.qualified.classname/featureName). The names for these annotations in CQP are their lowercase shortnames.

See Also:

Constant Field Values

PARAM_CQPWEB_COMPATIBILITY

public static final String PARAM_CQPWEB_COMPATIBILITY

Make document IDs compatible with CQPweb. CQPweb demands an id consisting of only letters, numbers and underscore.

See Also:

Constant Field Values

PARAM_CQP_HOME

public static final String PARAM_CQP_HOME

Set this parameter to the directory containing the cwb-encode and cwb-makeall commands if you want the write to directly encode into the CQP binary format.

See Also:

Constant Field Values

PARAM_CQP_COMPRESS

public static final String PARAM_CQP_COMPRESS

Set this parameter to compress the token streams and the indexes using cwb-huffcode and cwb-compress-rdx. With modern hardware, this may actually slow down queries, so we turn it off by default. If you have large data sets, you best try yourself what works best for you. (default: false)

See Also:

Constant Field Values

PARAM_CORPUS_NAME

public static final String PARAM_CORPUS_NAME

The name of the generated corpus.

See Also:

Constant Field Values

PARAM_SENTENCE_TAG

public static final String PARAM_SENTENCE_TAG

See Also:

Constant Field Values

Constructor Detail

ImsCwbWriter

public ImsCwbWriter()

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.JCasAnnotator_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas jcas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

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

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

collectionProcessComplete

public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

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

Overrides:

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

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

getCoveredAnnotationFeatureValue

public String getCoveredAnnotationFeatureValue(String aFeaturePath,
                                               org.apache.uima.cas.text.AnnotationFS aCoveringAnnotation)

Get the feature value of an annotation which is covered by another annotation.

Parameters:

aFeaturePath - The fully qualified feature path of the feature in question: your.package.and.annotation.class.name/featureName

aCoveringAnnotation - The annotation that covers the annotation for which the feature value should be extracted.

Returns:

the feature value if a feature name is given; coveredText if only the annotation is given