Class XMLReaderBasedParser

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFParser

org.eclipse.rdf4j.rio.helpers.XMLReaderBasedParser

All Implemented Interfaces:

RDFParser

Direct Known Subclasses:

RDFXMLParser, TriXParser

public abstract class XMLReaderBasedParser
extends AbstractRDFParser

Base class for Rio parsers that are based on a SAX XMLReader.

Author:

Jeen Broekstra

Field Summary

Fields inherited from class AbstractRDFParser

rdfHandler, valueFactory

Modifier and Type	Field	Description
protected RDFHandler	rdfHandler	The RDFHandler that will handle the parsed RDF.
protected ValueFactory	valueFactory	The ValueFactory to use for creating RDF model objects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XMLReaderBasedParser(ValueFactory f)

Method Summary

Modifier and Type	Method	Description
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 AbstractRDFParser.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 AbstractRDFParser.getParserConfig(), as XML parser properties using XMLReader.setProperty(String, Object)
protected XMLReader	getXMLReader()	Creates an XML Reader configured using the current parser settings.

Methods inherited from class AbstractRDFParser

clear, clearBNodeIDMap, createBNode, createBNode, createLiteral, createLiteral, createLiteral, createNode, createNode, createStatement, createStatement, createURI, getNamespace, getParseErrorListener, getParseLocationListener, getParserConfig, getRDFHandler, getSupportedSettings, initializeNamespaceTableFromConfiguration, preserveBNodeIDs, reportError, reportError, reportError, reportError, reportError, reportFatalError, reportFatalError, reportFatalError, reportFatalError, reportFatalError, reportLocation, reportWarning, reportWarning, resolveURI, set, setBaseURI, setBaseURI, setNamespace, setParseErrorListener, setParseLocationListener, setParserConfig, setPreserveBNodeIDs, setRDFHandler, setValueFactory

Modifier and Type	Method	Description
protected void	clear()	Clears any information that has been collected while parsing.
protected void	clearBNodeIDMap()	Deprecated. Map is no longer used, call AbstractRDFParser.clear() instead.
protected BNode	createBNode()	Deprecated.
protected BNode	createBNode(String nodeID)	Deprecated.
protected Literal	createLiteral(String label, String lang, CoreDatatype datatype, long lineNo, long columnNo)	Creates a Literal object with the supplied parameters, using the lineNo and columnNo to enhance error messages or exceptions that may be generated during the creation of the literal.
protected Literal	createLiteral(String label, String lang, IRI datatype)	Creates a Literal object with the supplied parameters.
protected Literal	createLiteral(String label, String lang, IRI datatype, long lineNo, long columnNo)	Creates a Literal object with the supplied parameters, using the lineNo and columnNo to enhance error messages or exceptions that may be generated during the creation of the literal.
protected Resource	createNode()	Creates a new BNode or Skolem IRI object.
protected Resource	createNode(String nodeID)	Creates a BNode or Skolem IRI object for the specified identifier.
protected Statement	createStatement(Resource subj, IRI pred, Value obj)	Creates a new Statement object with the supplied components.
protected Statement	createStatement(Resource subj, IRI pred, Value obj, Resource context)	Creates a new Statement object with the supplied components.
protected IRI	createURI(String uri)	Creates a IRI object for the specified URI-string.
protected String	getNamespace(String prefix)	Gets the namespace that is associated with the specified prefix or throws an RDFParseException.
ParseErrorListener	getParseErrorListener()
ParseLocationListener	getParseLocationListener()
ParserConfig	getParserConfig()	Retrieves the current parser configuration as a single object.
RDFHandler	getRDFHandler()
Collection<RioSetting<?>>	getSupportedSettings()
protected void	initializeNamespaceTableFromConfiguration()
boolean	preserveBNodeIDs()
protected void	reportError(Exception e, long lineNo, long columnNo, RioSetting<Boolean> relevantSetting)	Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.
protected void	reportError(Exception e, RioSetting<Boolean> relevantSetting)	Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.
protected void	reportError(String msg, long lineNo, long columnNo, RioSetting<Boolean> relevantSetting)	Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.
protected void	reportError(String msg, Exception e, long lineNo, long columnNo, RioSetting<Boolean> relevantSetting)	Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.
protected void	reportError(String msg, RioSetting<Boolean> relevantSetting)	Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.
protected void	reportFatalError(Exception e)	Reports a fatal error to the registered ParseErrorListener, if any, and throws a ParseException afterwards.
protected void	reportFatalError(Exception e, long lineNo, long columnNo)	Reports a fatal error with associated line- and column number to the registered ParseErrorListener, if any, and throws a ParseException wrapped the supplied exception afterwards.
protected void	reportFatalError(String msg)	Reports a fatal error to the registered ParseErrorListener, if any, and throws a ParseException afterwards.
protected void	reportFatalError(String msg, long lineNo, long columnNo)	Reports a fatal error with associated line- and column number to the registered ParseErrorListener, if any, and throws a ParseException afterwards.
protected void	reportFatalError(String message, Exception e, long lineNo, long columnNo)	Reports a fatal error with associated line- and column number to the registered ParseErrorListener, if any, and throws a ParseException wrapped the supplied exception afterwards.
protected void	reportLocation(long lineNo, long columnNo)	Reports the specified line- and column number to the registered ParseLocationListener, if any.
protected void	reportWarning(String msg)	Reports a warning to the registered ParseErrorListener, if any.
protected void	reportWarning(String msg, long lineNo, long columnNo)	Reports a warning with associated line- and column number to the registered ParseErrorListener, if any.
protected IRI	resolveURI(String uriSpec)	Resolves a URI-string against the base URI and creates a IRI object for it.
<T> RDFParser	set(RioSetting<T> setting, T value)	Set a setting on the parser, and return this parser object to allow chaining.
protected void	setBaseURI(String uriSpec)	Parses the supplied URI-string and sets it as the base URI for resolving relative URIs.
protected void	setBaseURI(ParsedIRI baseURI)	Sets the base URI for resolving relative URIs.
protected void	setNamespace(String prefix, String namespace)	Associates the specified prefix to the specified namespace.
RDFParser	setParseErrorListener(ParseErrorListener el)	Sets the ParseErrorListener that will be notified of any errors that this parser finds during parsing.
RDFParser	setParseLocationListener(ParseLocationListener el)	Sets the ParseLocationListener that will be notified of the parser's progress during the parse process.
RDFParser	setParserConfig(ParserConfig config)	Sets all supplied parser configuration options.
void	setPreserveBNodeIDs(boolean preserveBNodeIDs)	Set whether the parser should preserve bnode identifiers specified in the source (default is false).
RDFParser	setRDFHandler(RDFHandler handler)	Sets the RDFHandler that will handle the parsed RDF data.
RDFParser	setValueFactory(ValueFactory valueFactory)	Sets the ValueFactory that the parser will use to create Value objects for the parsed RDF data.

Methods inherited from class Object

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

Methods inherited from interface RDFParser

getRDFFormat, parse, parse, parse, parse

Modifier and Type	Method	Description
RDFFormat	getRDFFormat()	Gets the RDF format that this parser can parse.
default void	parse(InputStream in)	Parses the data from the supplied InputStream.
void	parse(InputStream in, String baseURI)	Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.
default void	parse(Reader reader)	Parses the data from the supplied Reader.
void	parse(Reader reader, String baseURI)	Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.

Constructor Details

XMLReaderBasedParser

protected XMLReaderBasedParser(ValueFactory f)

Method Details

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 AbstractRDFParser.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 AbstractRDFParser.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).

getXMLReader

protected XMLReader getXMLReader()
                          throws SAXException

Creates an XML Reader configured using the current parser settings.

Returns:

a configured XMLReader

Throws:

SAXException - if an error occurs during configuration.