## Uses of Interface
gate.Document

Packages that use Document
gate
gate.annotation
gate.corpora
gate.creole
gate.creole.nerc
gate.email
gate.event
gate.fsm
gate.gui
gate.html
gate.jape
gate.persist
gate.sgml
gate.util
gate.xml

Uses of Document in gate

Fields in gate declared as Document
`(package private) Document` `CookBook.doc1` A document
`(package private) Document` `CookBook.doc2` Another document

Methods in gate that return Document
`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.
`static Document` `Factory.newDocument(String content)` Create a new transient textual Document from a string.
`Document` `LanguageAnalyser.getDocument()` Get the document property for this analyser.
`Document` `AnnotationSet.getDocument()` Get the document this set is attached to.

Methods in gate with parameters of type Document
`void` `Corpus.unloadDocument(Document doc)` Unloads the document from memory.
`void` `LanguageAnalyser.setDocument(Document document)` Set the document property for this analyser.
`abstract void` `DocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`void` `DocumentFormat.unpackMarkup(Document doc, String originalContentFeatureType)` Unpack the markup in the document.
`static DocumentFormat` `DocumentFormat.getDocumentFormat(Document aGateDocument, org.w3c.www.mime.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.

Uses of Document in gate.annotation

Fields in gate.annotation declared as Document
`protected Document` `TestDatabaseAnnotationSet.doc1` A document
`private Document` `AnnotationDiff.keyDocument` This document contains the key annotation set which is taken as reference in comparison
`private Document` `AnnotationDiff.responseDocument` This document contains the response annotation set which is being compared against the key annotation set.
`protected Document` `TestAnnotation.doc1` A document

Methods in gate.annotation that return Document
`Document` `AnnotationSetImpl.getDocument()` Get the document this set is attached to.
`Document` `AnnotationDiff.getKeyDocument()`

Methods in gate.annotation with parameters of type Document
`void` `AnnotationDiff.setKeyDocument(Document aKeyDocument)` Sets the keyDocument in AnnotDiff
`void` `AnnotationDiff.setResponseDocument(Document aResponseDocument)`

Constructors in gate.annotation with parameters of type Document
`AnnotationSetImpl(Document doc)` Construction from Document.
`AnnotationSetImpl(Document doc, String name)` Construction from Document and name.
`DatabaseAnnotationSetImpl(Document doc)` Construction from Document.
`DatabaseAnnotationSetImpl(Document doc, String name)` Construction from Document and name.
`DatabaseAnnotationSetImpl(Document doc, Collection c)` Construction from Document and name.
`DatabaseAnnotationSetImpl(Document doc, String name, Collection c)` Construction from Document and name.

Uses of Document in gate.corpora

Classes in gate.corpora that implement Document
`class` `DatabaseDocumentImpl`
`class` `DocumentImpl` Represents the commonalities between all sorts of documents.

Methods in gate.corpora with parameters of type Document
`void` `SerialCorpusImpl.unloadDocument(Document doc)` Unloads a document from memory
`int` `SerialCorpusImpl.findDocument(Document doc)`
`void` `TextualDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`void` `TextualDocumentFormat.annotateParagraphs(Document aDoc, int startOffset, int endOffset, String annotSetName)` This method annotates paragraphs in a GATE document.
`void` `HtmlDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`void` `CorpusImpl.unloadDocument(Document doc)` This method does not make sense for transient corpora, so it does nothing.
`void` `XmlDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`private void` `XmlDocumentFormat.parseDocumentWithoutURL(Document aDocument)` Called from unpackMarkup() if the document have been created from a string
`static void` `TestDocument.verifyNodeIdConsistency(Document doc)` The reason this is method begins with verify and not with test is that it gets called by various other test methods.
`static void` `TestDocument.verifyNodeIdConsistency(AnnotationSet annotSet, Map offests2NodeId, Document doc)` This metod runs the test over an annotation Set.
`void` `SgmlDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`private String` `SgmlDocumentFormat.sgml2Xml(Document doc)` This method converts the document's content from SGML 2 XML.
`void` `RtfDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.
`void` `EmailDocumentFormat.unpackMarkup(Document doc)` Unpack the markup in the document.

Uses of Document in gate.creole

Fields in gate.creole declared as Document
`protected Document` `AbstractLanguageAnalyser.document` The document property for this analyser.
`protected static Document` `TestPR.doc1`
`protected static Document` `TestPR.doc2`
`protected static Document` `TestPR.doc3`

Methods in gate.creole that return Document
`Document` `AbstractLanguageAnalyser.getDocument()` Get the document property for this analyser.

