org.openrdf.rio.rdfxml

Class RDFXMLParser

java.lang.Object

org.openrdf.rio.helpers.RDFParserBase

org.openrdf.rio.rdfxml.RDFXMLParser

All Implemented Interfaces:

RDFParser, ErrorHandler

public class RDFXMLParser
extends RDFParserBase
implements ErrorHandler

A parser for XML-serialized RDF. This parser operates directly on the SAX events generated by a SAX-enabled XML parser. The XML parser should be compliant with SAX2. You should specify which SAX parser should be used by setting the org.xml.sax.driver property. This parser is not thread-safe, therefore it's public methods are synchronized.

To parse a document using this parser:

• Create an instance of RDFXMLParser, optionally supplying it with your own ValueFactory.
• Set the RDFHandler.
• Optionally, set the ParseErrorListener and/or ParseLocationListener.
• Optionally, specify whether the parser should verify the data it parses and whether it should stop immediately when it finds an error in the data (both default to true).
• Call the parse method.

Example code:

 // Use the SAX2-compliant Xerces parser:
 System.setProperty("org.xml.sax.driver", "org.apache.xerces.parsers.SAXParser");
 
 RDFParser parser = new RDFXMLParser();
 parser.setRDFHandler(myRDFHandler);
 parser.setParseErrorListener(myParseErrorListener);
 parser.setVerifyData(true);
 parser.stopAtFirstError(false);
 
 // Parse the data from inputStream, resolving any
 // relative URIs against http://foo/bar:
 parser.parse(inputStream, "http://foo/bar");
 

Author:

Arjohn Kampman

See Also:

ValueFactory, RDFHandler, ParseErrorListener, ParseLocationListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.openrdf.rio.RDFParser

RDFParser.DatatypeHandling

Field Summary

Fields inherited from class org.openrdf.rio.helpers.RDFParserBase

rdfHandler, valueFactory

Constructor Summary

Constructors

Constructor and Description
RDFXMLParser() Creates a new RDFXMLParser that will use a ValueFactoryImpl to create RDF model objects.
RDFXMLParser(ValueFactory valueFactory) Creates a new RDFXMLParser that will use the supplied ValueFactory to create RDF model objects.

Method Summary

Modifier and Type	Method and Description
protected BNode	createBNode(String nodeID) Creates a BNode object for the specified identifier.
protected Literal	createLiteral(String label, String lang, URI datatype) Creates a Literal object with the supplied parameters.
void	error(SAXParseException exception) Implementation of SAX ErrorHandler.error
void	fatalError(SAXParseException exception) Implementation of SAX ErrorHandler.fatalError
Collection<RioSetting<Boolean>>	getCompulsoryXmlFeatureSettings() Returns a collection of settings that will always be set as XML parser features using XMLReader.setFeature(String, boolean).
Collection<RioSetting<?>>	getCompulsoryXmlPropertySettings() Returns a collection of settings that will always be set as XML parser properties using XMLReader.setProperty(String, Object)
Collection<RioSetting<Boolean>>	getOptionalXmlFeatureSettings() Returns a collection of settings that will be used, if set in RDFParserBase.getParserConfig(), as XML parser features using XMLReader.setFeature(String, boolean).
Collection<RioSetting<?>>	getOptionalXmlPropertySettings() Returns a collection of settings that will be used, if set in RDFParserBase.getParserConfig(), as XML parser properties using XMLReader.setProperty(String, Object)
boolean	getParseStandAloneDocuments() Returns whether the parser is currently in a mode to parse stand-alone RDF documents.
RDFFormat	getRDFFormat() Gets the RDF format that this parser can parse.
SAXResult	getSAXResult(String baseURI)
Collection<RioSetting<?>>	getSupportedSettings()
void	parse(InputStream in, String baseURI) Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.
void	parse(Reader reader, String baseURI) Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.
protected void	reportError(String msg, RioSetting<Boolean> setting) Overrides RDFParserBase.reportError(String, RioSetting), adding line- and column number information to the error.
protected void	reportFatalError(Exception e) Overrides RDFParserBase.reportFatalError(Exception), adding line- and column number information to the error.
protected void	reportFatalError(String msg) Overrides RDFParserBase.reportFatalError(String), adding line- and column number information to the error.
protected void	reportWarning(String msg) Overrides RDFParserBase.reportWarning(String), adding line- and column number information to the error.
protected void	setBaseURI(ParsedURI baseURI) Sets the base URI for resolving relative URIs.
void	setParseStandAloneDocuments(boolean standAloneDocs) Sets the parser in a mode to parse stand-alone RDF documents.
void	warning(SAXParseException exception) Implementation of SAX ErrorHandler.warning

Methods inherited from class org.openrdf.rio.helpers.RDFParserBase

clear, clearBNodeIDMap, createBNode, createLiteral, createStatement, createStatement, createURI, datatypeHandling, getNamespace, getParseErrorListener, getParseLocationListener, getParserConfig, getRDFHandler, initializeNamespaceTableFromConfiguration, preserveBNodeIDs, reportError, reportError, reportFatalError, reportFatalError, reportLocation, reportWarning, resolveURI, setBaseURI, setDatatypeHandling, setNamespace, setParseErrorListener, setParseLocationListener, setParserConfig, setPreserveBNodeIDs, setRDFHandler, setStopAtFirstError, setValueFactory, setVerifyData, stopAtFirstError, verifyData

Methods inherited from class java.lang.Object

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

Constructor Detail

RDFXMLParser

public RDFXMLParser()

Creates a new RDFXMLParser that will use a ValueFactoryImpl to create RDF model objects.

RDFXMLParser

public RDFXMLParser(ValueFactory valueFactory)

Creates a new RDFXMLParser that will use the supplied ValueFactory to create RDF model objects.

Parameters:

valueFactory - A ValueFactory.

Method Detail

getRDFFormat

public final RDFFormat getRDFFormat()

Description copied from interface: RDFParser

Gets the RDF format that this parser can parse.

Specified by:

getRDFFormat in interface RDFParser

setParseStandAloneDocuments

public void setParseStandAloneDocuments(boolean standAloneDocs)

Sets the parser in a mode to parse stand-alone RDF documents. In stand-alone RDF documents, the enclosing rdf:RDF root element is optional if this root element contains just one element (e.g. rdf:Description.

getParseStandAloneDocuments

public boolean getParseStandAloneDocuments()

Returns whether the parser is currently in a mode to parse stand-alone RDF documents.

See Also:

setParseStandAloneDocuments(boolean)

parse

public void parse(InputStream in,
                  String baseURI)
           throws IOException,
                  RDFParseException,
                  RDFHandlerException

Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.

Specified by:

parse in interface RDFParser

Parameters:

in - The InputStream from which to read the data, must not be null.

baseURI - The URI associated with the data in the InputStream, must not be null.

Throws:

IOException - If an I/O error occurred while data was read from the InputStream.

RDFParseException - If the parser has found an unrecoverable parse error.

RDFHandlerException - If the configured statement handler encountered an unrecoverable error.

IllegalArgumentException - If the supplied input stream or base URI is null.

parse

public void parse(Reader reader,
                  String baseURI)
           throws IOException,
                  RDFParseException,
                  RDFHandlerException

Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.

Specified by:

parse in interface RDFParser

Parameters:

reader - The Reader from which to read the data, must not be null.

baseURI - The URI associated with the data in the InputStream, must not be null.

Throws:

IOException - If an I/O error occurred while data was read from the InputStream.

RDFParseException - If the parser has found an unrecoverable parse error.

RDFHandlerException - If the configured statement handler has encountered an unrecoverable error.

IllegalArgumentException - If the supplied reader or base URI is null.

getCompulsoryXmlPropertySettings

public Collection<RioSetting<?>> getCompulsoryXmlPropertySettings()

Returns a collection of settings that will always be set as XML parser properties using XMLReader.setProperty(String, Object)

Subclasses can override this to specify more supported settings.

Returns:

A collection of RioSettings that indicate which properties will always be setup using XMLReader.setProperty(String, Object).

getCompulsoryXmlFeatureSettings

public Collection<RioSetting<Boolean>> getCompulsoryXmlFeatureSettings()

Returns a collection of settings that will always be set as XML parser features using XMLReader.setFeature(String, boolean).

Subclasses can override this to specify more supported settings.

Returns:

A collection of RioSettings that indicate which boolean settings will always be setup using XMLReader.setFeature(String, boolean).

getOptionalXmlPropertySettings

public Collection<RioSetting<?>> getOptionalXmlPropertySettings()

Returns a collection of settings that will be used, if set in RDFParserBase.getParserConfig(), as XML parser properties using XMLReader.setProperty(String, Object)

Subclasses can override this to specify more supported settings.

Returns:

A collection of RioSettings that indicate which properties can be setup using XMLReader.setProperty(String, Object).

getOptionalXmlFeatureSettings

public Collection<RioSetting<Boolean>> getOptionalXmlFeatureSettings()

Returns a collection of settings that will be used, if set in RDFParserBase.getParserConfig(), as XML parser features using XMLReader.setFeature(String, boolean).

Subclasses can override this to specify more supported settings.

Returns:

A collection of RioSettings that indicate which boolean settings can be setup using XMLReader.setFeature(String, boolean).

getSupportedSettings

public Collection<RioSetting<?>> getSupportedSettings()

Specified by:

getSupportedSettings in interface RDFParser

Overrides:

getSupportedSettings in class RDFParserBase

Returns:

A collection of RioSettings that are supported by this RDFParser.

getSAXResult

public SAXResult getSAXResult(String baseURI)

setBaseURI

protected void setBaseURI(ParsedURI baseURI)

Description copied from class: RDFParserBase

Sets the base URI for resolving relative URIs.

Overrides:

setBaseURI in class RDFParserBase

createBNode

protected BNode createBNode(String nodeID)
                     throws RDFParseException

Description copied from class: RDFParserBase

Creates a BNode object for the specified identifier.

Overrides:

createBNode in class RDFParserBase

Throws:

RDFParseException

createLiteral

protected Literal createLiteral(String label,
                                String lang,
                                URI datatype)
                         throws RDFParseException

Description copied from class: RDFParserBase

Creates a Literal object with the supplied parameters.

Overrides:

createLiteral in class RDFParserBase

Throws:

RDFParseException

reportWarning

protected void reportWarning(String msg)

Overrides RDFParserBase.reportWarning(String), adding line- and column number information to the error.

Overrides:

reportWarning in class RDFParserBase

reportError

protected void reportError(String msg,
                           RioSetting<Boolean> setting)
                    throws RDFParseException

Overrides RDFParserBase.reportError(String, RioSetting), adding line- and column number information to the error.

Overrides:

reportError in class RDFParserBase

Parameters:

msg - The message to use for ParseErrorListener.error(String, int, int) and for RDFParseException.RDFParseException(String, int, int).

setting - The boolean setting that will be checked to determine if this is an issue that we need to look at at all. If this setting is true, then the error listener will receive the error, and if ParserConfig.isNonFatalError(RioSetting) returns true an exception will be thrown.

Throws:

RDFParseException - If RioConfig.get(RioSetting) returns true, and ParserConfig.isNonFatalError(RioSetting) returns true for the given setting.

reportFatalError

protected void reportFatalError(String msg)
                         throws RDFParseException

Overrides RDFParserBase.reportFatalError(String), adding line- and column number information to the error.

Overrides:

reportFatalError in class RDFParserBase

Throws:

RDFParseException

reportFatalError

protected void reportFatalError(Exception e)
                         throws RDFParseException

Overrides RDFParserBase.reportFatalError(Exception), adding line- and column number information to the error.

Overrides:

reportFatalError in class RDFParserBase

Throws:

RDFParseException

warning

public void warning(SAXParseException exception)
             throws SAXException

Implementation of SAX ErrorHandler.warning

Specified by:

warning in interface ErrorHandler

Throws:

SAXException

error

public void error(SAXParseException exception)
           throws SAXException

Implementation of SAX ErrorHandler.error

Specified by:

error in interface ErrorHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException

Implementation of SAX ErrorHandler.fatalError

Specified by:

fatalError in interface ErrorHandler

Throws:

SAXException