Class BaseDataset

Abstract Base Class for Datasets which provides implementation of Active and Default Graph management.

Inheritance

object

BaseDataset

BaseImmutableDataset

BaseTransactionalDataset

Implements

ISparqlDataset

ITripleIndex

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VDS.RDF.Query.Datasets

Assembly: dotNetRdf.dll

Syntax

public abstract class BaseDataset : ISparqlDataset, ITripleIndex

Constructors

BaseDataset()

Creates a new Dataset.

Declaration

public BaseDataset()

BaseDataset(bool)

Creates a new Dataset with the given Union Default Graph setting.

Declaration

public BaseDataset(bool unionDefaultGraph)

Parameters

Type	Name	Description
bool	unionDefaultGraph	Whether to use a Union Default Graph.

BaseDataset(Uri)

Creates a new Dataset with a fixed Default Graph and without a Union Default Graph.

Declaration

[Obsolete("Replaced by BaseDataset(IRefNode)")]
public BaseDataset(Uri defaultGraphUri)

Parameters

Type	Name	Description
Uri	defaultGraphUri

BaseDataset(IRefNode)

Creates a new dataset with a fixed default graph and without a union default graph.

Declaration

public BaseDataset(IRefNode defaultGraphName)

Parameters

Type	Name	Description
IRefNode	defaultGraphName	Name to assign to the default graph.

Properties

ActiveGraphNames

Gets the enumeration of the names of the graphs that currently make up the active graph.

Declaration

public IEnumerable<IRefNode> ActiveGraphNames { get; }

Property Value

Type	Description
IEnumerable<IRefNode>

ActiveGraphUris

Gets the Active Graph URIs.

Declaration

[Obsolete("Replaced by ActiveGraphNames. This property does not return the names of any graphs named with a blank node.")]
public IEnumerable<Uri> ActiveGraphUris { get; }

Property Value

Type	Description
IEnumerable<Uri>

DefaultGraphNames

Gets the enumeration of the names of the graphs that currently make up the default graph.

Declaration

public IEnumerable<IRefNode> DefaultGraphNames { get; }

Property Value

Type	Description
IEnumerable<IRefNode>

DefaultGraphUris

Gets the Default Graph URIs.

Declaration

[Obsolete("Replaced by DefaultGraphNames. This property does not return the names of graphs that are named with a blank node.")]
public IEnumerable<Uri> DefaultGraphUris { get; }

Property Value

Type	Description
IEnumerable<Uri>

GraphNames

Gets an enumeration of the names of all graphs in the dataset.

Declaration

public abstract IEnumerable<IRefNode> GraphNames { get; }

Property Value

Type	Description
IEnumerable<IRefNode>

GraphUris

Gets all the URIs of Graphs in the Dataset.

Declaration

[Obsolete("Replaced by GraphNames")]
public virtual IEnumerable<Uri> GraphUris { get; }

Property Value

Type	Description
IEnumerable<Uri>

Graphs

Gets all the Graphs in the Dataset.

Declaration

public abstract IEnumerable<IGraph> Graphs { get; }

Property Value

Type	Description
IEnumerable<IGraph>

HasTriples

Gets whether the Dataset has any Triples.

Declaration

public virtual bool HasTriples { get; }

Property Value

Type	Description
bool

InternalDefaultGraph

Gets a reference to the actual IGraph that is currently treated as the default graph.

Declaration

protected IGraph InternalDefaultGraph { get; }

Property Value

Type	Description
IGraph

this[Uri]

Gets the Graph with the given URI from the Dataset.

Declaration

[Obsolete("Replaced by this[IRefNode]")]
public virtual IGraph this[Uri graphUri] { get; }

Parameters

Type	Name	Description
Uri	graphUri	Graph URI.

Property Value

Type	Description
IGraph

Remarks

This property need only return a read-only view of the Graph, code which wishes to modify Graphs should use the GetModifiableGraph() method to guarantee a Graph they can modify and will be persisted to the underlying storage.

