org.apache.ctakes.chunker.ae
Interface ChunkCreator

All Known Implementing Classes:

DefaultChunkCreator, PhraseTypeChunkCreator

public interface ChunkCreator

Implementations of this interface are responsible for creating chunk annotations. A chunk could really be anything and not necessarily a phrase type as found in shallow parsing.

Author:

Philip

See Also:

Chunker.CHUNKER_CREATOR_CLASS_PARAM

Method Summary

org.apache.uima.jcas.tcas.Annotation	createChunk(org.apache.uima.jcas.JCas jCas, int begin, int end, java.lang.String chunkType)
void	initialize(org.apache.uima.UimaContext annotatorContext)

Method Detail

initialize

void initialize(org.apache.uima.UimaContext annotatorContext)
                throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

createChunk

org.apache.uima.jcas.tcas.Annotation createChunk(org.apache.uima.jcas.JCas jCas,
                                                 int begin,
                                                 int end,
                                                 java.lang.String chunkType)
                                                 throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Parameters:

jCas - the view to which to add the created chunk.

begin - the beginning offset of the chunk

end - the ending offset of the chunk

chunkType - a string description of the chunk type - e.g. "NP"

Returns:

the annotation created by this method. If no annotation is created, then return null.

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException