org.w3c.rdf.util.xml
Class GenericParser

java.lang.Object
  |
  +--org.w3c.rdf.util.xml.GenericParser
All Implemented Interfaces:
DocumentHandler, DTDHandler, EntityResolver, RDFParser
Direct Known Subclasses:
StrawmanParser

public class GenericParser
extends java.lang.Object
implements EntityResolver, DTDHandler, DocumentHandler, RDFParser


Field Summary
protected  RDFConsumer consumer
           
protected  Element current
           
protected  ErrorHandler errorHandler
           
protected  Locator locator
           
protected  java.util.Stack namespaceStack
           
protected  NodeFactory nodeFactory
           
static java.lang.String REVISION
           
protected  InputSource source
           
 
Constructor Summary
GenericParser()
           
GenericParser(boolean warn)
           
 
Method Summary
protected  void _endElement(java.lang.String name)
           
protected static void _main(java.lang.String url, RDFParser parser)
           
protected  void _startElement(java.lang.String name, AttributeList al)
           
 void addError(java.lang.String sMsg)
          Generate an error message as a string
 void addWarning(java.lang.String sMsg)
          Generate a warning message as a string
 void characters(char[] ch, int start, int length)
          Receive notification of character data.
protected  Element createElement()
           
static Parser createParser(java.lang.String className)
           
protected  void createStatement(Resource subject, Resource predicate, RDFNode object)
           
 void doctype(java.lang.String name, java.lang.String publicID, java.lang.String systemID)
           
 void endDocument()
          Receive notification of the end of a document.
 void endElement(java.lang.String name)
          Receive notification of the end of an element.
static InputSource getInputSource(java.lang.String urlStr)
           
protected  java.util.Hashtable getNamespaces()
           
protected  java.lang.String getQualifiedName(java.lang.String colonName)
           
protected  java.lang.String getQualifiedName(java.lang.String nsAbb, java.lang.String name)
           
protected  java.lang.String getSourceURI()
           
 void ignorableWhitespace(char[] ch, int start, int length)
          Receive notification of ignorable whitespace in element content.
protected  void initXMLParser(boolean warn)
           
static void main(java.lang.String[] args)
           
 void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Receive notification of a notation declaration event.
 void parse(InputSource source, RDFConsumer consumer)
          Parse from the given SAX/XML input source.
protected  boolean preserveWhiteSpace()
           
 void processingInstruction(java.lang.String target, java.lang.String data)
          Receive notification of a processing instruction.
 InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
          Allow the application to resolve external entities.
 void setDocumentLocator(Locator locator)
          Receive an object for locating the origin of SAX document events.
 void setErrorHandler(ErrorHandler handler)
           
 void startDocument()
          Receive notification of the beginning of a document.
 void startElement(java.lang.String name, AttributeList al)
          Receive notification of the beginning of an element.
 void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
          Receive notification of an unparsed entity declaration event.
protected  java.util.Hashtable updateNamespaceStack(java.util.Hashtable namespaces, java.lang.String aName, java.lang.String aValue)
          creates a new namespace declaration if needed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final java.lang.String REVISION

errorHandler

protected ErrorHandler errorHandler

locator

protected Locator locator

namespaceStack

protected java.util.Stack namespaceStack

source

protected InputSource source

current

protected Element current

nodeFactory

protected NodeFactory nodeFactory

consumer

protected RDFConsumer consumer
Constructor Detail

GenericParser

public GenericParser()

GenericParser

public GenericParser(boolean warn)
Method Detail

initXMLParser

protected void initXMLParser(boolean warn)

addWarning

public void addWarning(java.lang.String sMsg)
                throws SAXException
Generate a warning message as a string

addError

public void addError(java.lang.String sMsg)
              throws SAXException
Generate an error message as a string

setDocumentLocator

public void setDocumentLocator(Locator locator)
Description copied from interface: DocumentHandler
Receive an object for locating the origin of SAX document events.

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

The locator 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 locator is probably not sufficient for use with a search engine.

Note that the locator 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 DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
locator - An object that can return the location of any SAX document event.
See Also:
Locator

startDocument

public void startDocument()
Description copied from interface: DocumentHandler
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 DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.

endDocument

public void endDocument()
                 throws SAXException
Description copied from interface: DocumentHandler
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 DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.

doctype

public void doctype(java.lang.String name,
                    java.lang.String publicID,
                    java.lang.String systemID)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
Description copied from interface: DocumentHandler
Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace 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.

