gate.xml
Class XmlDocumentHandler

java.lang.Object
  |
  +--org.xml.sax.helpers.DefaultHandler
        |
        +--gate.xml.XmlPositionCorrectionHandler
              |
              +--gate.xml.XmlDocumentHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XmlDocumentHandler
extends XmlPositionCorrectionHandler

Implements the behaviour of the XML reader Methods of an object of this class are called by the SAX parser when events will appear. The idea is to parse the XML document and construct Gate annotations objects. This class also will replace the content of the Gate document with a new one containing only text from the XML document.


Constructor Summary
XmlDocumentHandler(Document aDocument, Map aMarkupElementsMap, Map anElement2StringMap)
          Constructs a XmlDocumentHandler object.
XmlDocumentHandler(Document aDocument, Map aMarkupElementsMap, Map anElement2StringMap, AnnotationSet anAnnotationSet)
          Constructs a XmlDocumentHandler object.
 
Method Summary
 void addStatusListener(StatusListener listener)
          This methos is called when a listener is registered with this class
 void characters(char[] text, int start, int length)
          This method is called when the SAX parser encounts text in the XML doc.
 void comment(String text)
          This method is called when the SAX parser encounts a comment It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener
 void endCDATA()
          This method is called when the SAX parser encounts the end of a CDATA section.
 void endDocument()
          This method is called when the SAX parser encounts the end of the XML document.
 void endElement(String uri, String qName, String elemName)
          This method is called when the SAX parser encounts the end of an XML element.
 void endParsedEntity(String name, boolean included)
          This method is called when the SAX parser encounts a parsed entity and informs the application if that entity was parsed or not It's working only if the CustomDocumentHandler implements a com.sun.parser.LexicalEventListener
 void error(org.xml.sax.SAXParseException ex)
          Error method.We deal with this exception inside SimpleErrorHandler class
 void fatalError(org.xml.sax.SAXParseException ex)
          FatalError method.
 RepositioningInfo getAmpCodingInfo()
          Return current RepositioningInfo object for ampersand coding.
 int getCustomObjectsId()
          Accesor method for the customObjectsId field
 RepositioningInfo getRepositioningInfo()
          Return current RepositioningInfo object
 void ignorableWhitespace(char[] ch, int start, int length)
          This method is called when the SAX parser encounts white spaces
 void removeStatusListener(StatusListener listener)
          This methos is called when a listener is removed
 void setAmpCodingInfo(RepositioningInfo info)
          Set repositioning information structure refference for ampersand coding.
 void setRepositioningInfo(RepositioningInfo info)
          Set repositioning information structure refference.
 void startCDATA()
          This method is called when the SAX parser encounts a start of a CDATA section It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener
 void startDocument()
          This method is called when the SAX parser encounts the beginning of the XML document.
 void startElement(String uri, String qName, String elemName, org.xml.sax.Attributes atts)
          This method is called when the SAX parser encounts the beginning of an XML element.
 void startParsedEntity(String name)
          This method is called when the SAX parser encounts a parsed Entity It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener
 void warning(org.xml.sax.SAXParseException ex)
          Warning method comment.
 
Methods inherited from class gate.xml.XmlPositionCorrectionHandler
getRealOffset
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endPrefixMapping, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XmlDocumentHandler

public XmlDocumentHandler(Document aDocument,
                          Map aMarkupElementsMap,
                          Map anElement2StringMap)
Constructs a XmlDocumentHandler object. The annotationSet set will be the default one taken from the gate document.
Parameters:
aDocument - the Gate document that will be processed.
aMarkupElementsMap - this map contains the elements name that we want to create.
anElement2StringMap - this map contains the strings that will be added to the text contained by the key element.

XmlDocumentHandler

public XmlDocumentHandler(Document aDocument,
                          Map aMarkupElementsMap,
                          Map anElement2StringMap,
                          AnnotationSet anAnnotationSet)
Constructs a XmlDocumentHandler object.
Parameters:
aDocument - the Gate document that will be processed.
aMarkupElementsMap - this map contains the elements name that we want to create.
anElement2StringMap - this map contains the strings that will be added to the text contained by the key element.
anAnnotationSet - is the annotation set that will be filled when the document was processed
Method Detail

setRepositioningInfo

public void setRepositioningInfo(RepositioningInfo info)
Set repositioning information structure refference. If you set this refference to null information wouldn't be collected.

getRepositioningInfo

public RepositioningInfo getRepositioningInfo()
Return current RepositioningInfo object

setAmpCodingInfo

public void setAmpCodingInfo(RepositioningInfo info)
Set repositioning information structure refference for ampersand coding. If you set this refference to null information wouldn't be used.

getAmpCodingInfo

public RepositioningInfo getAmpCodingInfo()
Return current RepositioningInfo object for ampersand coding.

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
This method is called when the SAX parser encounts the beginning of the XML document.
Overrides:
startDocument in class XmlPositionCorrectionHandler

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
This method is called when the SAX parser encounts the end of the XML document. Here we set the content of the gate Document to be the one generated inside this class (tmpDocContent). After that we use the colector to generate all the annotation reffering this new gate document.
Overrides:
endDocument in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(String uri,
                         String qName,
                         String elemName,
                         org.xml.sax.Attributes atts)
This method is called when the SAX parser encounts the beginning of an XML element.
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(String uri,
                       String qName,
                       String elemName)
                throws org.xml.sax.SAXException
This method is called when the SAX parser encounts the end of an XML element. Here we extract
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] text,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
This method is called when the SAX parser encounts text in the XML doc. Here we calculate the end indices for all the elements present inside the stack and update with the new values. For entities, this method is called separatley regardless of the text sourinding the entity.
Overrides:
characters in class XmlPositionCorrectionHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
This method is called when the SAX parser encounts white spaces
Overrides:
ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

error

public void error(org.xml.sax.SAXParseException ex)
           throws org.xml.sax.SAXException
Error method.We deal with this exception inside SimpleErrorHandler class
Overrides:
error in class org.xml.sax.helpers.DefaultHandler

fatalError

public void fatalError(org.xml.sax.SAXParseException ex)
                throws org.xml.sax.SAXException
FatalError method.
Overrides:
fatalError in class org.xml.sax.helpers.DefaultHandler

warning

public void warning(org.xml.sax.SAXParseException ex)
             throws org.xml.sax.SAXException
Warning method comment.
Overrides:
warning in class org.xml.sax.helpers.DefaultHandler

comment

public void comment(String text)
             throws org.xml.sax.SAXException
This method is called when the SAX parser encounts a comment It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener

startCDATA

public void startCDATA()
                throws org.xml.sax.SAXException
This method is called when the SAX parser encounts a start of a CDATA section It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException
This method is called when the SAX parser encounts the end of a CDATA section. It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener

startParsedEntity

public void startParsedEntity(String name)
                       throws org.xml.sax.SAXException
This method is called when the SAX parser encounts a parsed Entity It works only if the XmlDocumentHandler implements a com.sun.parser.LexicalEventListener

endParsedEntity

public void endParsedEntity(String name,
                            boolean included)
                     throws org.xml.sax.SAXException
This method is called when the SAX parser encounts a parsed entity and informs the application if that entity was parsed or not It's working only if the CustomDocumentHandler implements a com.sun.parser.LexicalEventListener

addStatusListener

public void addStatusListener(StatusListener listener)
This methos is called when a listener is registered with this class

removeStatusListener

public void removeStatusListener(StatusListener listener)
This methos is called when a listener is removed

getCustomObjectsId

public int getCustomObjectsId()
Accesor method for the customObjectsId field