Uses of Interface
gate.Document

Packages that use Document

Package	Description
gate
gate.annotation
gate.corpora
gate.corpora.export
gate.creole
gate.creole.annic
gate.creole.annic.lucene
gate.creole.ir
gate.email
gate.event
gate.gui
gate.gui.annedit
gate.gui.docview
gate.html
gate.sgml
gate.util
gate.xml

Uses of Document in gate

Subinterfaces of Document in gate

Modifier and Type	Interface and Description
interface	TextualDocument Top interface for all types of textual documents (transient or persistent).

Methods in gate that return Document

Modifier and Type	Method and Description
Document	SimpleAnnotationSet.getDocument() Get the document this set is attached to.
Document	LanguageAnalyser.getDocument() Get the document property for this analyser.
static Document	Factory.newDocument(String content) Create a new transient textual Document from a string.
static Document	Factory.newDocument(URL sourceUrl) Create a new transient Document from a URL.
static Document	Factory.newDocument(URL sourceUrl, String encoding) Create a new transient Document from a URL and an encoding.

Methods in gate with parameters of type Document

Modifier and Type	Method and Description
static String	Utils.cleanStringFor(Document doc, AnnotationSet anns) Return the cleaned document text as a String covered by the given annotation set.
static String	Utils.cleanStringFor(Document doc, Long start, Long end) Return the cleaned document text between the provided offsets.
static String	Utils.cleanStringFor(Document doc, SimpleAnnotation ann) Return the cleaned document text as a String corresponding to the annotation.
static AnnotationSet	Factory.createImmutableAnnotationSet(Document document, Collection<Annotation> annotations) Utility method to create an immutable annotation set.
void	DocumentExporter.export(Document doc, File file) Equivalent to DocumentExporter.export(Document,File,FeatureMap) with an empty map of options.
void	DocumentExporter.export(Document doc, File file, FeatureMap options) Equivalent to DocumentExporter.export(Document,OutputStream,FeatureMap) using a FileOutputStream instance constructed from the File param.
void	DocumentExporter.export(Document doc, OutputStream out) Equivalent to DocumentExporter.export(Document,OutputStream) with an empty map of options.
abstract void	DocumentExporter.export(Document doc, OutputStream out, FeatureMap options) Exports the provided Document instance to the specified OutputStream using the specified options.
static DocumentFormat	DocumentFormat.getDocumentFormat(Document aGateDocument, MimeType mimeType) Find a DocumentFormat implementation that deals with a particular MIME type, given that type.
static DocumentFormat	DocumentFormat.getDocumentFormat(Document aGateDocument, String fileSuffix) Find a DocumentFormat implementation that deals with a particular MIME type, given the file suffix (e.g.
static DocumentFormat	DocumentFormat.getDocumentFormat(Document aGateDocument, URL url) Find a DocumentFormat implementation that deals with a particular MIME type, given the URL of the Document.
static int	Utils.length(Document doc) Return the length of the document as an int -- if the content is too long for an int, the method will throw a GateRuntimeException.
static long	Utils.lengthLong(Document doc) Return the length of the document as a long.
void	LanguageAnalyser.setDocument(Document document) Set the document property for this analyser.
static String	Utils.stringFor(Document doc, AnnotationSet anns) Return the document text as a String covered by the given annotation set.
static String	Utils.stringFor(Document doc, Long start, Long end) Returns the document text between the provided offsets.
static String	Utils.stringFor(Document doc, SimpleAnnotation ann) Return the document text as a String corresponding to the annotation.
void	Corpus.unloadDocument(Document doc) Unloads the document from memory.
abstract void	DocumentFormat.unpackMarkup(Document doc) Unpack the markup in the document.
abstract void	DocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
void	DocumentFormat.unpackMarkup(Document doc, String originalContentFeatureType) Unpack the markup in the document.

Uses of Document in gate.annotation

Methods in gate.annotation that return Document

Modifier and Type	Method and Description
Document	AnnotationSetImpl.getDocument() Get the document this set is attached to.
Document	CorpusAnnotationDiff.DiffSetElement.getKeyDocument() Get Key document
Document	CorpusAnnotationDiff.DiffSetElement.getResponseDocument() Get Response document

Methods in gate.annotation with parameters of type Document

Modifier and Type	Method and Description
void	CorpusAnnotationDiff.DiffSetElement.setKeyDocument(Document aDoc) Set Key document
void	CorpusAnnotationDiff.DiffSetElement.setResponseDocument(Document aDoc) Set Response document

Constructors in gate.annotation with parameters of type Document

Constructor and Description
AnnotationSetImpl(Document doc) Construction from Document.
AnnotationSetImpl(Document doc, String name) Construction from Document and name.
DiffSetElement(Annotation aLeftAnnotation, Annotation aRightAnnotation, int aLeftType, int aRightType, Document kDocument, Document rDocument) Constructor for DiffSetlement with document name
ImmutableAnnotationSetImpl(Document doc, Collection<Annotation> annotations) Constructs an ImmutableAnnotationSet.

Uses of Document in gate.corpora

Classes in gate.corpora that implement Document

Modifier and Type	Class and Description
class	DocumentImpl Represents the commonalities between all sorts of documents.

Fields in gate.corpora with type parameters of type Document

Modifier and Type	Field and Description
protected List<Document>	SerialCorpusImpl.addedDocs
protected List<Document>	SerialCorpusImpl.changedDocs
protected List<Document>	SerialCorpusImpl.documents
protected List<Document>	CorpusImpl.documentsList
protected List<Document>	CorpusImpl.supportList The underlying list that holds the documents in this corpus.

Methods in gate.corpora that return Document

Modifier and Type	Method and Description
Document	CorpusImpl.get(int index)
Document	CorpusImpl.VerboseList.get(int index)
Document	SerialCorpusImpl.get(int index)
Document	CorpusImpl.remove(int index)
Document	CorpusImpl.VerboseList.remove(int index)
Document	SerialCorpusImpl.remove(int index)
Document	CorpusImpl.set(int index, Document element)
Document	CorpusImpl.VerboseList.set(int index, Document element)
Document	SerialCorpusImpl.set(int index, Document element)

Methods in gate.corpora that return types with arguments of type Document

Modifier and Type	Method and Description
List<Document>	CorpusImpl.getDocumentsList()
Iterator<Document>	CorpusImpl.iterator()
Iterator<Document>	SerialCorpusImpl.iterator()
ListIterator<Document>	CorpusImpl.listIterator()
ListIterator<Document>	SerialCorpusImpl.listIterator()
ListIterator<Document>	CorpusImpl.listIterator(int index)
ListIterator<Document>	SerialCorpusImpl.listIterator(int index)
List<Document>	CorpusImpl.subList(int fromIndex, int toIndex)
List<Document>	SerialCorpusImpl.subList(int fromIndex, int toIndex) persistent Corpus does not support this method as all the documents might no be in memory

Methods in gate.corpora with parameters of type Document

Modifier and Type	Method and Description
boolean	CorpusImpl.add(Document o)
boolean	SerialCorpusImpl.add(Document o)
void	CorpusImpl.add(int index, Document element)
void	CorpusImpl.VerboseList.add(int index, Document element)
void	SerialCorpusImpl.add(int index, Document o)
void	TextualDocumentFormat.annotateParagraphs(Document aDoc, int startOffset, int endOffset, String annotSetName) This method annotates paragraphs in a GATE document.
int	SerialCorpusImpl.findDocument(Document doc)
protected static boolean	TextualDocumentFormat.hasContentButNoValidUrl(Document doc) This is a test to see if the GATE document has a valid URL or a valid content.
static void	DocumentStaxUtils.readGateXmlDocument(XMLStreamReader xsr, Document doc) Reads GATE XML format data from the given XMLStreamReader and puts the content and annotation sets into the given Document, replacing its current content.
static void	DocumentStaxUtils.readGateXmlDocument(XMLStreamReader xsr, Document doc, StatusListener statusListener) Reads GATE XML format data from the given XMLStreamReader and puts the content and annotation sets into the given Document, replacing its current content.
Document	CorpusImpl.set(int index, Document element)
Document	CorpusImpl.VerboseList.set(int index, Document element)
Document	SerialCorpusImpl.set(int index, Document element)
protected void	TextualDocumentFormat.setNewLineProperty(Document doc) Check the new line sequence and set document property.
static String	DocumentJsonUtils.toJson(Document doc, Map<String,Collection<Annotation>> annotationsMap) Convert a GATE document to JSON representation and return it as a string.
static String	DocumentStaxUtils.toXml(Document doc) Returns a string containing the specified document in GATE XML format.
void	CorpusImpl.unloadDocument(Document doc) This method does not make sense for transient corpora, so it does nothing.
void	SerialCorpusImpl.unloadDocument(Document doc) Unloads a document from memory, calling sync() first, to store the changes.
void	SerialCorpusImpl.unloadDocument(Document doc, boolean sync) Unloads a document from memory
void	NekoHtmlDocumentFormat.unpackMarkup(Document doc) Old-style unpackMarkup, without repositioning info.
void	XmlDocumentFormat.unpackMarkup(Document doc) Old style of unpackMarkup (without collecting of RepositioningInfo)
void	TextualDocumentFormat.unpackMarkup(Document doc) Unpack the markup in the document.
void	TikaFormat.unpackMarkup(Document doc)
void	SgmlDocumentFormat.unpackMarkup(Document doc) Unpack the markup in the document.
void	EmailDocumentFormat.unpackMarkup(Document doc) Unpack the markup in the document.
void	ConllDocumentFormat.unpackMarkup(Document doc)
void	NekoHtmlDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo) Unpack the markup in the document.
void	XmlDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo) Unpack the markup in the document.
void	TextualDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
void	TikaFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
void	UimaDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
static void	DocumentStaxUtils.writeDocument(Document doc, File file) Write the specified GATE document to a File.
static void	DocumentStaxUtils.writeDocument(Document doc, File file, String namespaceURI) Write the specified GATE document to a File, optionally putting the XML in a namespace.
static void	DocumentJsonUtils.writeDocument(Document doc, Long start, Long end, Map<String,Collection<Annotation>> annotationsMap, com.fasterxml.jackson.core.JsonGenerator json) Write a substring of a GATE document to the specified JsonGenerator.
static void	DocumentJsonUtils.writeDocument(Document doc, Long start, Long end, Map<String,Collection<Annotation>> annotationsMap, Map<?,?> extraFeatures, com.fasterxml.jackson.core.JsonGenerator json) Write a substring of a GATE document to the specified JsonGenerator.
static void	DocumentJsonUtils.writeDocument(Document doc, Long start, Long end, Map<String,Collection<Annotation>> annotationsMap, Map<?,?> extraFeatures, String annotationTypeProperty, com.fasterxml.jackson.core.JsonGenerator json) Write a substring of a GATE document to the specified JsonGenerator.
static void	DocumentJsonUtils.writeDocument(Document doc, Long start, Long end, Map<String,Collection<Annotation>> annotationsMap, Map<?,?> extraFeatures, String annotationTypeProperty, String annotationIDProperty, com.fasterxml.jackson.core.JsonGenerator json) Write a substring of a GATE document to the specified JsonGenerator.
static void	DocumentJsonUtils.writeDocument(Document doc, Map<String,Collection<Annotation>> annotationsMap, File out) Write a GATE document to the specified File.
static void	DocumentJsonUtils.writeDocument(Document doc, Map<String,Collection<Annotation>> annotationsMap, com.fasterxml.jackson.core.JsonGenerator json) Write a GATE document to the specified JsonGenerator.
static void	DocumentJsonUtils.writeDocument(Document doc, Map<String,Collection<Annotation>> annotationsMap, OutputStream out) Write a GATE document to the specified OutputStream.
static void	DocumentJsonUtils.writeDocument(Document doc, Map<String,Collection<Annotation>> annotationsMap, Writer out) Write a GATE document to the specified Writer.
static void	DocumentStaxUtils.writeDocument(Document doc, Map<String,Collection<Annotation>> annotationSets, XMLStreamWriter xsw, String namespaceURI) Write the specified GATE Document to an XMLStreamWriter.
static void	DocumentStaxUtils.writeDocument(Document doc, OutputStream outputStream, String namespaceURI)
static void	DocumentStaxUtils.writeDocument(Document doc, XMLStreamWriter xsw, String namespaceURI) Write the specified GATE Document to an XMLStreamWriter.
static void	DocumentStaxUtils.writeTextWithNodes(Document doc, Collection<Collection<Annotation>> annotationSets, XMLStreamWriter xsw, String namespaceURI) Writes the content of the given document to an XMLStreamWriter as a mixed content element called "TextWithNodes".
static void	DocumentStaxUtils.writeTextWithNodes(Document doc, XMLStreamWriter xsw, String namespaceURI) Write a TextWithNodes section containing nodes for all annotations in the given document.
static void	DocumentStaxUtils.writeXcesContent(Document doc, OutputStream out, String encoding) Save the content of a document to the given output stream.

Method parameters in gate.corpora with type arguments of type Document

Modifier and Type	Method and Description
boolean	CorpusImpl.addAll(Collection<? extends Document> c)
boolean	SerialCorpusImpl.addAll(Collection<? extends Document> c)
boolean	CorpusImpl.addAll(int index, Collection<? extends Document> c)
boolean	SerialCorpusImpl.addAll(int index, Collection<? extends Document> c)
void	CorpusImpl.setDocumentsList(List<Document> documentsList)

Uses of Document in gate.corpora.export

Methods in gate.corpora.export with parameters of type Document

Modifier and Type	Method and Description
void	GateXMLExporter.export(Document doc, File file, FeatureMap options)
void	GateXMLExporter.export(Document doc, OutputStream out, FeatureMap options)
void	InlineXMLExporter.export(Document doc, OutputStream out, FeatureMap options)

Uses of Document in gate.creole

Fields in gate.creole declared as Document

Modifier and Type	Field and Description
protected Document	SerialAnalyserController.document The document being processed.
protected Document	ConditionalSerialAnalyserController.document The document being processed.
protected Document	AbstractLanguageAnalyser.document The document property for this analyser.

Methods in gate.creole that return Document

Modifier and Type	Method and Description
Document	SerialAnalyserController.getDocument()
Document	ConditionalSerialAnalyserController.getDocument()
Document	AbstractLanguageAnalyser.getDocument() Get the document property for this analyser.

Methods in gate.creole with parameters of type Document

Modifier and Type	Method and Description
protected void	SerialAnalyserController.setDocToPrs(Document doc) Sets the current document to the memeber PRs
protected void	ConditionalSerialAnalyserController.setDocToPrs(Document doc) Sets the current document to the memeber PRs
void	SerialAnalyserController.setDocument(Document document)
void	ConditionalSerialAnalyserController.setDocument(Document document)
void	AbstractLanguageAnalyser.setDocument(Document document) Set the document property for this analyser.

Constructors in gate.creole with parameters of type Document

Constructor and Description
DocRunner(Document document)

Uses of Document in gate.creole.annic

Method parameters in gate.creole.annic with type arguments of type Document

Modifier and Type	Method and Description
void	Indexer.add(String corpusPersistenceID, List<Document> addedDocuments) Add new documents to Index

Uses of Document in gate.creole.annic.lucene

Methods in gate.creole.annic.lucene that return Document

Modifier and Type	Method and Description
Document	LuceneReader.getDocument() Gets the document object

Methods in gate.creole.annic.lucene with parameters of type Document

Modifier and Type

Method and Description

List<Document>

LuceneDocument.createDocuments(String corpusPersistenceID, Document gateDoc, String documentID, List<String> annotSetsToInclude, List<String> annotSetsToExclude, List<String> featuresToInclude, List<String> featuresToExclude, String indexLocation, String baseTokenAnnotationType, Boolean createTokensAutomatically, String indexUnitAnnotationType) Given an instance of Gate Document, it converts it into the format that lucene can understand and can store in its indexes.

Method parameters in gate.creole.annic.lucene with type arguments of type Document

Modifier and Type	Method and Description
void	LuceneIndexer.add(String corpusPersistenceID, List<Document> added) Add new documents to Index

Constructors in gate.creole.annic.lucene with parameters of type Document

Constructor and Description
LuceneReader(Document gateDoc, List<Token> tokenStream) Constructor

Uses of Document in gate.creole.ir

Methods in gate.creole.ir with parameters of type Document

Modifier and Type	Method and Description
String	FeatureReader.getPropertyValue(Document doc)
String	PropertyReader.getPropertyValue(Document doc)
String	DocumentContentReader.getPropertyValue(Document doc)

Method parameters in gate.creole.ir with type arguments of type Document

Modifier and Type	Method and Description
void	IndexManager.sync(List<Document> added, List<String> removed, List<Document> changed) Reindexing changed documents, removing removed documents and add to the index new corpus documents.
void	IndexManager.sync(List<Document> added, List<String> removed, List<Document> changed) Reindexing changed documents, removing removed documents and add to the index new corpus documents.

Uses of Document in gate.email

Constructors in gate.email with parameters of type Document

Constructor and Description
EmailDocumentHandler(Document aGateDocument, Map<String,String> aMarkupElementsMap, Map<String,String> anElement2StringMap) Constructor initialises some private fields

Uses of Document in gate.event

