Uses of Interface
gate.Document

Packages that use Document
debugger.gui.debugging   
debugger.resources   
debugger.resources.lr   
debugger.resources.pr   
gate This package contains the public interface to the GATE Java API.  
gate.annotation   
gate.corpora   
gate.creole   
gate.creole.coref   
gate.creole.gazetteer   
gate.creole.ir   
gate.creole.ir.lucene   
gate.creole.morph   
gate.creole.nerc   
gate.creole.tokeniser.chinesetokeniser   
gate.email   
gate.event   
gate.fsm   
gate.gui   
gate.gui.docview   
gate.html   
gate.jape   
gate.persist   
gate.sgml   
gate.util   
gate.xml   
 

Uses of Document in debugger.gui.debugging
 

Fields in debugger.gui.debugging declared as Document
private  Document JapeDebuggingPanel.document
           
private  Document TraceHistoryPanel.document
           
 

Methods in debugger.gui.debugging with parameters of type Document
 void JapeDebuggingPanel.setText(int startOffset, int endOffset, Document document)
          This method is called from ShowResultAction action, when user selects text, on which he'd like to see the results of matching the rules.
 void TraceHistoryPanel.setText(int startOffset, int endOffset, Document document)
          This method is called from ShowResultAction action, when user selects text, on which he'd like to see the results of matching the rules.
 

Uses of Document in debugger.resources
 

Methods in debugger.resources with parameters of type Document
 void PhaseController.RuleMatched(SPTLock sptLock, SinglePhaseTransducer spt, RightHandSide rhs, Document document, HashMap bindings, AnnotationSet inputAS, AnnotationSet outputAS)
           
 void PhaseController.RuleFinished(SPTLock sptLock, SinglePhaseTransducer spt, RightHandSide rhs, Document document, HashMap bindings, AnnotationSet inputAS, AnnotationSet outputAS)
           
 

Uses of Document in debugger.resources.lr
 

Methods in debugger.resources.lr with parameters of type Document
 LrModel LRRoot.getDocumentModel(Document doc)
           
 

Uses of Document in debugger.resources.pr
 

Methods in debugger.resources.pr with parameters of type Document
 AnnotationSet RuleAnnotationHistory.getAnnotationSet(Document document)
           
 boolean RuleAnnotationHistory.addAnnotation(Annotation annotation, Document document)
           
 

Constructors in debugger.resources.pr with parameters of type Document
RuleTrace(State state, Document document)
           
 

Uses of Document in gate
 

Subinterfaces of Document in gate
 interface TextualDocument
          Top interface for all types of textual documents (transient or persistent).
 

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 SimpleAnnotationSet.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.
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.
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. ".txt") that the document came from.
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.
 void LanguageAnalyser.setDocument(Document document)
          Set the document property for this analyser.
 

Uses of Document in gate.annotation
 

Fields in gate.annotation declared as 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.
private  Document CorpusAnnotationDiff.keyDocument
          This document contains the key annotation set which is taken as reference in comparison
private  Document CorpusAnnotationDiff.responseDocument
          This document contains the response annotation set which is being compared against the key annotation set.
private  Document CorpusAnnotationDiff.DiffSetElement.keyDocument
          Key document
private  Document CorpusAnnotationDiff.DiffSetElement.respDocument
          Response document
protected  Document TestAnnotation.doc1
          A document
protected  Document TestDatabaseAnnotationSet.doc1
          A document
 

Methods in gate.annotation that return Document
 Document AnnotationDiff.getKeyDocument()
           
 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
 void AnnotationDiff.setKeyDocument(Document aKeyDocument)
          Sets the keyDocument in AnnotDiff
 void AnnotationDiff.setResponseDocument(Document aResponseDocument)
           
 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
AnnotationSetImpl(Document doc)
          Construction from Document.
AnnotationSetImpl(Document doc, String name)
          Construction from Document and name.
CorpusAnnotationDiff.DiffSetElement(Annotation aLeftAnnotation, Annotation aRightAnnotation, int aLeftType, int aRightType, Document kDocument, Document rDocument)
          Constructor for DiffSetlement with document 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.
 

Fields in gate.corpora declared as Document
private  Document DatabaseDocumentImpl.parentDocument
           
 

Methods in gate.corpora with parameters of type Document
 void CorpusImpl.unloadDocument(Document doc)
          This method does not make sense for transient corpora, so it does nothing.
 int DatabaseCorpusImpl.findDocument(Document doc)
           
 void DatabaseCorpusImpl.unloadDocument(Document doc)
          Unloads a document from memory
 void EmailDocumentFormat.unpackMarkup(Document doc)
          Unpack the markup in the document.
 void HtmlDocumentFormat.unpackMarkup(Document doc)
          Old style of unpackMarkup (without collecting of RepositioningInfo)
 void HtmlDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
          Unpack the markup in the document.
 void RtfDocumentFormat.unpackMarkup(Document doc)
          Unpack the markup in the document.
 void SerialCorpusImpl.unloadDocument(Document doc)
          Unloads a document from memory
 int SerialCorpusImpl.findDocument(Document doc)
           
