Class NTriplesParser

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFParser

org.eclipse.rdf4j.rio.ntriples.NTriplesParser

All Implemented Interfaces:

RDFParser

Direct Known Subclasses:

NQuadsParser

public class NTriplesParser
extends AbstractRDFParser

RDF parser for N-Triples files. A specification of NTriples can be found in this section of the RDF Test Cases document. This parser is not thread-safe, therefore its public methods are synchronized.

Author:

Arjohn Kampman

Field Summary

Fields

Modifier and Type	Field	Description
protected int	currentIndex
protected char[]	lineChars
protected long	lineNo
protected Value	object
protected IRI	predicate
protected BufferedReader	reader
protected Resource	subject

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

Constructor	Description
NTriplesParser()	Creates a new NTriplesParser that will use a SimpleValueFactory to create object for resources, bNodes and literals.
NTriplesParser(ValueFactory valueFactory)	Creates a new NTriplesParser that will use the supplied ValueFactory to create RDF model objects.

Method Summary

Modifier and Type	Method	Description
protected void	assertLineTerminates()	Verifies that there is only whitespace or comments until the end of the line.
protected void	clear()	Clears any information that has been collected while parsing.
protected IRI	createURI(String uri)	Creates a IRI object for the specified URI-string.
RDFFormat	getRDFFormat()	Gets the RDF format that this parser can parse.
Collection<RioSetting<?>>	getSupportedSettings()
protected void	handleStatement(boolean ignoredAnError)
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 IRI	parseIRI()
protected Resource	parseNode()
protected void	parseObject()
protected void	parsePredicate()
protected void	parseStatement()
protected void	parseSubject()
protected void	reportError(Exception e, RioSetting<Boolean> setting)	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> setting)	Overrides AbstractRDFParser.reportError(String, RioSetting), adding line number information to the error.
protected void	reportFatalError(Exception e)	Overrides AbstractRDFParser.reportFatalError(Exception), adding line number information to the error.
protected void	reportFatalError(String msg)	Overrides AbstractRDFParser.reportFatalError(String), adding line number information to the error.
protected void	reportWarning(String msg)	Overrides AbstractRDFParser.reportWarning(String), adding line number information to the error.
protected boolean	shouldParseLine()
protected void	skipWhitespace(boolean throwEOF)
protected void	throwEOFException()

Methods inherited from class AbstractRDFParser

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

Modifier and Type	Method	Description
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 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()
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(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	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, 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, 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

parse, parse

Modifier and Type	Method	Description
default void	parse(InputStream in)	Parses the data from the supplied InputStream.
default void	parse(Reader reader)	Parses the data from the supplied Reader.

Field Details

reader

protected BufferedReader reader

lineChars

protected char[] lineChars

currentIndex

protected int currentIndex

lineNo

protected long lineNo

subject

protected Resource subject

predicate

protected IRI predicate

object

protected Value object

Constructor Details

NTriplesParser

public NTriplesParser()

Creates a new NTriplesParser that will use a SimpleValueFactory to create object for resources, bNodes and literals.

NTriplesParser

public NTriplesParser(ValueFactory valueFactory)

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

Parameters:

valueFactory - A ValueFactory.

Method Details

getRDFFormat

public RDFFormat getRDFFormat()

Description copied from interface: RDFParser

Gets the RDF format that this parser can parse.

parse

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

Description copied from interface: RDFParser

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

Parameters:

in - The InputStream from which to read the data.

baseURI - The URI associated with the data in the InputStream. May be null. Parsers for syntax formats that do not support relative URIs will ignore this argument.

Note that if the data contains an embedded base URI, that embedded base URI will overrule the value supplied here (see RFC 3986 section 5.1 for details).

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.

parse

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

Description copied from interface: RDFParser

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

Parameters:

reader - The Reader from which to read the data.

baseURI - The URI associated with the data in the InputStream. May be null. Parsers for syntax formats that do not support relative URIs will ignore this argument.

Note that if the data contains an embedded base URI, that embedded base URI will overrule the value supplied here (see RFC 3986 section 5.1 for details).

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.

parseStatement

protected void parseStatement()
                       throws RDFParseException,
RDFHandlerException

Throws:

RDFParseException

RDFHandlerException

skipWhitespace

protected void skipWhitespace(boolean throwEOF)

shouldParseLine

protected boolean shouldParseLine()

parseSubject

protected void parseSubject()

parsePredicate

protected void parsePredicate()

parseObject

protected void parseObject()

assertLineTerminates

protected void assertLineTerminates()
                             throws RDFParseException

Verifies that there is only whitespace or comments until the end of the line.

Throws:

RDFParseException

handleStatement

protected void handleStatement(boolean ignoredAnError)

parseIRI

protected IRI parseIRI()

parseNode

protected Resource parseNode()

createURI

protected IRI createURI(String uri)
                 throws RDFParseException

Description copied from class: AbstractRDFParser

Creates a IRI object for the specified URI-string.

Overrides:

createURI in class AbstractRDFParser

Throws:

RDFParseException

reportWarning

protected void reportWarning(String msg)

Overrides AbstractRDFParser.reportWarning(String), adding line number information to the error.

Overrides:

reportWarning in class AbstractRDFParser

reportError

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

Overrides AbstractRDFParser.reportError(String, RioSetting), adding line number information to the error.

Overrides:

reportError in class AbstractRDFParser

Parameters:

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

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.

reportError

protected void reportError(Exception e,
 RioSetting<Boolean> setting)
                    throws RDFParseException

Description copied from class: AbstractRDFParser

Reports an error with associated line- and column number to the registered ParseErrorListener, if the given setting has been set to true.

This method also throws an RDFParseException when the given setting has been set to true and it is not a nonFatalError.

Overrides:

reportError in class AbstractRDFParser

Parameters:

e - The exception whose message will be used for ParseErrorListener.error(String, long, long) and for RDFParseException(String, long, long) .

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 AbstractRDFParser.reportFatalError(String), adding line number information to the error.

Overrides:

reportFatalError in class AbstractRDFParser

Throws:

RDFParseException

reportFatalError

protected void reportFatalError(Exception e)
                         throws RDFParseException

Overrides AbstractRDFParser.reportFatalError(Exception), adding line number information to the error.

Overrides:

reportFatalError in class AbstractRDFParser

Throws:

RDFParseException

throwEOFException

protected void throwEOFException()
                          throws RDFParseException

Throws:

RDFParseException

clear

protected void clear()

Description copied from class: AbstractRDFParser

Clears any information that has been collected while parsing. This method must be called by subclasses when finishing the parse process.

Overrides:

clear in class AbstractRDFParser

getSupportedSettings

public Collection<RioSetting<?>> getSupportedSettings()

Specified by:

getSupportedSettings in interface RDFParser

Overrides:

getSupportedSettings in class AbstractRDFParser

Returns:

A collection of RioSettings that are supported by this RDFParser.