Package org.apache.uima.fit.component

Class CasDumpWriter

java.lang.Object
org.apache.uima.analysis_component.AnalysisComponent_ImplBase
org.apache.uima.analysis_component.Annotator_ImplBase
org.apache.uima.analysis_component.CasAnnotator_ImplBase
org.apache.uima.fit.component.CasConsumer_ImplBase
org.apache.uima.fit.component.CasDumpWriter
All Implemented Interfaces:
org.apache.uima.analysis_component.AnalysisComponent
public class CasDumpWriter extends CasConsumer_ImplBase
Dumps CAS content to a text file. This is useful when setting up test cases which contain a reference output to which an actually produced CAS is compared. The format produced by this component is more easily comparable than a XCAS or XMI format.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXCLUDE_PREFIX
    Pattern exclusion prefix.
    static final String
    INCLUDE_PREFIX
    Pattern inclusion prefix.
    static final String
    PARAM_FEATURE_PATTERNS
    Include/exclude features according to the following patterns.
    static final String
    PARAM_OUTPUT_FILE
    Output file.
    static final String
    PARAM_SORT
    Sort increasing by begin, decreasing by end, increasing by name instead of relying on index order.
    static final String
    PARAM_TYPE_PATTERNS
    Include/exclude specified UIMA types in the output.
    static final String
    PARAM_WRITE_DOCUMENT_META_DATA
    Whether to dump the content of the CAS.getDocumentAnnotation().

  • Constructor Summary

    Constructors
    Constructor
    Description
    CasDumpWriter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    collectionProcessComplete()
     
    void
    initialize(org.apache.uima.UimaContext context)
     
    void
    process(org.apache.uima.cas.CAS aCAS)
     

    Methods inherited from class org.apache.uima.analysis_component.CasAnnotator_ImplBase

    getRequiredCasInterface, process, typeSystemInit

    Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

    getCasInstancesRequired, hasNext, next

    Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

    batchProcessComplete, destroy, getContext, getLogger, getResultSpecification, reconfigure, setResultSpecification

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • INCLUDE_PREFIX

      public static final String INCLUDE_PREFIX
      Pattern inclusion prefix.
      See Also:

    • EXCLUDE_PREFIX

      public static final String EXCLUDE_PREFIX
      Pattern exclusion prefix.
      See Also:

    • PARAM_OUTPUT_FILE

      public static final String PARAM_OUTPUT_FILE
      Output file. If multiple CASes as processed, their contents are concatenated into this file. Mind that a test case using this consumer with multiple CASes requires a reader which produced the CASes always in the same order. When this file is set to "-", the dump does to System.out (default).
      See Also:

    • PARAM_WRITE_DOCUMENT_META_DATA

      public static final String PARAM_WRITE_DOCUMENT_META_DATA
      Whether to dump the content of the CAS.getDocumentAnnotation().
      See Also:

    • PARAM_FEATURE_PATTERNS

      public static final String PARAM_FEATURE_PATTERNS
      Include/exclude features according to the following patterns. Mind that the patterns do not actually match feature names but lines produced by FeatureStructure.toString().
      See Also:

    • PARAM_TYPE_PATTERNS

      public static final String PARAM_TYPE_PATTERNS
      Include/exclude specified UIMA types in the output.
      See Also:

    • PARAM_SORT

      public static final String PARAM_SORT
      Sort increasing by begin, decreasing by end, increasing by name instead of relying on index order.
      See Also:

  • Constructor Details

    • CasDumpWriter

      public CasDumpWriter()

  • Method Details

    • initialize

      public void initialize(org.apache.uima.UimaContext context) throws org.apache.uima.resource.ResourceInitializationException
      Specified by:
      initialize in interface org.apache.uima.analysis_component.AnalysisComponent
      Overrides:
      initialize in class CasConsumer_ImplBase
      Throws:
      org.apache.uima.resource.ResourceInitializationException

    • process

      public void process(org.apache.uima.cas.CAS aCAS) throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
      Specified by:
      process in class org.apache.uima.analysis_component.CasAnnotator_ImplBase
      Throws:
      org.apache.uima.analysis_engine.AnalysisEngineProcessException

    • collectionProcessComplete

      public void collectionProcessComplete()
      Specified by:
      collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent
      Overrides:
      collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase