gate.corpora
Class TextualDocumentFormat

java.lang.Object
  |
  +--gate.util.AbstractFeatureBearer
        |
        +--gate.creole.AbstractResource
              |
              +--gate.creole.AbstractLanguageResource
                    |
                    +--gate.DocumentFormat
                          |
                          +--gate.corpora.TextualDocumentFormat
All Implemented Interfaces:
FeatureBearer, LanguageResource, NameBearer, Resource, Serializable
Direct Known Subclasses:
EmailDocumentFormat, HtmlDocumentFormat, RtfDocumentFormat, SgmlDocumentFormat, XmlDocumentFormat

public class TextualDocumentFormat
extends DocumentFormat

The format of Documents. Subclasses of DocumentFormat know about particular MIME types and how to unpack the information in any markup or formatting they contain into GATE annotations. Each MIME type has its own subclass of DocumentFormat, e.g. XmlDocumentFormat, RtfDocumentFormat, MpegDocumentFormat. These classes register themselves with a static index residing here when they are constructed. Static getDocumentFormat methods can then be used to get the appropriate format class for a particular document.

See Also:
Serialized Form

Field Summary
private static boolean DEBUG
          Debug flag
 
Fields inherited from class gate.DocumentFormat
element2StringMap, features, isGateXmlDocument, magic2mimeTypeMap, markupElementsMap, mimeString2ClassHandlerMap, mimeString2mimeTypeMap, mimeType, statusListeners, suffixes2mimeTypeMap
 
Fields inherited from class gate.creole.AbstractLanguageResource
dataStore, lrPersistentId, serialVersionUID
 
Fields inherited from class gate.creole.AbstractResource
name
 
Constructor Summary
TextualDocumentFormat()
          Default construction
 
Method Summary
 void annotateParagraphs(Document aDoc, int startOffset, int endOffset, String annotSetName)
          This method annotates paragraphs in a GATE document.
 DataStore getDataStore()
          Get the data store that this LR lives in.
 Resource init()
          Initialise this resource, and return it.
 void unpackMarkup(Document doc)
          Unpack the markup in the document.
 
Methods inherited from class gate.DocumentFormat
addStatusListener, areEqual, decideBetweenThreeMimeTypes, decideBetweenTwoMimeTypes, fireStatusChanged, getDocumentFormat, getDocumentFormat, getDocumentFormat, getElement2StringMap, getFeatures, getFileSufix, getMarkupElementsMap, getMimeType, getMimeType, getMimeType, guessTypeUsingMagicNumbers, removeStatusListener, runMagicNumbers, setElement2StringMap, setFeatures, setMarkupElementsMap, setMimeType, unpackMarkup
 
Methods inherited from class gate.creole.AbstractLanguageResource
cleanup, getLRPersistenceId, setDataStore, setLRPersistenceId, sync
 
Methods inherited from class gate.creole.AbstractResource
checkParameterValues, getName, getParameterValue, getParameterValue, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 
Methods inherited from interface gate.LanguageResource
getLRPersistenceId, setDataStore, setLRPersistenceId, sync
 
Methods inherited from interface gate.Resource
cleanup, getParameterValue, setParameterValue, setParameterValues
 
Methods inherited from interface gate.util.NameBearer
getName, setName
 

Field Detail

DEBUG

private static final boolean DEBUG
Debug flag
Constructor Detail

TextualDocumentFormat

public TextualDocumentFormat()
Default construction
Method Detail

init

public Resource init()
              throws ResourceInstantiationException
Initialise this resource, and return it.
Overrides:
init in class AbstractResource

unpackMarkup

public void unpackMarkup(Document doc)
                  throws DocumentFormatException
Unpack the markup in the document. This converts markup from the native format (e.g. XML, RTF) into annotations in GATE format. Uses the markupElementsMap to determine which elements to convert, and what annotation type names to use.
Overrides:
unpackMarkup in class DocumentFormat

annotateParagraphs

public void annotateParagraphs(Document aDoc,
                               int startOffset,
                               int endOffset,
                               String annotSetName)
                        throws DocumentFormatException
This method annotates paragraphs in a GATE document. The investigated text spans beetween start and end offsets and the paragraph annotations are created in the annotSetName. If annotSetName is null then they are creted in the default annotation set.
Parameters:
aDoc - is the gate document on which the paragraph detection would be performed.If it is null or its content it's null then the method woul simply return doing nothing.
startOffset - is the index form the document content from which the paragraph detection will start
endOffset - is the offset where the detection will end.
annotSetName - is the name of the set in which paragraph annotation would be created.The annotation type created will be "paragraph"

getDataStore

public DataStore getDataStore()
Description copied from interface: LanguageResource
Get the data store that this LR lives in. Null for transient LRs.
Overrides:
getDataStore in class AbstractLanguageResource