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

Class JCasFileWriter_ImplBase

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

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

BinaryCasWriter, BratWriter, Conll2000Writer, Conll2002Writer, Conll2003Writer, Conll2006Writer, Conll2008Writer, Conll2009Writer, Conll2012Writer, ConllUWriter, DiTopWriter, FrequencyCounter, InlineXmlWriter, JsonWriter, LifWriter, LxfWriter, MalletLdaTopicProportionsWriter, MalletLdaTopicsProportionsSortedWriter, MalletModelTrainer, NifWriter, PennTreebankCombinedWriter, SerializedCasWriter, TcfWriter, TeiWriter, TextWriter, TigerXmlWriter, TokenizedTextWriter, XcesBasicXmlWriter, XcesXmlWriter, XmiWriter

public abstract class JCasFileWriter_ImplBase
extends org.apache.uima.fit.component.JCasConsumer_ImplBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JCasFileWriter_ImplBase.NamedOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	JAR_PREFIX
static String	PARAM_COMPRESSION Choose a compression method.
static String	PARAM_ESCAPE_DOCUMENT_ID URL-encode the document ID in the file name to avoid illegal characters (e.g.
static String	PARAM_OVERWRITE Allow overwriting target files (ignored when writing to ZIP archives).
static String	PARAM_SINGULAR_TARGET Treat target location as a single file name.
static String	PARAM_STRIP_EXTENSION Remove the original extension.
static String	PARAM_TARGET_LOCATION Target location.
static String	PARAM_USE_DOCUMENT_ID Use the document ID as file name even if a relative path information is present.

Constructor Summary

Constructors

Constructor and Description
JCasFileWriter_ImplBase()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
protected CompressionMethod	getCompressionMethod()
protected JCasFileWriter_ImplBase.NamedOutputStream	getOutputStream(org.apache.uima.jcas.JCas aJCas, String aExtension)
protected JCasFileWriter_ImplBase.NamedOutputStream	getOutputStream(String aRelativePath, String aExtension)
protected String	getRelativePath(org.apache.uima.jcas.JCas aJCas) Get the relative path from the CAS.
protected String	getTargetLocation()
protected boolean	isStripExtension()
protected boolean	isUseDocumentId()

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

getLogger, initialize

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

getRequiredCasInterface, process, 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

JAR_PREFIX

protected static final String JAR_PREFIX

See Also:

Constant Field Values

PARAM_TARGET_LOCATION

public static final String PARAM_TARGET_LOCATION

Target location. If this parameter is not set, data is written to stdout.

See Also:

Constant Field Values

PARAM_SINGULAR_TARGET

public static final String PARAM_SINGULAR_TARGET

Treat target location as a single file name. This is particularly useful if only a single input file is processed and the result should be written to a pre-defined output file instead of deriving the file name from the document URI or document ID. It can also be useful if the user wishes to force multiple input files to be written to a single target file. The latter case does not work for all formats (e.g. binary, XMI, etc.), but can be useful, e.g. for Conll-based formats. This option has no effect if the target location points to an archive location (ZIP/JAR). The PARAM_COMPRESSION is respected, but does not automatically add an extension. The PARAM_STRIP_EXTENSION has no effect as the original extension is not preserved.

See Also:

Constant Field Values

PARAM_COMPRESSION

public static final String PARAM_COMPRESSION

Choose a compression method. (default: CompressionMethod.NONE)

See Also:

CompressionMethod, Constant Field Values

PARAM_STRIP_EXTENSION

public static final String PARAM_STRIP_EXTENSION

Remove the original extension.

See Also:

Constant Field Values

PARAM_USE_DOCUMENT_ID

public static final String PARAM_USE_DOCUMENT_ID

Use the document ID as file name even if a relative path information is present.

See Also:

Constant Field Values

PARAM_ESCAPE_DOCUMENT_ID

public static final String PARAM_ESCAPE_DOCUMENT_ID

URL-encode the document ID in the file name to avoid illegal characters (e.g. \, :, etc.)

See Also:

Constant Field Values

PARAM_OVERWRITE

public static final String PARAM_OVERWRITE

Allow overwriting target files (ignored when writing to ZIP archives).

See Also:

Constant Field Values

Constructor Detail

JCasFileWriter_ImplBase

public JCasFileWriter_ImplBase()

Method Detail

getCompressionMethod

protected CompressionMethod getCompressionMethod()

isStripExtension

protected boolean isStripExtension()

isUseDocumentId

protected boolean isUseDocumentId()

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

getOutputStream

protected JCasFileWriter_ImplBase.NamedOutputStream getOutputStream(org.apache.uima.jcas.JCas aJCas,
                                                                    String aExtension)
                                                             throws IOException

Throws:

IOException

getTargetLocation

protected String getTargetLocation()

getOutputStream

protected JCasFileWriter_ImplBase.NamedOutputStream getOutputStream(String aRelativePath,
                                                                    String aExtension)
                                                             throws IOException

Throws:

IOException

getRelativePath

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

Get the relative path from the CAS. If the CAS does not contain relative path information or if PARAM_USE_DOCUMENT_ID is set, the document ID is used.

Parameters:

aJCas - a CAS.

Returns:

the relative target path.