gate

Interface TextualDocument

All Superinterfaces:

Comparable<Object>, Document, FeatureBearer, LanguageResource, NameBearer, Resource, Serializable, SimpleDocument

All Known Implementing Classes:

DocumentImpl

public interface TextualDocument
extends Document

Top interface for all types of textual documents (transient or persistent). Extends the Document interface with the encoding property.

Field Summary

Fields inherited from interface gate.Document

DOCUMENT_ENCODING_PARAMETER_NAME, DOCUMENT_END_OFFSET_PARAMETER_NAME, DOCUMENT_MARKUP_AWARE_PARAMETER_NAME, DOCUMENT_MIME_TYPE_PARAMETER_NAME, DOCUMENT_PRESERVE_CONTENT_PARAMETER_NAME, DOCUMENT_REPOSITIONING_PARAMETER_NAME, DOCUMENT_START_OFFSET_PARAMETER_NAME, DOCUMENT_STRING_CONTENT_PARAMETER_NAME, DOCUMENT_TYPE_PARAMETER_NAME

Fields inherited from interface gate.SimpleDocument

DOCUMENT_URL_PARAMETER_NAME

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Gets the encoding used for this document.

Methods inherited from interface gate.Document

addDocumentListener, edit, getCollectRepositioningInfo, getMarkupAware, getNamedAnnotationSets, getPreserveOriginalContent, getSourceUrlEndOffset, getSourceUrlOffsets, getSourceUrlStartOffset, removeDocumentListener, setCollectRepositioningInfo, setMarkupAware, setPreserveOriginalContent, setSourceUrlEndOffset, setSourceUrlStartOffset, toXml, toXml, toXml

Methods inherited from interface gate.SimpleDocument

getAnnotations, getAnnotations, getAnnotationSetNames, getContent, getSourceUrl, removeAnnotationSet, setContent, setSourceUrl

Methods inherited from interface gate.LanguageResource

getDataStore, getLRPersistenceId, getParent, isModified, setDataStore, setLRPersistenceId, setParent, sync

Methods inherited from interface gate.Resource

cleanup, getParameterValue, init, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getEncoding

String getEncoding()

Gets the encoding used for this document. This encoding has been used to read the content for the document and will be used for dumping this document to other textual formats such as XML.

Returns:

a String value.