Methods in gate.creole with parameters of type Document
`void` `AbstractLanguageAnalyser.setDocument(Document document)` Set the document property for this analyser.
`void` `TestPR.compareAnnots(Document keyDocument, Document responseDocument)`
`protected void` `SerialAnalyserController.setDocToPrs(Document doc)` Sets the current document to the memeber PRs

Uses of Document in gate.creole.nerc

Constructors in gate.creole.nerc with parameters of type Document
`EntityDescriptor(Document document, Annotation annotation)` Constructs a new entity descriptor starting from a Gate annotation
`EntitySet(String fileName, Document document, AnnotationSet annotationSet)` Constructs an entity set from a Gate annotation set

Uses of Document in gate.email

Fields in gate.email declared as Document
`private Document` `EmailDocumentHandler.gateDocument`

Constructors in gate.email with parameters of type Document
`EmailDocumentHandler(Document aGateDocument, Map aMarkupElementsMap, Map anElement2StringMap)` Constructor initialises some private fields

Uses of Document in gate.event

Fields in gate.event declared as Document
`private Document` `AnnotationSetEvent.sourceDocument`
`private Document` `CorpusEvent.document` The document that has been added/removed.

Methods in gate.event that return Document
`Document` `AnnotationSetEvent.getSourceDocument()` Gets the document that has had an annotation added or removed.
`Document` `CorpusEvent.getDocument()` Gets the dcument this event refers to

Constructors in gate.event with parameters of type Document
`AnnotationSetEvent(AnnotationSet source, int type, Document sourceDocument, Annotation annotation)` Constructor.
`DocumentEvent(Document source, int type, String setName)` Constructor.
`CorpusEvent(Corpus source, Document doc, int index, int type)` Creates a new CorpusEvent.

Uses of Document in gate.fsm

Fields in gate.fsm declared as Document
`private Document` `FSMInstance.document`

Methods in gate.fsm with parameters of type Document
`static FSMInstance` `FSMInstance.getNewInstance(FSM supportGraph, State FSMPosition, Node startNode, Node AGPosition, HashMap bindings, Document doc)` Static method that provides new FSM instances.

Constructors in gate.fsm with parameters of type Document
`FSMInstance(FSM supportGraph, State FSMPosition, Node startNode, Node AGPosition, HashMap bindings, Document document)` Creates a new FSMInstance object.

Uses of Document in gate.gui

Fields in gate.gui declared as Document
`private Document` `DocumentEditor.document` The `Document` currently displayed.
`protected Document` `SyntaxTreeViewer.document`

Methods in gate.gui that return Document
`Document` `AnnotDiffDialog.getSelectedKeyDocument()` It returns the selected KEY gate.Document
`Document` `AnnotDiffDialog.getSelectedResponseDocument()` It returns the selected RESPONSE gate.Document

Methods in gate.gui with parameters of type Document
`boolean` `STreeNode.createAnnotation(Document doc, String type, String text, long utteranceOffset)` Creates an annotation of the given type.
`static boolean` `STreeNode.transferAnnotations(Document doc, AnnotationSet targetAS)` Transfers the annotations from added to the given annotation set Also, for each annotation in removed, removes it from the given annotation set Called by OkAction() in the treeViewer to finalise the changes.
`static void` `STreeNode.undo(Document doc)`
`void` `STreeNode.removeAnnotation(Document doc)` Store the annotation in the deleted list so it can retrieved later

Uses of Document in gate.html

Fields in gate.html declared as Document
`private Document` `HtmlDocumentHandler.doc`

Constructors in gate.html with parameters of type Document
`HtmlDocumentHandler(Document aDocument, <<ambiguous>>Map aMarkupElementsMap)` Constructor initialises all the private memeber data.
`HtmlDocumentHandler(Document aDocument, <<ambiguous>>Map aMarkupElementsMap, AnnotationSet anAnnotationSet)` Constructor initialises all the private memeber data

Uses of Document in gate.jape

