Package org.apache.uima.cas_data.impl

Class CasDataToXCas

  • public class CasDataToXCas
extends java.lang.Object
    Takes a CasData and generates XCAS SAX events.

    • Constructor Summary

      Constructors 
      Constructor Description
      CasDataToXCas()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void generateXCas​(CasData aCasData)
      Generates XCAS for a CasData.
      void generateXCas​(CasData aCasData, java.lang.String aUEID)
      Special form of generateXCas(CasData) that allows a UEID (Universal Entity ID) element to be added as the first element in the XCAS.
      void generateXCas​(CasData aCasData, java.lang.String aUEID, boolean aSendStartAndEndDocEvents)
      Special form of generateXCas(CasData) that allows a UEID (Universal Entity ID) element to be added as the first element in the XCAS and also allows start/end document SAX calls to be supressed.
      java.lang.String getDocumentTextFeatureName()
      Gets the name of the CASData Feature that stores the document text.
      java.lang.String getDocumentTextTypeName()
      Gets the name of the CASData FeatureStructure Type that stores the document text.
      void setContentHandler​(org.xml.sax.ContentHandler aHandler)
      Sets the ContentHandler to receive the SAX events.
      void setDocumentTextFeatureName​(java.lang.String aDocumentTextFeatureName)
      Sets the name of the CASData Feature that stores the document text.
      void setDocumentTextTypeName​(java.lang.String aDocumentTextTypeName)
      Sets the name of the CASData FeatureStructure Type that stores the document text.
      void setIncludeAnnotationSpannedText​(boolean aIncludeAnnotationSpannedText)  
      void setTypesToFilter​(java.lang.String[] aTypesToFilter)
      Specifies names of types that will not be included in the XCAS
      void setXCasDocumentTextTagName​(java.lang.String aXCasDocTextTag)
      Sets the name of the XCAS tag that will contain the document text.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CasDataToXCas

        public CasDataToXCas()

    • Method Detail

      • getDocumentTextTypeName

        public java.lang.String getDocumentTextTypeName()
        Gets the name of the CASData FeatureStructure Type that stores the document text.
        Returns:
        the document text type name

      • setDocumentTextTypeName

        public void setDocumentTextTypeName​(java.lang.String aDocumentTextTypeName)
        Sets the name of the CASData FeatureStructure Type that stores the document text.
        Parameters:
        aDocumentTextTypeName - the document text type name

      • getDocumentTextFeatureName

        public java.lang.String getDocumentTextFeatureName()
        Gets the name of the CASData Feature that stores the document text.
        Returns:
        the document text feature name

      • setDocumentTextFeatureName

        public void setDocumentTextFeatureName​(java.lang.String aDocumentTextFeatureName)
        Sets the name of the CASData Feature that stores the document text.
        Parameters:
        aDocumentTextFeatureName - the document text feature name

      • setXCasDocumentTextTagName

        public void setXCasDocumentTextTagName​(java.lang.String aXCasDocTextTag)
        Sets the name of the XCAS tag that will contain the document text.
        Parameters:
        aXCasDocTextTag - the document text tag

      • setIncludeAnnotationSpannedText

        public void setIncludeAnnotationSpannedText​(boolean aIncludeAnnotationSpannedText)
        Parameters:
        aIncludeAnnotationSpannedText - -

      • setTypesToFilter

        public void setTypesToFilter​(java.lang.String[] aTypesToFilter)
        Specifies names of types that will not be included in the XCAS
        Parameters:
        aTypesToFilter - -

      • setContentHandler

        public void setContentHandler​(org.xml.sax.ContentHandler aHandler)
        Sets the ContentHandler to receive the SAX events.
        Parameters:
        aHandler - -

      • generateXCas

        public void generateXCas​(CasData aCasData)
                  throws org.xml.sax.SAXException
        Generates XCAS for a CasData. SAX events representing the XCAS will be sent to the ContentHandler registered via setContentHandler(ContentHandler).
        Parameters:
        aCasData - the CasData from which XCAS will be generated
        Throws:
        org.xml.sax.SAXException - if the ContentHandler throws a SAX Exception

      • generateXCas

        public void generateXCas​(CasData aCasData,
                         java.lang.String aUEID)
                  throws org.xml.sax.SAXException
        Special form of generateXCas(CasData) that allows a UEID (Universal Entity ID) element to be added as the first element in the XCAS.
        Parameters:
        aCasData - the CasData from which XCAS will be generated
        aUEID - the UEID to add to the XCAS
        Throws:
        org.xml.sax.SAXException - if the ContentHandler throws a SAX Exception

      • generateXCas

        public void generateXCas​(CasData aCasData,
                         java.lang.String aUEID,
                         boolean aSendStartAndEndDocEvents)
                  throws org.xml.sax.SAXException
        Special form of generateXCas(CasData) that allows a UEID (Universal Entity ID) element to be added as the first element in the XCAS and also allows start/end document SAX calls to be supressed.
        Parameters:
        aCasData - the CasData from which XCAS will be generated
        aUEID - the UEID to add to the XCAS
        aSendStartAndEndDocEvents - true to send SAX events for start and end of document, false to supress them.
        Throws:
        org.xml.sax.SAXException - if the ContentHandler throws a SAX Exception