org.apache.uima.cas_data.impl.vinci

Class VinciCasDataConverter

java.lang.Object

org.apache.uima.cas_data.impl.vinci.VinciCasDataConverter

public class VinciCasDataConverter
extends Object

Utilities for converting a VinciFrame to and from a CasData.

Constructor Summary

Constructors

Constructor and Description
VinciCasDataConverter(String aUeidType, String aUeidFeature, String aCasDataDocTextType, String aCasDataDocTextFeature, String aXCasDocTextTag, boolean aIncludeAnnotationSpannedText) Creates a new VinciCasDataConverter.

Method Summary

Modifier and Type	Method and Description
void	appendVinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame, org.apache.uima.cas_data.CasData aCasData) Converts a VinciFrame to a CasData, appending to an existing CasData.
void	casDataToVinciFrame(org.apache.uima.cas_data.CasData aCasData, org.apache.vinci.transport.document.AFrame aParentFrame) Converts a CasData to a VinciFrame.
org.apache.uima.cas_data.CasData	vinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame) Converts a VinciFrame to a CasData.
void	vinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame, org.apache.uima.cas_data.CasData aCasData) Deprecated. Use appendVinciFrameToCasData(Aframe, CasData) or vinciFrameToCasData(AFrame)

Methods inherited from class java.lang.Object

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

Constructor Detail

VinciCasDataConverter

public VinciCasDataConverter(String aUeidType,
                             String aUeidFeature,
                             String aCasDataDocTextType,
                             String aCasDataDocTextFeature,
                             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 text

aCasDataDocTextFeature - CasData feature that contains the document text

aXCasDocTextTag - XCas tag representing the document text

aIncludeAnnotationSpannedText - 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(org.apache.uima.cas_data.CasData aCasData,
                                org.apache.vinci.transport.document.AFrame aParentFrame)
                         throws IOException,
                                SAXException

Converts a CasData to a VinciFrame.

Parameters:

aCasData - CasData to convert

aParentFrame - VinciFrame to be the parent of the frame created from the CasData

Throws:

IOException - Signals that an I/O exception has occurred.

SAXException - the SAX exception

vinciFrameToCasData

@Deprecated
public void vinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame,
                                             org.apache.uima.cas_data.CasData aCasData)
                                      throws SAXException

Deprecated. Use appendVinciFrameToCasData(Aframe, CasData) or vinciFrameToCasData(AFrame)

Converts a VinciFrame to a CasData, appending to an existing CasData.

Parameters:

aCasFrame - VinciFrame containing XCAS

aCasData - CasData to which FeatureStructures from XCAS will be appended

Throws:

SAXException - the SAX exception

vinciFrameToCasData

public org.apache.uima.cas_data.CasData vinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame)
                                                     throws SAXException

Converts a VinciFrame to a CasData.

Parameters:

aCasFrame - VinciFrame containing XCAS

Returns:

a new CasData corrsponding to the XCAS in aCasFrame

Throws:

SAXException - the SAX exception

appendVinciFrameToCasData

public void appendVinciFrameToCasData(org.apache.vinci.transport.document.AFrame aCasFrame,
                                      org.apache.uima.cas_data.CasData aCasData)
                               throws SAXException

Converts a VinciFrame to a CasData, appending to an existing CasData.

Parameters:

aCasFrame - VinciFrame containing XCAS

aCasData - CasData to which FeatureStructures from XCAS will be appended

Throws:

SAXException - the SAX exception