|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.analysis_component.AnalysisComponent_ImplBase
org.apache.uima.analysis_component.JCasMultiplier_ImplBase
org.apache.uima.examples.casMultiplier.SimpleTextSegmenter
public class SimpleTextSegmenter
An example CasMultiplier, which breaks large text documents into smaller segments. The minimum size of the segments as determined by the "SegmentSize" configuration parameter, but the break between segments will always occur at the next newline character, so segments will not be exactly that size.
Constructor Summary | |
---|---|
SimpleTextSegmenter()
|
Method Summary | |
---|---|
boolean |
hasNext()
Asks if this AnalysisComponent has another CAS to output. |
void |
initialize(UimaContext aContext)
Performs any startup tasks required by this component. |
AbstractCas |
next()
Gets the next output CAS. |
void |
process(JCas aJCas)
This method should be overriden by subclasses. |
Methods inherited from class org.apache.uima.analysis_component.JCasMultiplier_ImplBase |
---|
getCasInstancesRequired, getEmptyJCas, getRequiredCasInterface, process |
Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase |
---|
batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SimpleTextSegmenter()
Method Detail |
---|
public void initialize(UimaContext aContext) throws ResourceInitializationException
AnalysisComponent
The framework supplies this AnalysisComponent with a reference to the UimaContext
that
it will use, for example to access configuration settings or resources. This AnalysisComponent
should store a reference to its the UimaContext
for later use.
initialize
in interface AnalysisComponent
initialize
in class AnalysisComponent_ImplBase
aContext
- Provides access to services and resources managed by the framework. This includes
configuration parameters, logging, and access to external resources.
ResourceInitializationException
- if this AnalysisComponent cannot initialize successfully.public void process(JCas aJCas) throws AnalysisEngineProcessException
JCasMultiplier_ImplBase
AnalysisComponent.hasNext()
is called and returns
false, or until the process
method is called again (see
AnalysisComponent
for details).
process
in class JCasMultiplier_ImplBase
aJCas
- a JCAS that this AnalysisComponent should process.
AnalysisEngineProcessException
- if a problem occurs during processingpublic boolean hasNext() throws AnalysisEngineProcessException
AnalysisComponent
AnalysisComponent.next()
should retrieve the next output CAS. When this method returns false,
the AnalysisComponent gives up control of the initial CAS that was passed to its
AnalysisComponent.process(AbstractCas)
method.
AnalysisEngineProcessException
- if a problem occurs during processingpublic AbstractCas next() throws AnalysisEngineProcessException
AnalysisComponent
AnalysisComponent.hasNext()
and checking that it returns true.
The AnalysisComponent can obtain a new CAS by calling UimaContext.getEmptyCas(Class)
(or instead, one of the helper methods in the ImplBase class that it extended).
AnalysisEngineProcessException
- if a problem occurs during processing
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |