de.tudarmstadt.ukp.dkpro.core.io.ditop

Class DiTopWriter

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

de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase

de.tudarmstadt.ukp.dkpro.core.io.ditop.DiTopWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class DiTopWriter
extends JCasFileWriter_ImplBase

This annotator (consumer) writes output files as required by DiTop. It requires JCas input annotated by MalletLdaTopicModelInferencer using the same model.

Nested Class Summary

Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase

JCasFileWriter_ImplBase.NamedOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendConfig
protected String[]	collectionValues
protected boolean	collectionValuesExactMatch
protected Set<String>	collectionValuesSet
protected String	corpusName
protected File	modelLocation
static String	PARAM_APPEND_CONFIG If set to true, the new corpus will be appended to an existing config file.
static String	PARAM_COLLECTION_VALUES If set, only documents with one of the listed collection IDs are written, all others are ignored.
static String	PARAM_COLLECTION_VALUES_EXACT_MATCH If true (default), only write documents with collection ids matching one of the collection values exactly.
static String	PARAM_CORPUS_NAME The corpus name is used to name the corresponding sub-directory and will be set in the configuration file.
static String	PARAM_MAX_TOPIC_WORDS The maximum number of topic words to extract.
static String	PARAM_MODEL_LOCATION A Mallet file storing a serialized ParallelTopicModel.
static String	PARAM_TARGET_LOCATION Directory in which to store output files.
protected File	targetLocation
protected BufferedWriter	writerDocTopic

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase

JAR_PREFIX, PARAM_COMPRESSION, PARAM_ESCAPE_DOCUMENT_ID, PARAM_OVERWRITE, PARAM_SINGULAR_TARGET, PARAM_STRIP_EXTENSION, PARAM_USE_DOCUMENT_ID

Constructor Summary

Constructors

Constructor and Description
DiTopWriter()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
protected String	expandCollectionId(String collectionId) This method checks whether any of the specified collection values contains the given String.
protected String	getCollectionId(org.apache.uima.jcas.JCas aJCas) Extract the collection id from the JCas.
protected String	getDocumentId(org.apache.uima.jcas.JCas aJCas) Extract the document id from the JCas.
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas aJCas)
protected void	writeDocTopic(TopicDistribution distribution, String docName, String collectionId)

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase

getCompressionMethod, getOutputStream, getOutputStream, getRelativePath, getTargetLocation, isStripExtension, isUseDocumentId

Methods inherited from class org.apache.uima.fit.component.JCasConsumer_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

PARAM_MAX_TOPIC_WORDS

public static final String PARAM_MAX_TOPIC_WORDS

The maximum number of topic words to extract. Default: 15

See Also:

Constant Field Values

PARAM_MODEL_LOCATION

public static final String PARAM_MODEL_LOCATION

A Mallet file storing a serialized ParallelTopicModel.

See Also:

Constant Field Values

modelLocation

protected File modelLocation

PARAM_CORPUS_NAME

public static final String PARAM_CORPUS_NAME

The corpus name is used to name the corresponding sub-directory and will be set in the configuration file.

See Also:

Constant Field Values

corpusName

protected String corpusName

PARAM_TARGET_LOCATION

public static final String PARAM_TARGET_LOCATION

Directory in which to store output files.

See Also:

Constant Field Values

targetLocation

protected File targetLocation

PARAM_APPEND_CONFIG

public static final String PARAM_APPEND_CONFIG

If set to true, the new corpus will be appended to an existing config file. If false, the existing file is overwritten. Default: true.

See Also:

Constant Field Values

appendConfig

protected boolean appendConfig

PARAM_COLLECTION_VALUES

public static final String PARAM_COLLECTION_VALUES

If set, only documents with one of the listed collection IDs are written, all others are ignored. If this is empty (null), all documents are written.

See Also:

Constant Field Values

collectionValues

protected String[] collectionValues

PARAM_COLLECTION_VALUES_EXACT_MATCH

public static final String PARAM_COLLECTION_VALUES_EXACT_MATCH

If true (default), only write documents with collection ids matching one of the collection values exactly. If false, write documents with collection ids containing any of the collection value string in collection while ignoring cases.

See Also:

Constant Field Values

collectionValuesExactMatch

protected boolean collectionValuesExactMatch

collectionValuesSet

protected Set<String> collectionValuesSet

writerDocTopic

protected BufferedWriter writerDocTopic

Constructor Detail

DiTopWriter

public DiTopWriter()

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

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas aJCas)
             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

writeDocTopic

protected void writeDocTopic(TopicDistribution distribution,
                             String docName,
                             String collectionId)
                      throws IOException

Throws:

IOException

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 JCasFileWriter_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

getCollectionId

protected String getCollectionId(org.apache.uima.jcas.JCas aJCas)

Extract the collection id from the JCas. Uses DocumentMetaData.getCollectionId(), but this method can be overwritten to select a different source for the collection id.

Parameters:

aJCas - the JCas.

Returns:

the collection id String or null if it is not available.

expandCollectionId

protected String expandCollectionId(String collectionId)

This method checks whether any of the specified collection values contains the given String. If it does, returns the matching value; if not, it returns the original value.

Parameters:

collectionId - the collection ID.

Returns:

the first entry from collectionValuesSet that contains the (lowercased) collectionId or the input collectionId.

getDocumentId

protected String getDocumentId(org.apache.uima.jcas.JCas aJCas)
                        throws IllegalStateException

Extract the document id from the JCas. Uses DocumentMetaData.getDocumentId(), but this method can be overwritten to select a different source for the document id.

Parameters:

aJCas - the JCas.

Returns:

the document id string or null if it is not available.

Throws:

IllegalStateException