gate.corpora
Class XmlDocumentFormat

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.creole.AbstractResource
          gate.creole.AbstractLanguageResource
              gate.DocumentFormat
                  gate.corpora.TextualDocumentFormat
                      gate.corpora.XmlDocumentFormat

All Implemented Interfaces:

LanguageResource, Resource, FeatureBearer, NameBearer, Serializable

@CreoleResource(name="GATE XML Document Format",
                isPrivate=true,
                autoinstances=)
public class XmlDocumentFormat
extends TextualDocumentFormat

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
private static javax.xml.stream.XMLInputFactory	staxFactory InputFactory for the StAX parser used for GATE format XML.

Fields inherited from class gate.DocumentFormat

element2StringMap, magic2mimeTypeMap, markupElementsMap, mimeString2ClassHandlerMap, mimeString2mimeTypeMap, suffixes2mimeTypeMap

Fields inherited from class gate.creole.AbstractLanguageResource

dataStore, lrPersistentId

Fields inherited from class gate.creole.AbstractResource

name

Constructor Summary

XmlDocumentFormat()
Default construction

Method Summary

private static javax.xml.stream.XMLInputFactory	getInputFactory() Returns the StAX input factory, creating one if it is currently null.
Resource	init() Initialise this resource, and return it.
protected static boolean	isGateXmlFormat(String content) Determine whether the given document content string represents a GATE custom format XML document.
Boolean	supportsRepositioning() We could collect repositioning information during XML parsing
private void	unpackGateFormatMarkup(Document doc, StatusListener statusListener) Unpacks markup in the GATE-specific standoff XML markup format.
private void	unpackGeneralXmlMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo, StatusListener statusListener) Unpack markup from any XML format.
void	unpackMarkup(Document doc) Old style of unpackMarkup (without collecting of RepositioningInfo)
void	unpackMarkup(Document doc, RepositioningInfo repInfo, RepositioningInfo ampCodingInfo) Unpack the markup in the document.

Methods inherited from class gate.corpora.TextualDocumentFormat

annotateParagraphs, getDataStore, hasContentButNoValidUrl, setNewLineProperty

Methods inherited from class gate.DocumentFormat

addStatusListener, areEqual, decideBetweenThreeMimeTypes, decideBetweenTwoMimeTypes, fireStatusChanged, getDocumentFormat, getDocumentFormat, getDocumentFormat, getElement2StringMap, getFeatures, getMarkupElementsMap, getMimeType, getMimeTypeForString, getShouldCollectRepositioning, getSupportedFileSuffixes, guessTypeUsingMagicNumbers, removeStatusListener, runMagicNumbers, setElement2StringMap, setFeatures, setMarkupElementsMap, setMimeType, setShouldCollectRepositioning, unpackMarkup

Methods inherited from class gate.creole.AbstractLanguageResource

cleanup, getLRPersistenceId, getParent, isModified, setDataStore, setLRPersistenceId, setParent, sync

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, getBeanInfo, getName, getParameterValue, getParameterValue, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gate.LanguageResource

getLRPersistenceId, getParent, isModified, setDataStore, setLRPersistenceId, setParent, 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

See Also:

Constant Field Values

staxFactory

private static javax.xml.stream.XMLInputFactory staxFactory

InputFactory for the StAX parser used for GATE format XML.

Constructor Detail

XmlDocumentFormat

public XmlDocumentFormat()

Default construction

Method Detail

supportsRepositioning

public Boolean supportsRepositioning()

We could collect repositioning information during XML parsing

Overrides:

supportsRepositioning in class DocumentFormat

unpackMarkup

public void unpackMarkup(Document doc)
                  throws DocumentFormatException

Old style of unpackMarkup (without collecting of RepositioningInfo)

Overrides:

unpackMarkup in class TextualDocumentFormat

Throws:

DocumentFormatException

unpackMarkup

public void unpackMarkup(Document doc,
                         RepositioningInfo repInfo,
                         RepositioningInfo ampCodingInfo)
                  throws DocumentFormatException

Unpack the markup in the document. This converts markup from the native format (e.g. XML) into annotations in GATE format. Uses the markupElementsMap to determine which elements to convert, and what annotation type names to use. If the document was created from a String, then is recomandable to set the doc's sourceUrl to null. So, if the document has a valid URL, then the parser will try to parse the XML document pointed by the URL.If the URL is not valid, or is null, then the doc's content will be parsed. If the doc's content is not a valid XML then the parser might crash.

Overrides:

unpackMarkup in class TextualDocumentFormat

Parameters:

doc - The gate document you want to parse. If doc.getSourceUrl() returns null then the content of doc will be parsed. Using a URL is recomended because the parser will report errors corectlly if the XML document is not well formed.

Throws:

DocumentFormatException

unpackGateFormatMarkup

private void unpackGateFormatMarkup(Document doc,
                                    StatusListener statusListener)
                             throws DocumentFormatException

Unpacks markup in the GATE-specific standoff XML markup format.

Parameters:

doc - the document to process

statusListener - optional status listener to receive status messages

Throws:

DocumentFormatException - if a fatal error occurs during parsing

getInputFactory

private static javax.xml.stream.XMLInputFactory getInputFactory()
                                                         throws javax.xml.stream.XMLStreamException

Returns the StAX input factory, creating one if it is currently null.

Returns:

staxFactory

Throws:

javax.xml.stream.XMLStreamException

unpackGeneralXmlMarkup

private void unpackGeneralXmlMarkup(Document doc,
                                    RepositioningInfo repInfo,
                                    RepositioningInfo ampCodingInfo,
                                    StatusListener statusListener)
                             throws DocumentFormatException

Unpack markup from any XML format. The XML elements are translated to annotations on the Original markups annotation set.

Parameters:

doc - the document to process

Throws:

DocumentFormatException

isGateXmlFormat

protected static boolean isGateXmlFormat(String content)

Determine whether the given document content string represents a GATE custom format XML document.

init

public Resource init()
              throws ResourceInstantiationException

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class TextualDocumentFormat

Throws:

ResourceInstantiationException