this[IRefNode]

Gets the graph with the given name from the dataset.

Declaration

public virtual IGraph this[IRefNode graphName] { get; }

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

Property Value

Type	Description
IGraph

Remarks

This property need only return a read-only view of the Graph, code which wishes to modify Graphs should use the GetModifiableGraph() method to guarantee a Graph they can modify and will be persisted to the underlying storage.

QuotedTriples

Gets all the quoted triples in teh dataset.

Declaration

public IEnumerable<Triple> QuotedTriples { get; }

Property Value

Type	Description
IEnumerable<Triple>

Remarks

Note: The Triples returned from the method should be limited to those in the current Active Graph if present, otherwise those in the current Default Graph if present and finally the entire Dataset.

Triples

Gets all the Triples in the Dataset.

Declaration

public IEnumerable<Triple> Triples { get; }

Property Value

Type	Description
IEnumerable<Triple>

UsesUnionDefaultGraph

Gets whether the Default Graph is treated as being the union of all Graphs in the dataset when no Default Graph is otherwise set.

Declaration

public bool UsesUnionDefaultGraph { get; }

Property Value

Type	Description
bool

Methods

AddGraph(IGraph)

Adds a Graph to the Dataset.

Declaration

public abstract bool AddGraph(IGraph g)

Parameters

Type	Name	Description
IGraph	g	Graph.

Returns

Type	Description
bool

ContainsQuotedTriple(Triple)

Gets whether the dataset contains a specific quoted triple.

Declaration

public bool ContainsQuotedTriple(Triple t)

Parameters

Type	Name	Description
Triple	t	Triple.

Returns

Type	Description
bool	True if the dataset contains t as a quoted triple, false otherwise.

ContainsQuotedTripleInternal(Triple)

Determines whether the Dataset contains a specific quoted triple.

Declaration

protected abstract bool ContainsQuotedTripleInternal(Triple t)

Parameters

Type	Name	Description
Triple	t	Triple to search for.

Returns

Type	Description
bool

ContainsTriple(Triple)

Gets whether the Dataset contains a specific Triple.

Declaration

public bool ContainsTriple(Triple t)

Parameters

Type	Name	Description
Triple	t	Triple.

Returns

Type	Description
bool

ContainsTripleInternal(Triple)

Determines whether the Dataset contains a specific Triple.

Declaration

protected abstract bool ContainsTripleInternal(Triple t)

Parameters

Type	Name	Description
Triple	t	Triple to search for.

Returns

Type	Description
bool

Discard()

Ensures that any changes to the Dataset (if any) are discarded.

Declaration

public abstract void Discard()

Flush()

Ensures that any changes to the Dataset (if any) are flushed to the underlying Storage.

Declaration

public abstract void Flush()

GetAllQuotedTriples()

Abstract method that concrete implementations must implement to return an enumerable of all the quoted triples in the Dataset.

Declaration

protected abstract IEnumerable<Triple> GetAllQuotedTriples()

Returns

Type	Description
IEnumerable<Triple>

GetAllTriples()

Abstract method that concrete implementations must implement to return an enumerable of all the Triples in the Dataset.

Declaration

protected abstract IEnumerable<Triple> GetAllTriples()

Returns

Type	Description
IEnumerable<Triple>

GetGraphInternal(IRefNode)

Gets the given Graph from the Dataset.

Declaration

protected abstract IGraph GetGraphInternal(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

Returns

Type	Description
IGraph

GetModifiableGraph(Uri)

Gets the Graph with the given URI from the Dataset.

Declaration

[Obsolete("Replaced by GetModifiableGraph(IRefNode)")]
public IGraph GetModifiableGraph(Uri graphUri)

Parameters

Type	Name	Description
Uri	graphUri	Graph URI.

Returns

Type	Description
IGraph

Remarks

Graphs returned from this method must be modifiable and the Dataset must guarantee that when it is Flushed or Disposed of that any changes to the Graph are persisted.

Exceptions

Type	Condition
NotSupportedException	May be thrown if the Dataset is immutable i.e. Updates not supported.
NotSupportedException	May be thrown if the Dataset is immutable.

GetModifiableGraph(IRefNode)

Gets the Graph with the given URI from the Dataset.

Declaration

public abstract IGraph GetModifiableGraph(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph URI.

Returns

Type	Description
IGraph

Remarks

Graphs returned from this method must be modifiable and the Dataset must guarantee that when it is Flushed or Disposed of that any changes to the Graph are persisted.

GetQuoted(Uri)

Selects all quoted triples which have a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetQuoted(Uri u)

Parameters

Type	Name	Description
Uri	u

Returns

Type	Description
IEnumerable<Triple>

GetQuoted(INode)

Selects all quoted triples which contain the given Node.

Declaration

public IEnumerable<Triple> GetQuoted(INode n)

Parameters

Type	Name	Description
INode	n	Node.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithObject(Uri)

Selects all quoted triples where the Object is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetQuotedWithObject(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithObject(INode)

Selects all quoted triples where the Object is a given Node.

Declaration

public IEnumerable<Triple> GetQuotedWithObject(INode obj)

Parameters

Type	Name	Description
INode	obj

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithObjectInternal(INode)

Gets all the quoted triples in the dataset with the given object.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithObjectInternal(INode obj)

Parameters

Type	Name	Description
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithPredicate(Uri)

Selects all quoted triples where the Predicate is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetQuotedWithPredicate(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithPredicate(INode)

Selects all quoted triples where the Predicate is a given Node.

Declaration

public IEnumerable<Triple> GetQuotedWithPredicate(INode pred)

Parameters

Type	Name	Description
INode	pred

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithPredicateInternal(INode)

Gets all the quoted triples in the dataset with the given predicate.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithPredicateInternal(INode predicate)

Parameters

Type	Name	Description
INode	predicate

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithPredicateObject(INode, INode)

Selects all quoted triples with the given Predicate and Object.

Declaration

public IEnumerable<Triple> GetQuotedWithPredicateObject(INode pred, INode obj)

Parameters

Type	Name	Description
INode	pred	Predicate.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithPredicateObjectInternal(INode, INode)

Gets all the quoted triples in the dataset with the given predicate and object.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithPredicateObjectInternal(INode pred, INode obj)

Parameters

Type	Name	Description
INode	pred	Predicate.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubject(Uri)

Selects all quoted triples where the Subject is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetQuotedWithSubject(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubject(INode)

Selects all quoted triples where the Subject is a given Node.

Declaration

public IEnumerable<Triple> GetQuotedWithSubject(INode subj)

Parameters

Type	Name	Description
INode	subj

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubjectInternal(INode)

Gets all the quoted triples in the dataset with the given subject.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithSubjectInternal(INode subj)

Parameters

Type	Name	Description
INode	subj	Subject.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubjectObject(INode, INode)

Selects all quoted triples with the given Subject and Object.

Declaration

public IEnumerable<Triple> GetQuotedWithSubjectObject(INode subj, INode obj)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubjectObjectInternal(INode, INode)

Gets all the quoted triples in the dataset with the given subject and object.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithSubjectObjectInternal(INode subj, INode obj)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubjectPredicate(INode, INode)

Selects all quoted triples with the given Subject and Predicate.

Declaration

public IEnumerable<Triple> GetQuotedWithSubjectPredicate(INode subj, INode pred)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	pred	Predicate.

Returns

Type	Description
IEnumerable<Triple>

GetQuotedWithSubjectPredicateInternal(INode, INode)

Gets all the quoted triples in the dataset with the given subject and predicate.

Declaration

protected abstract IEnumerable<Triple> GetQuotedWithSubjectPredicateInternal(INode subj, INode predicate)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	predicate	Predicate.

Returns

Type	Description
IEnumerable<Triple>

GetTriples(Uri)

Selects all Triples which have a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetTriples(Uri uri)

Parameters

Type	Name	Description
Uri	uri	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetTriples(INode)

Selects all Triples which contain the given Node.

Declaration

public IEnumerable<Triple> GetTriples(INode n)

Parameters

Type	Name	Description
INode	n	Node.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithObject(Uri)

Selects all Triples where the Object is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetTriplesWithObject(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithObject(INode)

Gets all the Triples in the Dataset with the given Object.

Declaration

public IEnumerable<Triple> GetTriplesWithObject(INode obj)

Parameters

Type	Name	Description
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithObjectInternal(INode)

Gets all the asserted triples in the dataset with the given object.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithObjectInternal(INode obj)

Parameters

Type	Name	Description
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithPredicate(Uri)

Selects all Triples where the Predicate is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetTriplesWithPredicate(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithPredicate(INode)

Gets all the Triples in the Dataset with the given Predicate.

Declaration

public IEnumerable<Triple> GetTriplesWithPredicate(INode pred)

Parameters

Type	Name	Description
INode	pred	Predicate.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithPredicateInternal(INode)

Gets all the asserted triples in the Dataset with the given Predicate.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithPredicateInternal(INode predicate)

Parameters

Type	Name	Description
INode	predicate	Predicate.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithPredicateObject(INode, INode)

Selects all Triples with the given Predicate and Object.

Declaration

public IEnumerable<Triple> GetTriplesWithPredicateObject(INode pred, INode obj)

Parameters

Type	Name	Description
INode	pred	Predicate.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithPredicateObjectInternal(INode, INode)

Gets all the asserted triples in the dataset with the given predicate and object.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithPredicateObjectInternal(INode pred, INode obj)

Parameters

Type	Name	Description
INode	pred	Predicate.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubject(Uri)

Selects all Triples where the Subject is a Uri Node with the given Uri.

Declaration

public IEnumerable<Triple> GetTriplesWithSubject(Uri u)

Parameters

Type	Name	Description
Uri	u	Uri.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubject(INode)

Gets all the Triples in the Dataset with the given Subject.

Declaration

public IEnumerable<Triple> GetTriplesWithSubject(INode subj)

Parameters

Type	Name	Description
INode	subj	Subject.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubjectInternal(INode)

Gets all the asserted triples in the Dataset with the given Subject.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithSubjectInternal(INode subj)

Parameters

Type	Name	Description
INode	subj	Subject.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubjectObject(INode, INode)

Selects all Triples with the given Subject and Object.

Declaration

public IEnumerable<Triple> GetTriplesWithSubjectObject(INode subj, INode obj)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubjectObjectInternal(INode, INode)

Gets all the asserted triples in the dataset with the given subject and object.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithSubjectObjectInternal(INode subj, INode obj)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	obj	Object.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubjectPredicate(INode, INode)

Gets all the Triples in the Dataset with the given Subject and Predicate.

Declaration

public IEnumerable<Triple> GetTriplesWithSubjectPredicate(INode subj, INode pred)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	pred	Predicate.

Returns

Type	Description
IEnumerable<Triple>

GetTriplesWithSubjectPredicateInternal(INode, INode)

Gets all the asserted triples in the dataset with the given subject and predicate.

Declaration

protected abstract IEnumerable<Triple> GetTriplesWithSubjectPredicateInternal(INode subj, INode predicate)

Parameters

Type	Name	Description
INode	subj	Subject.
INode	predicate	Predicate.

Returns

Type	Description
IEnumerable<Triple>

HasGraph(Uri)

Gets whether a Graph with the given URI is the Dataset.

Declaration

[Obsolete("Replaced by HasGraph(IRefNode)")]
public bool HasGraph(Uri graphUri)

Parameters

Type	Name	Description
Uri	graphUri	Graph URI.

Returns

Type	Description
bool

HasGraph(IRefNode)

Gets whether a Graph with the given name is the Dataset.

Declaration

public bool HasGraph(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

Returns

Type	Description
bool

HasGraphInternal(IRefNode)

Determines whether a given Graph exists in the Dataset.

Declaration

protected abstract bool HasGraphInternal(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

Returns

Type	Description
bool

RemoveGraph(Uri)

Removes a Graph from the Dataset.

Declaration

[Obsolete("Replaced by RemoveGraph(IRefNode)")]
public virtual bool RemoveGraph(Uri graphUri)

Parameters

Type	Name	Description
Uri	graphUri	Graph URI.

Returns

Type	Description
bool

RemoveGraph(IRefNode)

Removes a Graph from the Dataset.

Declaration

public virtual bool RemoveGraph(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

Returns

Type	Description
bool

Exceptions

Type	Condition
NotSupportedException	May be thrown if the Dataset is immutable i.e. Updates not supported.

RemoveGraphInternal(IRefNode)

Removes a Graph from the Dataset.

Declaration

protected abstract bool RemoveGraphInternal(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph URI.

Returns

Type	Description
bool

ResetActiveGraph()

Sets the Active Graph for the SPARQL query to be the previous Active Graph.

Declaration

public void ResetActiveGraph()

ResetDefaultGraph()

Sets the Default Graph for the SPARQL Query to be the previous Default Graph.

Declaration

public void ResetDefaultGraph()

SetActiveGraph(IEnumerable<Uri>)

Sets the Active Graph for the SPARQL query.

Declaration

[Obsolete("Replaced by SetActiveGraph(IList<IRefNode>)")]
public void SetActiveGraph(IEnumerable<Uri> graphUris)

Parameters

Type	Name	Description
IEnumerable<Uri>	graphUris	URIs of the Graphs which form the Active Graph.

Remarks

Helper function used primarily in the execution of GRAPH Clauses.

SetActiveGraph(IList<IRefNode>)

Sets the active graph to be the union of the graphs with the given names.

Declaration

public void SetActiveGraph(IList<IRefNode> graphNames)

Parameters

Type	Name	Description
IList<IRefNode>	graphNames

SetActiveGraph(Uri)

Sets the Active Graph for the SPARQL query.

Declaration

[Obsolete("Replaced by SetActiveGraph(IRefNode)")]
public void SetActiveGraph(Uri graphUri)

Parameters

Type	Name	Description
Uri	graphUri	Uri of the Active Graph.

Remarks

Helper function used primarily in the execution of GRAPH Clauses.

SetActiveGraph(IRefNode)

Sets the active graph to be the graph with the given name.

Declaration

public void SetActiveGraph(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName	Graph name.

SetDefaultGraph(IEnumerable<Uri>)

Sets the Default Graph.

Declaration

[Obsolete("Replaced by SetDefaultGraph(IEnumerable<IRefNode>)")]
public void SetDefaultGraph(IEnumerable<Uri> graphUris)

Parameters

Type	Name	Description
IEnumerable<Uri>	graphUris	Graph URIs.

SetDefaultGraph(IList<IRefNode>)

Sets the default graph to be the union of the graphs with the given names.

Declaration

public void SetDefaultGraph(IList<IRefNode> graphNames)

Parameters

Type	Name	Description
IList<IRefNode>	graphNames	Graph names.

SetDefaultGraph(Uri)

Sets the Default Graph.

Declaration

[Obsolete("Replaced by SetDefaultGraph(IRefNode)")]
public void SetDefaultGraph(Uri graphUri)

Parameters

Type	Name	Description
Uri	graphUri	Graph URI.

SetDefaultGraph(IRefNode)

Sets the default graph to be the graph with the given name.

Declaration

public void SetDefaultGraph(IRefNode graphName)

Parameters

Type	Name	Description
IRefNode	graphName

Implements

ISparqlDataset

ITripleIndex

Extension Methods

Extensions.ToSafeString(object)

Extensions.AsEnumerable<T>(T)