org.ipdr.common
Class DescriptorContentHandler

java.lang.Object
  org.ipdr.common.DescriptorContentHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class DescriptorContentHandler
extends java.lang.Object
implements org.xml.sax.ContentHandler

DescriptorContentHandler class implements the SAX ContentHandler interface and defines callback behavior for the SAX callbacks associated with Descriptor Generation.

Field Summary

protected CompositeDescriptorElement	baseElement_ To store the Base Schema's covering element.
protected boolean	baseSchema_ Flag indicating Base Schema.
protected CompositeDescriptorElement	compDescElement_ To store the Composite Descriptor Element being processed.
protected boolean	compositeFlag_ Flag indicating the start of Composite Element.
protected DescriptorElement	descElement_ To store the Descriptor Element being processed.
protected java.lang.String	extensionBase_ To store the Extension Base.
static java.lang.String	IPDR_DOC_TAG String to represent IPDR Doc Tag
static java.lang.String	IPDR_SETTLE_TAG String to represent IPDR Settlement Doc Tag
protected java.lang.String	ipdrVersion_ To store the IPDR Version.
protected java.util.ArrayList	listDescriptorElements_ ArrayList to store the list of Descriptor Elements.
protected java.util.ArrayList	listServiceElements_ ArrayList for storing the Service Elements.
protected org.xml.sax.Locator	locator_ Locator object containing the location information.
protected java.util.ArrayList	schemaLocation_ ArrayList containing the list of schemas location of the schema file.
protected boolean	serviceFlag_ Flag indicating the start of Serivice list.
protected java.lang.String	serviceType_ Stores the value of Service Type.
protected java.lang.String	targetNameSpaceID_ Stores the Target Namespace ID for a Schema.
protected java.util.ArrayList	URIStorage_ To store the nameSpaceInfo objects having uri and prefix.

Constructor Summary

DescriptorContentHandler()

Method Summary

void	characters(char[] ch, int start, int end) This will report character data (within an element).
void	endDocument() This indicates the end of a Document parse.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) Indicates the end of an element (</[element name]>) is reached.
void	endPrefixMapping(java.lang.String prefix) This indicates the end of a prefix mapping, when the namespace reported in a startPrefixMapping(java.lang.String, java.lang.String)callback is no longer available.
java.util.ArrayList	getDescriptorElements() Returns the Descriptor Elements arraylist.
java.lang.String	getExtensionBase() Method to get the value of Extension Base.
java.lang.String	getNameSpaceURI() Method to get the Target Namespace URI.
java.util.ArrayList	getParsedElements() Method to get the Service Elements.
java.util.ArrayList	getSchemaLocation() Method to get the list of schema locations.
java.lang.String	getSchemaVersion() Method to get the value of IPDR Version.
java.lang.String	getServiceType() Method to get the Service Type.
java.util.ArrayList	getURIStorage() Method to get the stored URIs from header.
void	ignorableWhitespace(char[] ch, int start, int end) This will report whitespace that can be ignored in the originating document.
void	processingInstruction(java.lang.String target, java.lang.String data) This will indicate that a processing instruction (other than the XML declaration) has been encountered.
void	setBaseSchemaFlag(boolean flag) Method to set flag indicating if Base Schema.
void	setDocumentLocator(org.xml.sax.Locator locator) Provide reference to 'Locator' which provides information about where in a document callbacks occur.
void	setSchemaVersion(java.lang.String ver) Method to set the value of IPDR Version
void	skippedEntity(java.lang.String name) This will report an entity that is skipped by the parser.
void	startDocument() This indicates the start of a Document parse.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes atts) This reports the occurrence of an actual element.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) This will indicate the beginning of an XML Namespace prefix mapping.

Methods inherited from class java.lang.Object

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

Field Detail

locator_

protected org.xml.sax.Locator locator_

Locator object containing the location information.

schemaLocation_

protected java.util.ArrayList schemaLocation_

ArrayList containing the list of schemas location of the schema file.

listDescriptorElements_

protected java.util.ArrayList listDescriptorElements_

ArrayList to store the list of Descriptor Elements.

listServiceElements_

protected java.util.ArrayList listServiceElements_

ArrayList for storing the Service Elements.

URIStorage_

protected java.util.ArrayList URIStorage_

To store the nameSpaceInfo objects having uri and prefix.

serviceType_

protected java.lang.String serviceType_

Stores the value of Service Type.

targetNameSpaceID_

protected java.lang.String targetNameSpaceID_

Stores the Target Namespace ID for a Schema.

extensionBase_

protected java.lang.String extensionBase_

To store the Extension Base.

ipdrVersion_

protected java.lang.String ipdrVersion_

To store the IPDR Version.

serviceFlag_

protected boolean serviceFlag_

Flag indicating the start of Serivice list.

compositeFlag_

protected boolean compositeFlag_

Flag indicating the start of Composite Element.

descElement_

protected DescriptorElement descElement_

To store the Descriptor Element being processed.

compDescElement_

protected CompositeDescriptorElement compDescElement_

To store the Composite Descriptor Element being processed.

baseElement_

protected CompositeDescriptorElement baseElement_

To store the Base Schema's covering element.

baseSchema_

protected boolean baseSchema_

Flag indicating Base Schema.

IPDR_DOC_TAG

public static final java.lang.String IPDR_DOC_TAG

String to represent IPDR Doc Tag

See Also:

Constant Field Values

IPDR_SETTLE_TAG

public static final java.lang.String IPDR_SETTLE_TAG

String to represent IPDR Settlement Doc Tag

See Also:

Constant Field Values

Constructor Detail

DescriptorContentHandler

public DescriptorContentHandler()

Method Detail

getSchemaLocation

public java.util.ArrayList getSchemaLocation()

Method to get the list of schema locations.

Returns:

List of schema locations

getDescriptorElements

public java.util.ArrayList getDescriptorElements()

Returns the Descriptor Elements arraylist.

Returns:

List of Descriptor Elements

getParsedElements

public java.util.ArrayList getParsedElements()

Method to get the Service Elements.

Returns:

List of Service Elements

getURIStorage

public java.util.ArrayList getURIStorage()

Method to get the stored URIs from header.

Returns:

List of stored URIs

getServiceType

public java.lang.String getServiceType()

Method to get the Service Type.

Returns:

The Service Type

getNameSpaceURI

public java.lang.String getNameSpaceURI()

Method to get the Target Namespace URI.

Returns:

The Target Namespace URI

getExtensionBase

public java.lang.String getExtensionBase()

Method to get the value of Extension Base.

Returns:

The Extension Base

getSchemaVersion

public java.lang.String getSchemaVersion()

Method to get the value of IPDR Version.

Returns:

The IPDR Version

setSchemaVersion

public void setSchemaVersion(java.lang.String ver)

Method to set the value of IPDR Version

Parameters:

ver - The IPDR Version

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Provide reference to 'Locator' which provides information about where in a document callbacks occur.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Parameters:

locator - 'Locator' object tied to callback process

setBaseSchemaFlag

public void setBaseSchemaFlag(boolean flag)

Method to set flag indicating if Base Schema.

Parameters:

flag - Boolean indication if Base Schema

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

This indicates the start of a Document parse. This precedes all callbacks in all SAX Handlers with the sole exception of setDocumentLocator(org.xml.sax.Locator)>

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

This indicates the end of a Document parse. This occurs after all callbacks in all SAX Handlers.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

This will indicate that a processing instruction (other than the XML declaration) has been encountered.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Parameters:

target - String target of PI

data - String containing all data sent to the PI.

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)

This will indicate the beginning of an XML Namespace prefix mapping. Although this typically occur within the root element of an XML document, it can occur at any point within the document. Note that a prefix mapping on an element triggers this callback before the callback for the actual element itself (startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)) occurs.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - String prefix used for the namespace being reported

uri - String URI for the namespace being reported

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

This indicates the end of a prefix mapping, when the namespace reported in a startPrefixMapping(java.lang.String, java.lang.String)callback is no longer available.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix - String of namespace being reported

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

This reports the occurrence of an actual element. It will include the element's attributes, with the exception of XML vocabulary specific attributes, such as xmlns:[namespace prefix] and xsi:schemaLocation

Specified by:

startElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - String namespace URI this element is associated with, or a empty string.

localName - String XML 1.0 version of element name: [namespace prefix]:[localName]

rawName - String name of element (with no namespace prefix, if one is present)

atts - Attributes list for this element

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException

Indicates the end of an element (</[element name]>) is reached. Note that the parser does not distinguish between empty elements and non-empty elements, so this will occur uniformly.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - String URI of namespace this element is associated with

localName - String name of element in XML 1.0 form

rawName - String name of element without prefix

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

characters

public void characters(char[] ch,
                       int start,
                       int end)
                throws org.xml.sax.SAXException

This will report character data (within an element).

Specified by:

characters in interface org.xml.sax.ContentHandler

Parameters:

ch - char[] character array with character data

start - int index in array where data starts.

end - int index in array where data ends.

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int end)
                         throws org.xml.sax.SAXException

This will report whitespace that can be ignored in the originating document. This is typically only invoked when validation is ocurring in the parsing process.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Parameters:

ch - char[] character array with character data

start - int index in array where data starts.

end - int index in array where data ends.

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

This will report an entity that is skipped by the parser. This should only occur for non-validating parsers, and then is still implementation-dependent behavior.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Parameters:

name - String name of entity being skipped

Throws:

org.xml.sax.SAXException - when an exception occurs during parsing