gate
Interface Document

All Superinterfaces:
Comparable, FeatureBearer, LanguageResource, Resource, Serializable
All Known Implementing Classes:
DocumentImpl

public interface Document
extends LanguageResource, Comparable

Represents the commonalities between all sorts of documents.


Method Summary
 void addDocumentListener(DocumentListener l)
           
 void addGateListener(GateListener l)
           
 void edit(Long start, Long end, DocumentContent replacement)
          Make changes to the content.
 AnnotationSet getAnnotations()
          Get the default set of annotations.
 AnnotationSet getAnnotations(String name)
          Get a named set of annotations.
 DocumentContent getContent()
          The content of the document: wraps e.g.
 Boolean getMarkupAware()
          Get the markup awareness status of the Document.
 Map getNamedAnnotationSets()
          Returns a map with the named annotation sets
 URL getSourceUrl()
          Documents are identified by URLs
 Long getSourceUrlEndOffset()
          Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document.
 Long[] getSourceUrlOffsets()
          Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document.
 Long getSourceUrlStartOffset()
          Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document.
 void removeAnnotationSet(String name)
          Removes one of the named annotation sets.
 void removeDocumentListener(DocumentListener l)
           
 void removeGateListener(GateListener l)
           
 void setContent(DocumentContent newContent)
          Set method for the document content
 void setMarkupAware(Boolean b)
          Make the document markup-aware.
 void setSourceUrl(URL sourceUrl)
          Set method for the document's URL
 String toXml()
          Returns a GateXml document
 
Methods inherited from interface gate.LanguageResource
getDataStore, setDataStore, sync
 
Methods inherited from interface gate.Resource
init
 
Methods inherited from interface gate.util.FeatureBearer
getFeatures, getName, setFeatures, setName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getSourceUrl

public URL getSourceUrl()
Documents are identified by URLs

setSourceUrl

public void setSourceUrl(URL sourceUrl)
Set method for the document's URL

getSourceUrlOffsets

public Long[] getSourceUrlOffsets()
Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document.

getSourceUrlStartOffset

public Long getSourceUrlStartOffset()
Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document. This method gets the start offset.

getSourceUrlEndOffset

public Long getSourceUrlEndOffset()
Documents may be packed within files; in this case an optional pair of offsets refer to the location of the document. This method gets the end offset.

getContent

public DocumentContent getContent()
The content of the document: wraps e.g. String for text; MPEG for video; etc.

setContent

public void setContent(DocumentContent newContent)
Set method for the document content

getAnnotations

public AnnotationSet getAnnotations()
Get the default set of annotations. The set is created if it doesn't exist yet.

getAnnotations

public AnnotationSet getAnnotations(String name)
Get a named set of annotations. Creates a new set if one with this name doesn't exist yet.

getNamedAnnotationSets

public Map getNamedAnnotationSets()
Returns a map with the named annotation sets

removeAnnotationSet

public void removeAnnotationSet(String name)
Removes one of the named annotation sets. Note that the default annotation set cannot be removed.
Parameters:
name - the name of the annotation set to be removed

setMarkupAware

public void setMarkupAware(Boolean b)
Make the document markup-aware. This will trigger the creation of a DocumentFormat object at Document initialisation time; the DocumentFormat object will unpack the markup in the Document and add it as annotations. Documents are not markup-aware by default.
Parameters:
b - markup awareness status.

getMarkupAware

public Boolean getMarkupAware()
Get the markup awareness status of the Document.
Returns:
whether the Document is markup aware.

toXml

public String toXml()
Returns a GateXml document
Returns:
a string representing a Gate Xml document

edit

public void edit(Long start,
                 Long end,
                 DocumentContent replacement)
          throws InvalidOffsetException
Make changes to the content.

addDocumentListener

public void addDocumentListener(DocumentListener l)

removeDocumentListener

public void removeDocumentListener(DocumentListener l)

addGateListener

public void addGateListener(GateListener l)

removeGateListener

public void removeGateListener(GateListener l)