private  void SerialCorpusImpl.documentAdded(Document doc)
           
 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.
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 TextualDocumentFormat.unpackMarkup(Document doc)
          Unpack the markup in the document.
 void TextualDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
           
protected  void TextualDocumentFormat.setNewLineProperty(Document doc)
          Check the new line sequence and set document property.
private  void TextualDocumentFormat.removeExtraNewLine(Document doc)
          Delete '\r' in combination CRLF or LFCR in document content
 void TextualDocumentFormat.annotateParagraphs(Document aDoc, int startOffset, int endOffset, String annotSetName)
          This method annotates paragraphs in a GATE document.
 void XmlDocumentFormat.unpackMarkup(Document doc)
          Old style of unpackMarkup (without collecting of RepositioningInfo)
 void XmlDocumentFormat.unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
          Unpack the markup in the document.
private  void XmlDocumentFormat.parseDocumentWithoutURL(Document aDocument, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo)
          Called from unpackMarkup() if the document have been created from a string
 

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.
protected  void ConditionalSerialAnalyserController.setDocToPrs(Document doc)
          Sets the current document to the memeber PRs
protected  void SerialAnalyserController.setDocToPrs(Document doc)
          Sets the current document to the memeber PRs
 void TestPR.compareAnnots(Document keyDocument, Document responseDocument)
           
 

Uses of Document in gate.creole.coref
 

Methods in gate.creole.coref that return Document
private  Document TestCoref.loadDocument(String url)
           
 

Methods in gate.creole.coref with parameters of type Document
 void AbstractCoreferencer.setDocument(Document newDocument)
          Set the document to run on.
 void Coreferencer.setDocument(Document newDocument)
          Set the document to run on.
 void NominalCoref.setDocument(Document newDocument)
          Set the document to run on.
 void PronominalCoref.setDocument(Document newDocument)
          Set the document to run on.
private  void TestCoref.runANNIE(Document doc)
           
 

Uses of Document in gate.creole.gazetteer
 

Fields in gate.creole.gazetteer declared as Document
private  Document FlexibleGazetteer.document
           
 

Methods in gate.creole.gazetteer that return Document
 Document FlexibleGazetteer.getDocument()
          Returns the document set up by user to work on
 

Methods in gate.creole.gazetteer with parameters of type Document
 void FlexibleGazetteer.setDocument(Document doc)
          Sets the document to work on
 Iterator FlexibleGazetteer.getTokenIterator(Document doc, String annotationSetName)
          This method takes the document and the annotationSetName and then creates a interator for the annotations available in the document under the provided annotationSetName
 

Uses of Document in gate.creole.ir
 

Methods in gate.creole.ir with parameters of type Document
 String DocumentContentReader.getPropertyValue(Document doc)
           
 String FeatureReader.getPropertyValue(Document doc)
           
 String PropertyReader.getPropertyValue(Document doc)
           
 

Uses of Document in gate.creole.ir.lucene
 

Methods in gate.creole.ir.lucene with parameters of type Document
private  org.apache.lucene.document.Document LuceneIndexManager.getLuceneDoc(Document gateDoc)
           
 

Uses of Document in gate.creole.morph
 

Fields in gate.creole.morph declared as Document
private  Document Morph.document
          Document to be processed by the morpher, must be provided at Runtime.
private  Document TestMorph.verbDocumentToTest
           
private  Document TestMorph.verbDocumentWithAnswers
           
private  Document TestMorph.nounDocumentToTest
           
private  Document TestMorph.nounDocumentWithAnswers
           
 

Methods in gate.creole.morph that return Document
 Document Morph.getDocument()
          Returns the document under process
 

Methods in gate.creole.morph with parameters of type Document
 void Morph.setDocument(Document document)
          Sets the document to be processed
 

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.creole.tokeniser.chinesetokeniser
 

Fields in gate.creole.tokeniser.chinesetokeniser declared as Document
private  Document ChineseTokeniser.document
          The name of the sourceFile
private  Document ChineseTokeniser.tempDoc
          Temporary document
 

Methods in gate.creole.tokeniser.chinesetokeniser that return Document
 Document ChineseTokeniser.getDocument()
          Returns the document under process
 

Methods in gate.creole.tokeniser.chinesetokeniser with parameters of type Document
 void ChineseTokeniser.setDocument(Document document)
          Sets the document to be processed
 

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.
CorpusEvent(Corpus source, Document doc, int index, int type)
          Creates a new CorpusEvent.
DocumentEvent(Document source, int type, String setName)
          Constructor.
DocumentEvent(Document source, int type, Long editStart, Long editEnd)
          Constructor.
 

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
protected  Document AnnotationDiffGUI.keyDoc
           
protected  Document AnnotationDiffGUI.resDoc
           
private  Document DocumentEditor.document
          The Document currently displayed.
(package private)  Document ShellSlacFrame.ExportInline.document
           
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
 Document DocumentEditor.getDocument()
          Return the current selected 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
protected  void ShellSlacFrame.showDocument(Document doc)
          Find in resource tree and show the document
 

Constructors in gate.gui with parameters of type Document
ShellSlacFrame.ExportInline(Document doc, File target)
           
 

Uses of Document in gate.gui.docview
 

Fields in gate.gui.docview declared as Document
protected  Document AbstractDocumentView.document
          The document this view displays.
protected  Document DocumentEditor.document
           
 

Methods in gate.gui.docview that return Document
 Document AbstractDocumentView.getDocument()
          Gets the document this view displays.
 

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, Map aMarkupElementsMap)
          Constructor initialises all the private memeber data.
HtmlDocumentHandler(Document aDocument, 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
 boolean BasicPatternElement.matches(Document doc, int position, MutableInteger newPosition)
          Does this element match the document at this position?
 void Batch.transduce(Document doc)
          Process a single document.
 void Batch.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)
          Process a single document.
 boolean ComplexPatternElement.matches(Document doc, int position, MutableInteger newPosition)
          Does this element match the document at this position?
 boolean ConstraintGroup.matches(Document doc, int position, MutableInteger newPosition)
          Does this element match the document at this position?
 boolean LeftHandSide.matches(Document doc, int position, MutableInteger newPosition)
          Does the LHS match the document at this position?
 boolean Matcher.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 RhsAction.doit(Document doc, Map bindings, AnnotationSet annotations, AnnotationSet inputAS, AnnotationSet outputAS, Ontology ontology)
          Fires the RHS action for a particular LHS match.
 void RightHandSide.transduce(Document doc, Map bindings, AnnotationSet inputAS, AnnotationSet outputAS, Ontology ontology)
          Makes changes to the document, using LHS bindings.
 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).
 void SinglePhaseTransducer.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)
          Transduce a document using the annotation set provided and the current rule application style.
abstract  void Transducer.transduce(Document doc, AnnotationSet inputAS, AnnotationSet outputAS)
          Transduce a document.
 

Uses of Document in gate.persist
 

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

Methods in gate.persist with parameters of type Document
protected  Document JDBCDataStore.createDocument(Document doc, SecurityInfo secInfo)
          helper for adopt creates a LR of type Document
protected  Document JDBCDataStore.createDocument(Document doc, Long corpusID, SecurityInfo secInfo)
          helper for adopt creates a LR of type Document
protected  void JDBCDataStore.syncDocument(Document doc)
          helper for sync() - saves a Document in the database
protected abstract  void JDBCDataStore._syncDocumentHeader(Document doc)
          helper for sync() - never call directly
protected abstract  void JDBCDataStore._syncDocumentContent(Document doc)
          helper for sync() - never call directly
protected  void JDBCDataStore._syncAnnotationSets(Document doc, Collection removedSets, Collection addedSets)
          helper for sync() - never call directly
protected  void JDBCDataStore._syncAnnotations(Document doc)
          helper for sync() - never call directly
protected  void JDBCDataStore._syncAddedAnnotations(Document doc, AnnotationSet as, Collection changes)
          helper for sync() - never call directly
protected  void JDBCDataStore._syncRemovedAnnotations(Document doc, AnnotationSet as, Collection changes)
          helper for sync() - never call directly
protected  void JDBCDataStore._syncChangedAnnotations(Document doc, AnnotationSet as, Collection changes)
          helper for sync() - never call directly
protected  void OracleDataStore._syncDocumentHeader(Document doc)
          helper for sync() - never call directly
protected  void OracleDataStore._syncDocumentContent(Document doc)
          helper for sync() - never call directly
protected  void PostgresDataStore._syncDocumentHeader(Document doc)
          helper for sync() - never call directly
protected  void PostgresDataStore._syncDocumentContent(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 CorpusBenchmarkTool.processDocument(Document doc)
           
protected  void CorpusBenchmarkTool.evaluateDocuments(Document persDoc, Document cleanDoc, Document markedDoc, File errDir)
           
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.evaluateTwoDocs(Document keyDoc, Document respDoc, File errDir)
           
protected  AnnotationDiffer CorpusBenchmarkTool.measureDocs(Document keyDoc, Document respDoc, String annotType)
           
protected  void CorpusBenchmarkTool.storeAnnotations(String type, AnnotationDiffer annotDiffer, Document keyDoc, Document respDoc, Writer errFileWriter)
           
protected  void CorpusBenchmarkTool.storeAnnotations(String type, Set set, Document doc, Writer file)
           
protected  void CorpusBenchmarkTool.printAnnotations(AnnotationDiffer annotDiff, Document keyDoc, Document respDoc)
           
protected  void CorpusBenchmarkTool.printAnnotations(Set set, Document doc)
           
protected  void CorpusSaver.processDocument(Document doc)
           
 String Scratch.ContentPropertyReader.getPropertyValue(Document doc)
           
static boolean TestEqual.documentsEqual(Document doc1, Document doc2)
          Checks two documents for equality.
 

Uses of Document in gate.xml
 

Fields in gate.xml declared as Document
private  Document GateFormatXmlDocumentHandler.doc
          A gate document
private  Document TestRepositioningInfo.doc
          Document instance
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.