RDF Interfaces

Attributes

object of type RDFNode, readonly

The object associated with the Triple.

predicate of type RDFNode, readonly

The predicate associated with the Triple.

subject of type RDFNode, readonly

The subject associated with the Triple.

Methods

equals

Returns true if otherTriple is equivalent to this triple.

Parameter	Type	Nullable	Optional	Description
otherTriple	Triple	✘	✘	The Triple to test for equivalence with this Triple.

Return type: boolean

toString

Converts this triple into a string in N-Triples notation.

No parameters.

Return type: stringifier DOMString

Attributes

actions of type sequence<TripleAction>, readonly

An array of actions to run when a Triple is added to the graph, each new triple is passed to the run method of each TripleAction in the array.

length of type unsigned long, readonly

A non-negative integer that specifies the number of Triples in the set.

Methods

add

Adds the specified Triple to the graph. This method returns the graph instance it was called on.

Parameter	Type	Nullable	Optional	Description
triple	Triple	✘	✘	The Triple to add. Graphs must not contain duplicate triples.

Return type: Graph

addAction

Adds a new TripleAction to the array of actions, if the run argument is specified as true then each Triple in the Graph must be passed to the TripleAction before this method returns.

Parameter	Type	Nullable	Optional	Description
action	TripleAction	✘	✘	The TripleAction to add.
run	boolean	✘	✔	A boolean flag specifying whether all triples in the graph should immediately be tried by the action.

Return type: Graph

addAll

Imports the graph in to this graph. This method returns the graph instance it was called on.

This method differes from Graph.merge in that it adds all triples from graph to the current instance, rather than combining the two graphs to create a new instance.

Parameter	Type	Nullable	Optional	Description
graph	Graph	✘	✘	The Graph to import in to this graph, the import must not produce any duplicates.

Return type: Graph

every

Universal quantification method, tests whether every Triple in the Graph passes the test implemented by the provided TripleFilter.

This method will return boolean false when the first Triple is found that does not pass the test.

Note: this method is aligned with Array.prototype.every() in ECMAScript-262.

Parameter	Type	Nullable	Optional	Description
callback	TripleFilter	✘	✘	The TripleFilter to test each Triple in the Graph against.

Return type: boolean

filter

Creates a new Graph with all the Triples which pass the test implemented by the provided TripleFilter.

Note: this method is aligned with Array.prototype.filter() in ECMAScript-262.

Parameter	Type	Nullable	Optional	Description
filter	TripleFilter	✘	✘	The TripleFilter to test each Triple in the Graph against.

Return type: Graph

forEach

Executes the provided TripleCallback once on each Triple in the Graph.

Note: this method is aligned with Array.prototype.forEach() in ECMAScript-262.

Parameter	Type	Nullable	Optional	Description
callback	TripleCallback	✘	✘	The TripleCallback to execute for each Triple.

Return type: void

match

This method returns a new Graph which is comprised of all those triples in the current instance which match the given arguments, that is, for each triple in this graph, it is included in the output graph, if:

• calling triple.subject.equals with the specified subject as an argument returns true, or the subject argument is null, AND
• calling triple.predicate.equals with the specified predicate as an argument returns true, or the predicate argument is null, AND
• calling triple.object.equals with the specified object as an argument returns true, or the object argument is null

This method implements AND functionality, so only triples matching all of the given non-null arguments will be included in the result.

Note, this method always returns a new Graph, even if that Graph contains no Triples.

Note, Graphs represent Sets of Triples, the order is arbitrary, so this method may result in differing results when called repeatedly with a limit.

Parameter	Type	Nullable	Optional	Description
subject	any	✔	✘	The subject value to match against, may be null.
predicate	any	✔	✘	The predicate value to match against, may be null.
object	any	✔	✘	The object value to match against, may be null.
limit	unsigned long	✘	✔	An optional limit to the amount of triples returned, if 0 is passed or the argument is set to null then all matching triples will be contained in the resulting graph.

Return type: Graph

merge

Returns a new Graph which is a concatenation of this graph and the graph given as an argument.

Parameter	Type	Nullable	Optional	Description
graph	Graph	✘	✘	The Graph to concatenate with this graph, the resulting Graph must not contain any duplicates.

Return type: Graph

remove

Removes the specified Triple from the graph. This method returns the graph instance it was called on.

Parameter	Type	Nullable	Optional	Description
triple	Triple	✘	✘	The Triple to remove.

Return type: Graph

removeMatches

This method removes those triples in the current instance which match the given arguments, that is, for each triple in this graph, it is removed, if:

• calling triple.subject.equals with the specified subject as an argument returns true, or the subject argument is null, AND
• calling triple.predicate.equals with the specified predicate as an argument returns true, or the predicate argument is null, AND
• calling triple.object.equals with the specified object as an argument returns true, or the object argument is null

Parameter	Type	Nullable	Optional	Description
subject	any	✔	✘	The subject value to match against, may be null.
predicate	any	✔	✘	The predicate value to match against, may be null.
object	any	✔	✘	The object value to match against, may be null.

Return type: Graph

some

Existential quantification method, tests whether some Triple in the Graph passes the test implemented by the provided TripleFilter.

This method will return boolean true when the first Triple is found that passes the test.

Note: this method is aligned with Array.prototype.some() in ECMAScript-262.

Parameter	Type	Nullable	Optional	Description
callback	TripleFilter	✘	✘	The TripleFilter to test each Triple in the Graph against.

Return type: boolean

toArray

Returns the set of Triples within the Graph as a host language native sequence, for example an Array in ECMAScript-262.

Note: a sequence in [WEBIDL] is passed by value, not by reference.

Note: the order of the Triples within the returned sequence is arbitrary, since a Graph is an unordered set.

No parameters.

Return type: sequence<Triple>

Attributes

interfaceName of type DOMString, readonly

Provides access to the string name of the current interface, normally one of "NamedNode", "BlankNode" or "Literal".

This method serves to disambiguate instances of RDFNode which are otherwise identical, such as NamedNode and BlankNode.

nominalValue of type any, readonly

The nominalValue of an RDFNode is refined by each interface which extends RDFNode.

Methods

equals

If tocompare is an instance of RDFNode then this method returns true if an only if all attributes on the two interfaces are equivalent.

If tocompare is NOT an instance of RDFNode then the it must be compared against the result of calling toValue on this node.

You cannot simply test two RDF Nodes for equivalence using general language constructs such as ==.

Parameter	Type	Nullable	Optional	Description
tocompare	any	✘	✘	The value to test for equivalence with this node.

Return type: boolean

toNT

Returns the N-Triples representation of the RDFNode as defined by [RDF-TESTCASES].

No parameters.

Return type: DOMString

toString

The stringification of an RDFNode is defined as follows, if the interfaceName is

• NamedNode then return the stringified nominalValue.
• BlankNode then prepend "_:" to the stringified value and return the result.
• Literal then return the stringified nominalValue.

No parameters.

Return type: DOMString

valueOf

This method provides access to the implementations host environment native value for this RDFNode, if the interfaceName is

• NamedNode or BlankNode then return the stringified nominalValue.
• Literal then return the language native value for this node where supported, or the stringified nominalValue if the datatype of the Literal is unknown or the value is out of the range supported. See the definition of Literal for further guidance.

No parameters.

Return type: any

Attributes

nominalValue of type any, readonly

The IRI identifier of the node.

Attributes

nominalValue of type any, readonly

The temporary identifier of the BlankNode, the nominalValue may be of any type, so long as it is unique and can be stringified, for instance a number or a string.

The nominalValue must not be relied upon in any way between two separate processing runs of the same document, or two instances of Graph containing "the same" triples.

Attributes

datatype of type NamedNode, readonly, nullable

An optional datatype identified by a NamedNode.

language of type DOMString, readonly, nullable

An optional language string as defined in [BCP47], normalized to lowercase.

nominalValue of type DOMString, readonly

The lexical representation of the Literals value.

Methods

valueOf

This method provides access to a corresponding host environment specific native value, where one exists.

If the datatype identifier of the Literal is not known by the implementation, or the value is outside of the range handled by the corresponding native type, then valueOf must return the DOMString lexical representation of the nominalValue.

No parameters.

Return type: any

Attributes

processorGraph of type Graph, readonly

An optional Graph produced by RDF Parsers containing additional parsing information and errors.

Methods

parse

Parses the triples serialized within an input RDF document in to a Graph, then executes a given ParserCallback on the populated Graph.

If a TripleFilter is passed to the parser, then each Triple found in the document will only be added to the output Graph if it passes the test implemented by the TripleFilter.

By default a new Graph is provided, however users may optionally specify a Graph to which the parsed triples will be added. This allows users to provide a custom or persistent Graph implementation, or to automatically merge the triples from several documents in to a single Graph.

A boolean response is given indicating if the parse was successful or not.

Parameter	Type	Nullable	Optional	Description
toparse	any	✘	✘	The document to parse, the type of argument required may further be constrained by implementations of this interface, for instance an RDFa parser may require an instance of Document, whilst a Turtle parser may require a String.
callback	ParserCallback	✔	✘	The ParserCallback to execute once the parse has completed, the ParserCallback will be passed a single argument which is the propulated Graph.
base	DOMString	✘	✔	An optional base to be used by the parser when resolving relative IRI references.
filter	TripleFilter	✘	✔	An optional TripleFilter to test each Triple against before adding to the output Graph, only those triples successfully passing the test will be added to the output graph.
graph	Graph	✘	✔	An optional Graph to add the parsed triples to, if no Graph is provided then a new, empty, Graph will be used.

Return type: boolean

process

Parses the triples serialized within an input RDF document and passes each (non filtered) Triple found to a TripleCallback, this interface allows RDF documents to be processed by SAX-like parsers whilst maintaining a minimal memory footprint.

If a TripleFilter is passed to the parser, then each Triple found in the document will only be passed to the TripleCallback if it passes the test implmented by the filter.

Parameter	Type	Nullable	Optional	Description
toparse	any	✘	✘	The document to parse, the type of argument required may further be constrained by implementations of this interface, for instance an RDFa parser may require an instance of Document, whilst a Turtle parser may require a String.
callback	ProcessorCallback	✘	✘	The ProcessorCallback to execute on each (non-filtered) Triple found by the parser.
base	DOMString	✘	✔	An optional base to be used by the parser when resolving relative IRI references.
filter	TripleFilter	✘	✔	An optional TripleFilter to test each Triple against before adding to the output Graph, only those triples successfully passing the test will be added to the output graph.

Return type: boolean

Examples

Example of basic and advanced DataParser.parse usage:

// basic usage
turtle.parse(doc, function(graph) {
  // work with graph here ..
});

// advanced usage, retrieve a graph containing only those triples
// with a subject of "<http://example.org/bob#me>"
var filter = function(t) { // create a filter
  return t.subject.equals( "http://example.org/bob#me" );
};
var parsercb = function(graph) {
  // work with graph here
};
turtle.parse(doc, parsercb, "http://example.org/bob", filter);

Example of basic and advanced DataParser.process usage:

// basic usage
turtle.process(doc, function(t) {
  // work with triples here ..
});

// advanced usage, process only those triples with a predicate of rdf:type
var filter = function(t) { // create a filter
  return t.predicate.equals( rdf.resolve("rdf:type") );
};
var processor = function(t) {
  // work with triples here
};
turtle.process(doc, processor, "http://example.org/bob", filter);

Methods

serialize

A method, which when called will serialize the given Graph and return the resulting serialization.

Parameter	Type	Nullable	Optional	Description
graph	Graph	✘	✘

Return type: any

Methods

run

A function to be executed on a Graph produced by a parse operation on an RDF Document.

Parameter	Type	Nullable	Optional	Description
graph	Graph	✘	✘

Return type: void

Methods

run

A function to be executed on a Triple produced by a process operation on an RDF Document.

Parameter	Type	Nullable	Optional	Description
triple	Triple	✘	✘

Return type: void