Class VinciCasDataConverter
- java.lang.Object
-
- org.apache.uima.cas_data.impl.vinci.VinciCasDataConverter
-
public class VinciCasDataConverter extends java.lang.Object
Utilities for converting a VinciFrame to and from a CasData.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
mCasDataDocTextFeature
The m cas data doc text feature.private java.lang.String
mCasDataDocTextType
The m cas data doc text type.private boolean
mIncludeAnnotationSpannedText
The m include annotation spanned text.private java.lang.String
mUeidFeature
The m ueid feature.private java.lang.String
mUeidType
The m ueid type.private java.lang.String
mXCasDocTextTag
The m X cas doc text tag.
-
Constructor Summary
Constructors Constructor Description VinciCasDataConverter(java.lang.String aUeidType, java.lang.String aUeidFeature, java.lang.String aCasDataDocTextType, java.lang.String aCasDataDocTextFeature, java.lang.String aXCasDocTextTag, boolean aIncludeAnnotationSpannedText)
Creates a new VinciCasDataConverter.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
appendVinciFrameToCasData(AFrame aCasFrame, CasData aCasData)
Converts a VinciFrame to a CasData, appending to an existing CasData.void
casDataToVinciFrame(CasData aCasData, AFrame aParentFrame)
Converts a CasData to a VinciFrame.CasData
vinciFrameToCasData(AFrame aCasFrame)
Converts a VinciFrame to a CasData.void
vinciFrameToCasData(AFrame aCasFrame, CasData aCasData)
Deprecated.Use appendVinciFrameToCasData(Aframe, CasData) or vinciFrameToCasData(AFrame)
-
-
-
Field Detail
-
mUeidType
private java.lang.String mUeidType
The m ueid type.
-
mUeidFeature
private java.lang.String mUeidFeature
The m ueid feature.
-
mCasDataDocTextType
private java.lang.String mCasDataDocTextType
The m cas data doc text type.
-
mCasDataDocTextFeature
private java.lang.String mCasDataDocTextFeature
The m cas data doc text feature.
-
mXCasDocTextTag
private java.lang.String mXCasDocTextTag
The m X cas doc text tag.
-
mIncludeAnnotationSpannedText
private boolean mIncludeAnnotationSpannedText
The m include annotation spanned text.
-
-
Constructor Detail
-
VinciCasDataConverter
public VinciCasDataConverter(java.lang.String aUeidType, java.lang.String aUeidFeature, java.lang.String aCasDataDocTextType, java.lang.String aCasDataDocTextFeature, java.lang.String aXCasDocTextTag, boolean aIncludeAnnotationSpannedText)
Creates a new VinciCasDataConverter.- Parameters:
aUeidType
- CasData type that contains the UEID (may be null)aUeidFeature
- CasData feature that contains the UEID (may be null)aCasDataDocTextType
- CasData type that contains the document textaCasDataDocTextFeature
- CasData feature that contains the document textaXCasDocTextTag
- XCas tag representing the document textaIncludeAnnotationSpannedText
- if true, when generating XCas for an annotation, the spanned text of the annotation will be included as the content of the XCas element.
-
-
Method Detail
-
casDataToVinciFrame
public void casDataToVinciFrame(CasData aCasData, AFrame aParentFrame) throws java.io.IOException, org.xml.sax.SAXException
Converts a CasData to a VinciFrame.- Parameters:
aCasData
- CasData to convertaParentFrame
- VinciFrame to be the parent of the frame created from the CasData- Throws:
java.io.IOException
- Signals that an I/O exception has occurred.org.xml.sax.SAXException
- the SAX exception
-
vinciFrameToCasData
@Deprecated public void vinciFrameToCasData(AFrame aCasFrame, CasData aCasData) throws org.xml.sax.SAXException
Deprecated.Use appendVinciFrameToCasData(Aframe, CasData) or vinciFrameToCasData(AFrame)Converts a VinciFrame to a CasData, appending to an existing CasData.- Parameters:
aCasFrame
- VinciFrame containing XCASaCasData
- CasData to which FeatureStructures from XCAS will be appended- Throws:
org.xml.sax.SAXException
- the SAX exception
-
vinciFrameToCasData
public CasData vinciFrameToCasData(AFrame aCasFrame) throws org.xml.sax.SAXException
Converts a VinciFrame to a CasData.- Parameters:
aCasFrame
- VinciFrame containing XCAS- Returns:
- a new CasData corrsponding to the XCAS in aCasFrame
- Throws:
org.xml.sax.SAXException
- the SAX exception
-
appendVinciFrameToCasData
public void appendVinciFrameToCasData(AFrame aCasFrame, CasData aCasData) throws org.xml.sax.SAXException
Converts a VinciFrame to a CasData, appending to an existing CasData.- Parameters:
aCasFrame
- VinciFrame containing XCASaCasData
- CasData to which FeatureStructures from XCAS will be appended- Throws:
org.xml.sax.SAXException
- the SAX exception
-
-