public abstract class JCasFileWriter_ImplBase
extends org.apache.uima.fit.component.JCasConsumer_ImplBase
Modifier and Type | Class and Description |
---|---|
static class |
JCasFileWriter_ImplBase.NamedOutputStream |
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_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 and Description |
---|
JCasFileWriter_ImplBase() |
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 File |
getTargetPath(org.apache.uima.jcas.JCas aJCas,
String aExtension)
Deprecated.
Use
getOutputStream(JCas, String) instead |
protected File |
getTargetPath(String aRelativePath,
String aExtension)
Deprecated.
Use
getOutputStream(String, String) instead |
protected boolean |
isStripExtension() |
protected boolean |
isUseDocumentId() |
getLogger, initialize
getRequiredCasInterface, process, process
getCasInstancesRequired, hasNext, next
protected static final String JAR_PREFIX
public static final String PARAM_TARGET_LOCATION
public static final String PARAM_COMPRESSION
CompressionMethod.NONE
)CompressionMethod
,
Constant Field Valuespublic static final String PARAM_STRIP_EXTENSION
public static final String PARAM_USE_DOCUMENT_ID
public static final String PARAM_ESCAPE_DOCUMENT_ID
protected CompressionMethod getCompressionMethod()
protected boolean isStripExtension()
protected boolean isUseDocumentId()
public void collectionProcessComplete() throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
collectionProcessComplete
in interface org.apache.uima.analysis_component.AnalysisComponent
collectionProcessComplete
in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
org.apache.uima.analysis_engine.AnalysisEngineProcessException
protected JCasFileWriter_ImplBase.NamedOutputStream getOutputStream(org.apache.uima.jcas.JCas aJCas, String aExtension) throws IOException
IOException
protected JCasFileWriter_ImplBase.NamedOutputStream getOutputStream(String aRelativePath, String aExtension) throws IOException
IOException
@Deprecated protected File getTargetPath(org.apache.uima.jcas.JCas aJCas, String aExtension)
getOutputStream(JCas, String)
insteadPARAM_COMPRESSION
is set, ".gz" is appended to the path.aJCas
- the JCas.aExtension
- the extension.@Deprecated protected File getTargetPath(String aRelativePath, String aExtension)
getOutputStream(String, String)
insteadPARAM_COMPRESSION
is set, ".gz" is appended to the path.aRelativePath
- the relative path.aExtension
- the extension.protected String getRelativePath(org.apache.uima.jcas.JCas aJCas)
PARAM_USE_DOCUMENT_ID
is set, the document ID is used.aJCas
- a CAS.Copyright © 2011–2015. All rights reserved.