raccoon.core.badhnati.xml
Class SaxHandler

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by raccoon.core.badhnati.xml.SaxHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler

public class SaxHandler
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler

Parses an XML file that is converted into an instance of IMessage.

Since:
Raccoon v1.0
Version:
$Id: SaxHandler.java,v 1.2 2004/08/11 21:15:42 crouvrais Exp $
Author:
Cedric ROUVRAIS

Field Summary
static java.lang.String STR_EMPTY
          The empty string constant.
 
Constructor Summary
SaxHandler(IFactory pFactory)
          Assigns the factory to use.
SaxHandler(IFactory pFactory, boolean pSetFastMode)
          Assigns the required components to this instace.
 
Method Summary
 void characters(char[] pChars, int pStart, int pLength)
          Receive notification of character data.
 void comment(char[] pCharacters, int pStart, int pLength)
          Report an XML comment anywhere in the document.
 void endCDATA()
          Report the end of a CDATA section.
 void endDocument()
          Receive notification of the end of a document.
 void endDTD()
          Report the end of DTD declarations.
 void endElement(java.lang.String pNamespaceURI, java.lang.String pLocalName, java.lang.String pQualifiedName)
          Receive notification of the end of an element.
 void endEntity(java.lang.String pEntityName)
          Report the end of an entity.
 int nbParsedMsg()
          The number of messages that where extracted from the XML File.
 int nbUnparsedMsg()
          The number of messages that where extracted from the XML File.
 IMessage pop()
          Removes from the stack of parsed messages the next message.
 void setDocumentLocator(org.xml.sax.Locator pLocator)
          Receive an object for locating the origin of SAX document events.
 void startCDATA()
          Report the start of a CDATA section.
 void startDocument()
          Receive notification of the beginning of a document.
 void startDTD(java.lang.String pName, java.lang.String pPublicId, java.lang.String pSystemId)
          Report the start of DTD declarations, if any.
 void startElement(java.lang.String pNamespaceURI, java.lang.String pLocalName, java.lang.String pQualifiedName, org.xml.sax.Attributes pAttributes)
          Receive notification of the beginning of an element.
 void startEntity(java.lang.String pName)
          Report the beginning of some internal and external XML entities.
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STR_EMPTY

public static final java.lang.String STR_EMPTY
The empty string constant.

See Also:
Constant Field Values
Constructor Detail

SaxHandler

public SaxHandler(IFactory pFactory)
           throws java.lang.IllegalArgumentException
Assigns the factory to use.

Parameters:
pFactory - the factory to use for instanciating new objects.
Throws:
java.lang.IllegalArgumentException - if the factory instance is null.

SaxHandler

public SaxHandler(IFactory pFactory,
                  boolean pSetFastMode)
Assigns the required components to this instace.

Parameters:
pFactory - the to use for instanciating new objects.
pSetFastMode - the fast mode indicator.
Method Detail

pop

public IMessage pop()
             throws RaccoonException
Removes from the stack of parsed messages the next message.

Returns:
the message on top of the stack.
Throws:
RaccoonException - if the parsing proces hasn't occurred.

nbParsedMsg

public int nbParsedMsg()
The number of messages that where extracted from the XML File.

Returns:
the number of messages contained in the stack

nbUnparsedMsg

public int nbUnparsedMsg()
The number of messages that where extracted from the XML File.

Returns:
the number of messages contained in the stack

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator pLocator)
Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a pLocator: if it does so, it must supply the pLocator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The pLocator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the pLocator is probably not sufficient for use with a search engine.

Note that the pLocator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Specified by:
setDocumentLocator in interface org.xml.sax.ContentHandler
Overrides:
setDocumentLocator in class org.xml.sax.helpers.DefaultHandler
Parameters:
pLocator - An object that can return the location of any SAX document event.
See Also:
Locator

startDocument

public void startDocument()
Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class org.xml.sax.helpers.DefaultHandler
See Also:
endDocument()

endDocument

public void endDocument()
Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class org.xml.sax.helpers.DefaultHandler
See Also:
startDocument()

startElement

public void startElement(java.lang.String pNamespaceURI,
                         java.lang.String pLocalName,
                         java.lang.String pQualifiedName,
                         org.xml.sax.Attributes pAttributes)
Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

This event allows up to three name components for each element:

  1. the Namespace URI;
  2. the local name; and
  3. the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
pNamespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
pLocalName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
pQualifiedName - The qualified name (with prefix), or the empty string if qualified names are not available.
pAttributes - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
See Also:
endElement(java.lang.String, java.lang.String, java.lang.String), Attributes

endElement

public void endElement(java.lang.String pNamespaceURI,
                       java.lang.String pLocalName,
                       java.lang.String pQualifiedName)
                throws org.xml.sax.SAXException
Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement event for every endElement event (even when the element is empty).

For information on the names, see startElement.

Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
pNamespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
pLocalName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
pQualifiedName - The qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

characters

public void characters(char[] pChars,
                       int pStart,
                       int pLength)
                throws org.xml.sax.SAXException
Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace in element content using the ignorableWhitespace method rather than this one (validating parsers must do so).

Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class org.xml.sax.helpers.DefaultHandler
Parameters:
pChars - The characters from the XML document.
pStart - The pStart position in the array.
pLength - The number of characters to read from the array.
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DefaultHandler.ignorableWhitespace(char[], int, int), Locator

comment

public void comment(char[] pCharacters,
                    int pStart,
                    int pLength)
Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).

Specified by:
comment in interface org.xml.sax.ext.LexicalHandler
Parameters:
pCharacters - An array holding the characters in the comment.
pStart - The starting position in the array.
pLength - The number of characters to use from the array.

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException
Report the end of a CDATA section.

Specified by:
endCDATA in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException - The application may raise an exception.
See Also:
startCDATA()

endDTD

public void endDTD()
            throws org.xml.sax.SAXException
Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Specified by:
endDTD in interface org.xml.sax.ext.LexicalHandler
Throws:
org.xml.sax.SAXException - The application may raise an exception.
See Also:
startDTD(java.lang.String, java.lang.String, java.lang.String)

endEntity

public void endEntity(java.lang.String pEntityName)
               throws org.xml.sax.SAXException
Report the end of an entity.

Specified by:
endEntity in interface org.xml.sax.ext.LexicalHandler
Parameters:
pEntityName - The pEntityName of the entity that is ending.
Throws:
org.xml.sax.SAXException - The application may raise an exception.
See Also:
startEntity(java.lang.String)

startCDATA

public void startCDATA()
Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event; this event is intended only to report the boundary.

Specified by:
startCDATA in interface org.xml.sax.ext.LexicalHandler
See Also:
endCDATA()

startDTD

public void startDTD(java.lang.String pName,
                     java.lang.String pPublicId,
                     java.lang.String pSystemId)
              throws org.xml.sax.SAXException
Report the start of DTD declarations, if any.

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD and endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity and endEntity events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.

Specified by:
startDTD in interface org.xml.sax.ext.LexicalHandler
Parameters:
pName - The document type name.
pPublicId - The declared public identifier for the external DTD subset, or null if none was declared.
pSystemId - The declared system identifier for the external DTD subset, or null if none was declared.
Throws:
org.xml.sax.SAXException - The application may raise an exception.
See Also:
endDTD(), startEntity(java.lang.String)

startEntity

public void startEntity(java.lang.String pName)
                 throws org.xml.sax.SAXException
Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that support LexicalHandler may not support it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Specified by:
startEntity in interface org.xml.sax.ext.LexicalHandler
Parameters:
pName - The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".
Throws:
org.xml.sax.SAXException - The application may raise an exception.
See Also:
endEntity(java.lang.String), DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)


Copyright null null. All Rights Reserved.