Methods in gate.jape with parameters of type Document
`abstract void` `Transducer.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)` Transduce a document.
`int` `Rule.getNextMatch(Document doc, int position, int end)` If another match at or beyond `position` is possible return the position we want to fire in, else -1.
`boolean` `Rule.matches(Document doc, int position, MutableInteger newPosition)` Does this element match the document at this position?
`void` `Rule.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)` Apply the RHS of this rule (LHS must have been matched first).
`boolean` `BasicPatternElement.matches(Document doc, int position, MutableInteger newPosition)` Does this element match the document at this position?
`void` `MultiPhaseTransducer.transduce(Document doc, AnnotationSet input, AnnotationSet output)` Transduce the document by running each phase in turn.
`void` `Batch.transduce(Document doc)` Process a single document.
`void` `Batch.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)` Process a single document.
`boolean` `Matcher.matches(Document doc, int position, MutableInteger newPosition)` Does this element match the document at this position?
`void` `SinglePhaseTransducer.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)` Transduce a document using the annotation set provided and the current rule application style.
`void` `SinglePhaseTransducer.transduce1(Document doc, AnnotationSet annotationSet)` Transduce a document using the annotation set provided and the current rule application style.
`void` `SinglePhaseTransducer.transduce2(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)` Transduce a document using the annotation set provided and the current rule application style.
`void` `RightHandSide.transduce(Document doc, AnnotationSet annotations, Map bindings)` Makes changes to the document, using LHS bindings.
`boolean` `ConstraintGroup.matches(Document doc, int position, MutableInteger newPosition)` Does this element match the document at this position?
`void` `RhsAction.doit(Document doc, AnnotationSet annotations, Map bindings)`
`boolean` `LeftHandSide.matches(Document doc, int position, MutableInteger newPosition)` Does the LHS match the document at this position?
`boolean` `ComplexPatternElement.matches(Document doc, int position, MutableInteger newPosition)` Does this element match the document at this position?

Uses of Document in gate.persist

Methods in gate.persist that return Document
`private Document` `TestPersist.createTestDocument()`
`private Document` `OracleDataStore.createDocument(Document doc, SecurityInfo secInfo)` helper for adopt creates a LR of type Document
`private Document` `OracleDataStore.createDocument(Document doc, Long corpusID, SecurityInfo secInfo)` helper for adopt creates a LR of type Document

Methods in gate.persist with parameters of type Document
`private Document` `OracleDataStore.createDocument(Document doc, SecurityInfo secInfo)` helper for adopt creates a LR of type Document
`private Document` `OracleDataStore.createDocument(Document doc, Long corpusID, SecurityInfo secInfo)` helper for adopt creates a LR of type Document
`private void` `OracleDataStore.syncDocument(Document doc)` helper for sync() - saves a Document in the database
`private void` `OracleDataStore._syncDocument(Document doc)` helper for sync() - never call directly
`private void` `OracleDataStore._syncDocumentContent(Document doc)` helper for sync() - never call directly
`private void` `OracleDataStore._syncAddedAnnotations(Document doc, AnnotationSet as, Collection changes)` helper for sync() - never call directly
`private void` `OracleDataStore._syncChangedAnnotations(Document doc, AnnotationSet as, Collection changes)` helper for sync() - never call directly
`private void` `OracleDataStore._syncRemovedAnnotations(Document doc, AnnotationSet as, Collection changes)` helper for sync() - never call directly
`private void` `OracleDataStore._syncAnnotationSets(Document doc, Collection removedSets, Collection addedSets)` helper for sync() - never call directly
`private void` `OracleDataStore._syncAnnotations(Document doc)` helper for sync() - never call directly

Uses of Document in gate.sgml

Fields in gate.sgml declared as Document
`private Document` `Sgml2Xml.m_doc`

Constructors in gate.sgml with parameters of type Document
`Sgml2Xml(Document doc)` The other constructor

Uses of Document in gate.util

Methods in gate.util with parameters of type Document
`protected void` `CorpusSaver.processDocument(Document doc)`
`protected void` `CorpusBenchmarkTool.processDocument(Document doc)`
`protected void` `CorpusBenchmarkTool.evaluateDocuments(Document persDoc, Document cleanDoc, Document markedDoc)`
`protected void` `CorpusBenchmarkTool.evaluateAllThree(Document persDoc, Document cleanDoc, Document markedDoc)`
`protected void` `CorpusBenchmarkTool.evaluateTwoDocs(Document keyDoc, Document respDoc)`
`protected AnnotationDiff` `CorpusBenchmarkTool.measureDocs(Document keyDoc, Document respDoc, String annotType)`
`protected void` `CorpusBenchmarkTool.printAnnotations(AnnotationDiff annotDiff, Document keyDoc, Document respDoc)`
`protected void` `CorpusBenchmarkTool.printAnnotations(Set set, Document doc)`

Uses of Document in gate.xml

Fields in gate.xml declared as Document
`private Document` `GateFormatXmlDocumentHandler.doc` A gate document
`private Document` `XmlDocumentHandler.doc` A gate document

Constructors in gate.xml with parameters of type Document
`GateFormatXmlDocumentHandler(Document aDocument)`
`XmlDocumentHandler(Document aDocument, Map aMarkupElementsMap, Map anElement2StringMap)` Constructs a XmlDocumentHandler object.
`XmlDocumentHandler(Document aDocument, Map aMarkupElementsMap, Map anElement2StringMap, AnnotationSet anAnnotationSet)` Constructs a XmlDocumentHandler object.