Methods in gate.event that return Document

Modifier and Type	Method and Description
Document	CorpusEvent.getDocument() Gets the dcument this event refers to
Document	AnnotationSetEvent.getSourceDocument() Gets the document that has had an annotation added or removed.
Document	RelationSetEvent.getSourceDocument() Gets the document that has had an annotation added or removed.

Constructors in gate.event with parameters of type Document

Constructor and Description
AnnotationSetEvent(AnnotationSet source, int type, Document sourceDocument, Annotation annotation) Constructor.
CorpusEvent(Corpus source, Document doc, int index, int type) Creates a new CorpusEvent.
CorpusEvent(Corpus source, Document doc, int index, Object documentLRID, int type) Creates a new CorpusEvent.
DocumentEvent(Document source, int type, Long editStart, Long editEnd) Constructor.
DocumentEvent(Document source, int type, String setName) Constructor.

Uses of Document in gate.gui

Fields in gate.gui declared as Document

Modifier and Type	Field and Description
protected Document	AnnotationDiffGUI.keyDoc
protected Document	AnnotationDiffGUI.resDoc

Uses of Document in gate.gui.annedit

Methods in gate.gui.annedit that return Document

Modifier and Type	Method and Description
Document	AnnotationEditorOwner.getDocument() Gets the document currently being edited.

Uses of Document in gate.gui.docview

Fields in gate.gui.docview declared as Document

Modifier and Type	Field and Description
protected Document	DocumentEditor.document
protected Document	AbstractDocumentView.document The document this view displays.

Methods in gate.gui.docview that return Document

Modifier and Type	Method and Description
Document	AbstractDocumentView.getDocument() Gets the document this view displays.

Uses of Document in gate.html

Constructors in gate.html with parameters of type Document

Constructor and Description
HtmlDocumentHandler(Document aDocument, Map<String,String> aMarkupElementsMap) Constructor initialises all the private memeber data.
HtmlDocumentHandler(Document aDocument, Map<String,String> aMarkupElementsMap, AnnotationSet anAnnotationSet) Constructor initialises all the private memeber data
NekoHtmlDocumentHandler(Document aDocument, AnnotationSet anAnnotationSet, Set<String> ignorableTags) Constructor initialises all the private memeber data

Uses of Document in gate.sgml

Constructors in gate.sgml with parameters of type Document

Constructor and Description
Sgml2Xml(Document doc) The other constructor

Uses of Document in gate.util

Methods in gate.util with parameters of type Document

Modifier and Type	Method and Description
protected int	CorpusBenchmarkTool.countWords(Document annotDoc) Count all Token.kind=word annotations in the document
protected void	CorpusBenchmarkTool.evaluateAllThree(Document persDoc, Document cleanDoc, Document markedDoc, File errDir)
protected void	CorpusBenchmarkTool.evaluateDocuments(Document persDoc, Document cleanDoc, Document markedDoc, File errDir)
protected void	CorpusBenchmarkTool.evaluateTwoDocs(Document keyDoc, Document respDoc, File errDir)
protected AnnotationDiffer	CorpusBenchmarkTool.measureDocs(Document keyDoc, Document respDoc, String annotType)
protected void	CorpusBenchmarkTool.printAnnotations(AnnotationDiffer annotDiff, Document keyDoc, Document respDoc)
protected void	CorpusBenchmarkTool.printAnnotations(Set<Annotation> set, Document doc)
void	LanguageAnalyserDocumentProcessor.processDocument(Document doc)
void	DocumentProcessor.processDocument(Document doc) Process the given GATE document.
protected void	CorpusBenchmarkTool.processDocument(Document doc)
protected void	CorpusBenchmarkTool.storeAnnotations(String type, AnnotationDiffer annotDiffer, Document keyDoc, Document respDoc, Writer errFileWriter)
protected void	CorpusBenchmarkTool.storeAnnotations(String type, Set<Annotation> set, Document doc, Writer file)

Uses of Document in gate.xml

Constructors in gate.xml with parameters of type Document

Constructor and Description
XmlDocumentHandler(Document aDocument, Map<String,String> aMarkupElementsMap, Map<String,String> anElement2StringMap) Constructs a XmlDocumentHandler object.
XmlDocumentHandler(Document aDocument, Map<String,String> aMarkupElementsMap, Map<String,String> anElement2StringMap, AnnotationSet anAnnotationSet) Constructs a XmlDocumentHandler object.