Field Detail

• chunkClass

  protected Class<? extends CHUNK_TYPE extends Annotation> chunkClass

• featureFullName

  protected String featureFullName

• subChunkClass

  protected Class<? extends SUB_CHUNK_TYPE extends Annotation> subChunkClass

Constructor Detail

• Chunking_ImplBase

  public Chunking_ImplBase(Class<? extends SUB_CHUNK_TYPE> subChunkClass,
                   Class<? extends CHUNK_TYPE> chunkClass,
                   String featureName)

Method Detail

• createChunks

  public List<CHUNK_TYPE> createChunks(JCas jCas,
                              List<SUB_CHUNK_TYPE> subChunks,
                              List<String> outcomes)
                                                   throws AnalysisEngineProcessException

  Specified by:

  createChunks in interface Chunking<String,SUB_CHUNK_TYPE extends Annotation,CHUNK_TYPE extends Annotation>

  Throws:

  AnalysisEngineProcessException

• createOutcomes

  public List<String> createOutcomes(JCas jCas,
                            List<SUB_CHUNK_TYPE> subChunks,
                            List<CHUNK_TYPE> chunks)
                              throws AnalysisEngineProcessException

  Specified by:

  createOutcomes in interface Chunking<String,SUB_CHUNK_TYPE extends Annotation,CHUNK_TYPE extends Annotation>

  Throws:

  AnalysisEngineProcessException

• getFeature

  protected Feature getFeature(JCas jCas)

• getOutcomeSuffix

  protected String getOutcomeSuffix(CHUNK_TYPE chunk,
                        Feature feature)

• getSubChunkToOutcomeMap

  protected abstract Map<SUB_CHUNK_TYPE,String> getSubChunkToOutcomeMap(JCas jCas,
                                                   List<SUB_CHUNK_TYPE> subChunks,
                                                   List<CHUNK_TYPE> chunks)

  Produce a map from sub-chunk annotations to their outcome prefixes (e.g. 'I', 'O'). If any sub-chunk annotations are not included in the map, they will be given prefix 'O'.

  Parameters:

  subChunks - The sub-annotations that make up the chunks.

  chunks - The chunk annotations.

  Returns:

  A mapping from chunk sub-chunk annotations to outcome prefixes.

• isEndOfChunk

  protected abstract boolean isEndOfChunk(char currPrefix,
                     String currLabel,
                     char nextPrefix,
                     String nextLabel)

  Determines whether the current outcome represents the end of a chunk. Both the current outcome and the following outcome are provided for making this decision.

  Parameters:

  currPrefix - The prefix of the current outcome

  currLabel - The label of the current outcome

  nextPrefix - The prefix of the following outcome

  nextLabel - The label of the following outcome

  Returns:

  True if the current outcome represents the end of a chunk