Field Detail

• PARAM_ZONE_TYPES

  public static final String PARAM_ZONE_TYPES

  A list of type names used for zoning.

  See Also:

  Constant Field Values

• PARAM_STRICT_ZONING

  public static final String PARAM_STRICT_ZONING

  Strict zoning causes the segmentation to be applied only within the boundaries of a zone annotation. This works only if a single zone type is specified (the zone annotations should NOT overlap) or if no zone type is specified - in which case the whole document is taken as a zone. If strict zoning is turned off, multiple zone types can be specified. A list of all zone boundaries (start and end) is created and segmentation happens between them.

  See Also:

  Constant Field Values

• PARAM_LANGUAGE

  public static final String PARAM_LANGUAGE

  The language.

  See Also:

  Constant Field Values

• PARAM_WRITE_TOKEN

  public static final String PARAM_WRITE_TOKEN

  Create Token annotations.

  See Also:

  Constant Field Values

• PARAM_WRITE_SENTENCE

  public static final String PARAM_WRITE_SENTENCE

  Create Sentence annotations.

  See Also:

  Constant Field Values

Constructor Detail

• SegmenterBase

  public SegmenterBase()

Method Detail

• isStrictZoning

  public boolean isStrictZoning()

• isWriteSentence

  public boolean isWriteSentence()

• isWriteToken

  public boolean isWriteToken()

• getZoneTypes

  public String[] getZoneTypes()

• process

  public void process(org.apache.uima.jcas.JCas jcas)
               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

  Specified by:

  process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

  Throws:

  org.apache.uima.analysis_engine.AnalysisEngineProcessException

• limit

  protected int[] limit(String text,
            int aBegin,
            int aEnd)

  Adjust the values in the two numeric arguments to be within the limits of the specified text. If the limits have to be adjusted, a warning is issued to the log. Illegal zone boundaries hint to a bug in the AE that produced the zone annotations.

  Parameters:

  text - the text.

  aBegin - the zone begin.

  aEnd - the zone end.

• createSentence

  protected Sentence createSentence(org.apache.uima.jcas.JCas aJCas,
                        int aBegin,
                        int aEnd)

• createToken

  protected Token createToken(org.apache.uima.jcas.JCas aJCas,
                  int aBegin,
                  int aEnd)

• createToken

  protected Token createToken(org.apache.uima.jcas.JCas aJCas,
                  int aBegin,
                  int aEnd,
                  int aIndex)

• process

  protected abstract void process(org.apache.uima.jcas.JCas aJCas,
             String text,
             int zoneBegin)
                           throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

  Throws:

  org.apache.uima.analysis_engine.AnalysisEngineProcessException

• trim

  public void trim(String aText,
          int[] aSpan)

  Remove trailing or leading whitespace from the annotation.

  Parameters:

  aText - the text.

  aSpan - the offsets.

• isEmpty

  public boolean isEmpty(int aBegin,
                int aEnd)

• trimChar

  public boolean trimChar(char aChar)

• getLanguage

  public String getLanguage(org.apache.uima.jcas.JCas aJCas)

• getLocale

  public Locale getLocale(org.apache.uima.jcas.JCas aJCas)

  Get the locale from the parameter, then from the document if available. If no locale is set get the default locale from the VM.

  Parameters:

  aJCas - the JCas.

  Returns:

  the locale.