Class TurtleParser

java.lang.Object

org.eclipse.rdf4j.rio.helpers.AbstractRDFParser

org.eclipse.rdf4j.rio.turtle.TurtleParser

All Implemented Interfaces:

RDFParser

Direct Known Subclasses:

N3Parser, TriGParser, TurtleStarParser

public class TurtleParser
extends AbstractRDFParser

RDF parser for RDF-1.1 Turtle files. This parser is not thread-safe, therefore its public methods are synchronized.

Normalization of integer, floating point and boolean values is dependent on the specified datatype handling. According to the specification, integers and booleans should be normalized, but floats don't.

Comments can be used anywhere in the document, and extend to the end of the line. The Turtle grammar doesn't allow comments to be used inside triple constructs that extend over multiple lines, but the author's own parser deviates from this too.

Author:

Arjohn Kampman, Peter Ansell

Field Summary

Fields

Modifier and Type	Field	Description
protected Value	object
protected IRI	predicate
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
TurtleParser()	Creates a new TurtleParser that will use a SimpleValueFactory to create RDF model objects.
TurtleParser(ValueFactory valueFactory)	Creates a new TurtleParser that will use the supplied ValueFactory to create RDF model objects.

Method Summary

Modifier and Type	Method	Description
protected int	getLineNumber()
RDFFormat	getRDFFormat()	Gets the RDF format that this parser can parse.
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	parseAnnotation()
protected void	parseBase()
protected Resource	parseCollection()	Parses a collection, e.g.
protected void	parseDirective(String directive)
protected Resource	parseImplicitBlank()	Parses an implicit blank node.
protected String	parseLongString(int closingCharacter)	Parses a """long string""".
protected Resource	parseNodeID()	Parses a blank node ID, e.g.
protected Literal	parseNumber()
protected void	parseObject()	Parse an object
protected void	parseObjectList()
protected IRI	parsePredicate()
protected void	parsePredicateObjectList()
protected void	parsePrefixID()
protected Value	parseQNameOrBoolean()	Parses qnames and boolean values, which have equivalent starting characters.
protected Literal	parseQuotedLiteral()	Parses a quoted string, optionally followed by a language tag or datatype.
protected String	parseQuotedString()	Parses a quoted string, which is either a "normal string" or a """long string""".
protected void	parseStatement()
protected String	parseString(int closingCharacter)	Parses a "normal string".
protected void	parseSubject()
protected void	parseTriples()
protected Triple	parseTripleValue()	Parser an RDF-star triple value and returns it.
protected IRI	parseURI()
protected Value	parseValue()	Parses an RDF value.
protected int	peekCodePoint()	Peeks at the next Unicode code point without advancing the reader, and returns its value.
protected boolean	peekIsTripleValue()	Peeks at the next two Unicode code points without advancing the reader and returns true if they indicate the start of an RDF-star triple value.
protected void	processComment()	Consumes characters from reader until the first EOL has been read.
protected int	readCodePoint()	Reads the next Unicode code point.
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	reportLocation()
protected void	reportStatement(Resource subj, IRI pred, Value obj)
protected void	reportWarning(String msg)	Overrides AbstractRDFParser.reportWarning(String), adding line number information to the error.
protected int	skipWSC()	Consumes any white space characters (space, tab, line feed, newline) and comments (#-style) from reader.
protected void	throwEOFException()
protected void	unread(int codePoint)	Pushes back a single code point by copying it to the front of the buffer.
protected void	unread(String string)	Pushes back the supplied string by copying it to the front of the buffer.
protected void	verifyCharacterOrFail(int codePoint, String expected)	Verifies that the supplied character code point codePoint is one of the expected characters specified in expected.

Methods inherited from class AbstractRDFParser

clear, clearBNodeIDMap, createBNode, createBNode, createLiteral, createLiteral, createLiteral, createNode, createNode, createStatement, createStatement, createURI, getNamespace, getParseErrorListener, getParseLocationListener, getParserConfig, getRDFHandler, initializeNamespaceTableFromConfiguration, preserveBNodeIDs, reportError, 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	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()
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	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

subject

protected Resource subject

predicate

protected IRI predicate

object

protected Value object

Constructor Details

TurtleParser

public TurtleParser()

Creates a new TurtleParser that will use a SimpleValueFactory to create RDF model objects.

TurtleParser

public TurtleParser(ValueFactory valueFactory)

Creates a new TurtleParser 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.

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.

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 IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseDirective

protected void parseDirective(String directive)
                       throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parsePrefixID

protected void parsePrefixID()
                      throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseBase

protected void parseBase()
                  throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseTriples

protected void parseTriples()
                     throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parsePredicateObjectList

protected void parsePredicateObjectList()
                                 throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseObjectList

protected void parseObjectList()
                        throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseSubject

protected void parseSubject()
                     throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parsePredicate

protected IRI parsePredicate()
                      throws IOException,
RDFParseException,
RDFHandlerException

Throws:

IOException

RDFParseException

RDFHandlerException

parseObject

protected void parseObject()
                    throws IOException,
RDFParseException,
RDFHandlerException

Parse an object

Throws:

IOException

RDFParseException

RDFHandlerException

parseCollection

protected Resource parseCollection()
                            throws IOException,
RDFParseException,
RDFHandlerException

Parses a collection, e.g. ( item1 item2 item3 ).

Throws:

IOException

RDFParseException

RDFHandlerException

parseImplicitBlank

protected Resource parseImplicitBlank()
                               throws IOException,
RDFParseException,
RDFHandlerException

Parses an implicit blank node. This method parses the token [] and predicateObjectLists that are surrounded by square brackets.

Throws:

IOException

RDFParseException

RDFHandlerException

parseValue

protected Value parseValue()
                    throws IOException,
RDFParseException,
RDFHandlerException

Parses an RDF value. This method parses uriref, qname, node ID, quoted literal, integer, double and boolean.

Throws:

IOException

RDFParseException

RDFHandlerException

parseQuotedLiteral

protected Literal parseQuotedLiteral()
                              throws IOException,
RDFParseException,
RDFHandlerException

Parses a quoted string, optionally followed by a language tag or datatype.

Throws:

IOException

RDFParseException

RDFHandlerException

parseQuotedString

protected String parseQuotedString()
                            throws IOException,
RDFParseException

Parses a quoted string, which is either a "normal string" or a """long string""".

Returns:

string

Throws:

IOException

RDFParseException

parseString

protected String parseString(int closingCharacter)
                      throws IOException,
RDFParseException

Parses a "normal string". This method requires that the opening character has already been parsed.

Returns:

parsed string

Throws:

IOException

RDFParseException

parseLongString

protected String parseLongString(int closingCharacter)
                          throws IOException,
RDFParseException

Parses a """long string""". This method requires that the first three characters have already been parsed.

Throws:

IOException

RDFParseException

parseNumber

protected Literal parseNumber()
                       throws IOException,
RDFParseException

Throws:

IOException

RDFParseException

parseURI

protected IRI parseURI()
                throws IOException,
RDFParseException

Throws:

IOException

RDFParseException

parseQNameOrBoolean

protected Value parseQNameOrBoolean()
                             throws IOException,
RDFParseException

Parses qnames and boolean values, which have equivalent starting characters.

Throws:

IOException

RDFParseException

parseNodeID

protected Resource parseNodeID()
                        throws IOException,
RDFParseException

Parses a blank node ID, e.g. _:node1.

Throws:

IOException

RDFParseException

reportStatement

protected void reportStatement(Resource subj,
 IRI pred,
 Value obj)
                        throws RDFParseException,
RDFHandlerException

Throws:

RDFParseException

RDFHandlerException

verifyCharacterOrFail

protected void verifyCharacterOrFail(int codePoint,
 String expected)
                              throws RDFParseException

Verifies that the supplied character code point codePoint is one of the expected characters specified in expected. This method will throw a ParseException if this is not the case.

Throws:

RDFParseException

skipWSC

protected int skipWSC()
               throws IOException,
RDFHandlerException

Consumes any white space characters (space, tab, line feed, newline) and comments (#-style) from reader. After this method has been called, the first character that is returned by reader is either a non-ignorable character, or EOF. For convenience, this character is also returned by this method.

Returns:

The next character code point that will be returned by reader.

Throws:

IOException

RDFHandlerException

processComment

protected void processComment()
                       throws IOException,
RDFHandlerException

Consumes characters from reader until the first EOL has been read. This line of text is then passed to the AbstractRDFParser.rdfHandler as a comment.

Throws:

IOException

RDFHandlerException

readCodePoint

protected int readCodePoint()
                     throws IOException

Reads the next Unicode code point.

Returns:

the next Unicode code point, or -1 if the end of the stream has been reached.

Throws:

IOException

unread

protected void unread(int codePoint)
               throws IOException

Pushes back a single code point by copying it to the front of the buffer. After this method returns, a call to readCodePoint() will return the same code point c again.

Parameters:

codePoint - a single Unicode code point.

Throws:

IOException

unread

protected void unread(String string)
               throws IOException

Pushes back the supplied string by copying it to the front of the buffer. After this method returns, successive calls to readCodePoint() will return the code points in the supplied string again, starting at the first in the String..

Parameters:

string - the string to un-read.

Throws:

IOException

peekCodePoint

protected int peekCodePoint()
                     throws IOException

Peeks at the next Unicode code point without advancing the reader, and returns its value.

Returns:

the next Unicode code point, or -1 if the end of the stream has been reached.

Throws:

IOException

reportLocation

protected void reportLocation()

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.

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

getLineNumber

protected int getLineNumber()

peekIsTripleValue

protected boolean peekIsTripleValue()
                             throws IOException

Peeks at the next two Unicode code points without advancing the reader and returns true if they indicate the start of an RDF-star triple value. Such values start with 'invalid input: '<'invalid input: '<''.

Returns:

true if the next code points indicate the beginning of an RDF-star triple value, false otherwise

Throws:

IOException

parseTripleValue

protected Triple parseTripleValue()
                           throws IOException

Parser an RDF-star triple value and returns it.

Returns:

An RDF-star triple.

Throws:

IOException

parseAnnotation

protected void parseAnnotation()
                        throws IOException

Throws:

IOException