Specified by:
ignorableWhitespace in interface DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DocumentHandler.characters(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
Description copied from interface: DocumentHandler
Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Specified by:
processingInstruction in interface DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if none was supplied.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.

resolveEntity

public InputSource resolveEntity(java.lang.String publicId,
                                 java.lang.String systemId)
Description copied from interface: EntityResolver
Allow the application to resolve external entities.

The Parser will call this method before opening any external entity except the top-level document entity (including the external DTD subset, external entities referenced within the DTD, and external entities referenced within the document element): the application may request that the parser resolve the entity itself, that it use an alternative URI, or that it use an entirely different input source.

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box).

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Specified by:
resolveEntity in interface EntityResolver
Following copied from interface: org.xml.sax.EntityResolver
Parameters:
publicId - The public identifier of the external entity being referenced, or null if none was supplied.
systemId - The system identifier of the external entity being referenced.
Returns:
An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
java.io.IOException - A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.
See Also:
InputSource

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)
Description copied from interface: DTDHandler
Receive notification of a notation declaration event.

It is up to the application to record the notation for later reference, if necessary.

If a system identifier is present, and it is a URL, the SAX parser must resolve it fully before passing it to the application.

Specified by:
notationDecl in interface DTDHandler
Following copied from interface: org.xml.sax.DTDHandler
Parameters:
name - The notation name.
publicId - The notation's public identifier, or null if none was given.
systemId - The notation's system identifier, or null if none was given.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), AttributeList

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)
Description copied from interface: DTDHandler
Receive notification of an unparsed entity declaration event.

Note that the notation name corresponds to a notation reported by the notationDecl() event. It is up to the application to record the entity for later reference, if necessary.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Specified by:
unparsedEntityDecl in interface DTDHandler
Following copied from interface: org.xml.sax.DTDHandler
Parameters:
name - The unparsed entity's name.
publicId - The entity's public identifier, or null if none was given.
systemId - The entity's system identifier (it must always have one).
notation - name The name of the associated notation.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), AttributeList

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
Specified by:
setErrorHandler in interface RDFParser

getNamespaces

protected java.util.Hashtable getNamespaces()

getQualifiedName

protected java.lang.String getQualifiedName(java.lang.String nsAbb,
                                            java.lang.String name)
                                     throws SAXException

getQualifiedName

protected java.lang.String getQualifiedName(java.lang.String colonName)
                                     throws SAXException

updateNamespaceStack

protected java.util.Hashtable updateNamespaceStack(java.util.Hashtable namespaces,
                                                   java.lang.String aName,
                                                   java.lang.String aValue)
creates a new namespace declaration if needed

getSourceURI

protected java.lang.String getSourceURI()

startElement

public void startElement(java.lang.String name,
                         AttributeList al)
                  throws SAXException
Description copied from interface: DocumentHandler
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.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Specified by:
startElement in interface DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
name - The element type name.
atts - The attributes attached to the element, if any.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DocumentHandler.endElement(java.lang.String), AttributeList

_startElement

protected void _startElement(java.lang.String name,
                             AttributeList al)
                      throws SAXException

createElement

protected Element createElement()

endElement

public void endElement(java.lang.String name)
                throws SAXException
Description copied from interface: DocumentHandler
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).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Specified by:
endElement in interface DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
name - The element type name
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.

_endElement

protected void _endElement(java.lang.String name)
                    throws SAXException

preserveWhiteSpace

protected boolean preserveWhiteSpace()

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException
Description copied from interface: DocumentHandler
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 using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Specified by:
characters in interface DocumentHandler
Following copied from interface: org.xml.sax.DocumentHandler
Parameters:
ch - The characters from the XML document.
start - The start position in the array.
length - The number of characters to read from the array.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
DocumentHandler.ignorableWhitespace(char[], int, int), Locator

createStatement

protected void createStatement(Resource subject,
                               Resource predicate,
                               RDFNode object)
                        throws ModelException

createParser

public static Parser createParser(java.lang.String className)

parse

public void parse(InputSource source,
                  RDFConsumer consumer)
           throws SAXException
Description copied from interface: RDFParser
Parse from the given SAX/XML input source.
Specified by:
parse in interface RDFParser

getInputSource

public static InputSource getInputSource(java.lang.String urlStr)
                                  throws java.net.MalformedURLException,
                                         java.io.IOException

_main

protected static void _main(java.lang.String url,
                            RDFParser parser)
                     throws java.io.IOException,
                            java.net.MalformedURLException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception