public class XCASSerializer extends Object
| Modifier and Type | Field and Description |
|---|---|
static String |
ARRAY_ELEMENT_TAG |
static String |
ARRAY_SIZE_ATTR |
static String |
casTagName |
static String |
CONTENT_ATTR_NAME |
static String |
CURRENT_VERSION |
static String |
DEFAULT_DOC_TEXT_FEAT |
static String |
DEFAULT_DOC_TYPE_NAME |
static String |
ID_ATTR_NAME |
static String |
INDEXED_ATTR_NAME |
static String |
REF_PREFIX |
static String |
TRUE_VALUE |
static String |
VERSION_ATTR |
| Constructor and Description |
|---|
XCASSerializer(TypeSystem ts) |
XCASSerializer(TypeSystem ts,
UimaContext uimaContext) |
| Modifier and Type | Method and Description |
|---|---|
String |
getDocumentTextFeature()
Gets the name of the feature holding the documeng text.
|
String |
getDocumentTypeName()
Gets the name of the type representing the document.
|
int |
getNumChildren() |
void |
serialize(CAS cas,
ContentHandler contentHandler)
Write the CAS data to a SAX content handler.
|
void |
serialize(CAS cas,
ContentHandler contentHandler,
boolean encodeDoc)
Write the CAS data to a SAX content handler.
|
void |
serialize(CAS cas,
ContentHandler contentHandler,
boolean encodeDoc,
OutOfTypeSystemData outOfTypeSystemData)
Write the CAS data to a SAX content handler.
|
static void |
serialize(CAS aCAS,
OutputStream aStream)
Serializes an XCAS to a stream.
|
static void |
serialize(CAS aCAS,
OutputStream aStream,
boolean isFormattedOutput)
Serializes an XCAS to a stream.
|
static void |
serialize(CAS aCAS,
OutputStream aStream,
boolean isFormattedOutput,
boolean useXml_1_1)
Serializes an XCAS to a stream.
|
void |
setDocumentTextFeature(String aDocTextFeature)
Sets the name of the feature holding the documeng text.
|
void |
setDocumentTypeName(String aDocTypeName)
Gets the name of the type representing the document.
|
public static final String casTagName
public static final String VERSION_ATTR
public static final String CURRENT_VERSION
public static final String DEFAULT_DOC_TYPE_NAME
public static final String DEFAULT_DOC_TEXT_FEAT
public static final String INDEXED_ATTR_NAME
public static final String REF_PREFIX
public static final String ID_ATTR_NAME
public static final String CONTENT_ATTR_NAME
public static final String ARRAY_SIZE_ATTR
public static final String ARRAY_ELEMENT_TAG
public static final String TRUE_VALUE
public XCASSerializer(TypeSystem ts, UimaContext uimaContext)
public XCASSerializer(TypeSystem ts)
public int getNumChildren()
public void serialize(CAS cas, ContentHandler contentHandler) throws IOException, SAXException
cas - The CAS to be serialized.contentHandler - The SAX content handler the data is written to.IOException - passed thruSAXException - passed thrupublic void serialize(CAS cas, ContentHandler contentHandler, boolean encodeDoc) throws IOException, SAXException
cas - The CAS to be serialized.contentHandler - The SAX content handler the data is written to.encodeDoc - If set to false, no uima.tcas.Document structure will be created, and the document
text will not be serialized.IOException - passed thruSAXException - passed thrupublic void serialize(CAS cas, ContentHandler contentHandler, boolean encodeDoc, OutOfTypeSystemData outOfTypeSystemData) throws IOException, SAXException
cas - The CAS to be serialized.contentHandler - The SAX content handler the data is written to.encodeDoc - If set to false, no uima.tcas.Document structure will be created, and the document
text will not be serialized.outOfTypeSystemData - data not part of the CAS type system, which should be inserted into the XCAS outputIOException - passed thruSAXException - passed thrupublic String getDocumentTypeName()
public void setDocumentTypeName(String aDocTypeName)
DEFAULT_DOC_TYPE_NAME.aDocTypeName - the document type namepublic String getDocumentTextFeature()
public void setDocumentTextFeature(String aDocTextFeature)
DEFAULT_DOC_TEXT_FEAT. If set to null, no _content attribute will be emitted.aDocTextFeature - the document text featurepublic static void serialize(CAS aCAS, OutputStream aStream) throws SAXException, IOException
aCAS - CAS to serialize.aStream - output stream to which to write the XCAS XML documentSAXException - if a problem occurs during XCAS serializationIOException - if an I/O failure occurspublic static void serialize(CAS aCAS, OutputStream aStream, boolean isFormattedOutput) throws SAXException, IOException
aCAS - CAS to serialize.aStream - output stream to which to write the XCAS XML documentisFormattedOutput - if true the XCAS will be serialized formattedSAXException - if a problem occurs during XCAS serializationIOException - if an I/O failure occurspublic static void serialize(CAS aCAS, OutputStream aStream, boolean isFormattedOutput, boolean useXml_1_1) throws SAXException, IOException
aCAS - CAS to serialize.aStream - output stream to which to write the XCAS XML documentisFormattedOutput - if true the XCAS will be serialized formatted *useXml_1_1 - if true, the output serializer is set with the OutputKeys.VERSION to "1.1".SAXException - if a problem occurs during XCAS serializationIOException - if an I/O failure occursCopyright © 2006–2022 The Apache Software Foundation. All rights reserved.