Show / Hide Table of Contents

Class SparqlQueryParser

Class for parsing SPARQL Queries into SparqlQuery objects that can be used to query a Graph or Triple Store.
Inheritance
System.Object
SparqlQueryParser
Implements
ITraceableTokeniser
IObjectParser<SparqlQuery>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: VDS.RDF.Parsing
Assembly: dotNetRDF.dll
Syntax
public class SparqlQueryParser : ITraceableTokeniser, IObjectParser<SparqlQuery>

Constructors

| Improve this Doc View Source

SparqlQueryParser()

Creates a new instance of the SPARQL Query Parser.
Declaration
public SparqlQueryParser()
| Improve this Doc View Source

SparqlQueryParser(SparqlQuerySyntax)

Creates a new instance of the SPARQL Query Parser which supports the given SPARQL Syntax.
Declaration
public SparqlQueryParser(SparqlQuerySyntax syntax)
Parameters
Type Name Description
SparqlQuerySyntax syntax SPARQL Syntax.
| Improve this Doc View Source

SparqlQueryParser(TokenQueueMode)

Creates a new instance of the SPARQL Query Parser using the given Tokeniser Queue Mode.
Declaration
public SparqlQueryParser(TokenQueueMode queueMode)
Parameters
Type Name Description
TokenQueueMode queueMode Token Queue Mode.
| Improve this Doc View Source

SparqlQueryParser(TokenQueueMode, SparqlQuerySyntax)

Creates a new instance of the SPARQL Query Parser using the given Tokeniser which supports the given SPARQL Syntax.
Declaration
public SparqlQueryParser(TokenQueueMode queueMode, SparqlQuerySyntax syntax)
Parameters
Type Name Description
TokenQueueMode queueMode Token Queue Mode.
SparqlQuerySyntax syntax SPARQL Syntax.

Properties

| Improve this Doc View Source

DefaultBaseUri

Gets/Sets the Default Base URI for Queries parsed by this Parser instance.
Declaration
public Uri DefaultBaseUri { get; set; }
Property Value
Type Description
System.Uri
| Improve this Doc View Source

ExpressionFactories

Gets/Sets the locally scoped custom expression factories.
Declaration
public IEnumerable<ISparqlCustomExpressionFactory> ExpressionFactories { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ISparqlCustomExpressionFactory>
| Improve this Doc View Source

QueryOptimiser

Gets/Sets the locally scoped Query Optimiser applied to queries at the end of the parsing process.
Declaration
public IQueryOptimiser QueryOptimiser { get; set; }
Property Value
Type Description
IQueryOptimiser
Remarks

May be null if no locally scoped optimiser is set in which case the globally scoped optimiser will be used.

| Improve this Doc View Source

SyntaxMode

Gets/Sets the Syntax that should be supported.
Declaration
public SparqlQuerySyntax SyntaxMode { get; set; }
Property Value
Type Description
SparqlQuerySyntax
| Improve this Doc View Source

TraceTokeniser

Gets/Sets whether Tokeniser progress is Traced to the Console.
Declaration
public bool TraceTokeniser { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

ExcessTokensString(SparqlQueryParserContext, Int32)

Constructs an error message that informs the user about unexpected excess tokens in a SPARQL qery.
Declaration
public string ExcessTokensString(SparqlQueryParserContext context, int expectedCount)
Parameters
Type Name Description
SparqlQueryParserContext context Current parser context.
System.Int32 expectedCount The expected number of tokens.
Returns
Type Description
System.String
| Improve this Doc View Source

Parse(StreamReader)

Parses a SPARQL Query from an arbitrary Input Stream.
Declaration
public SparqlQuery Parse(StreamReader input)
Parameters
Type Name Description
System.IO.StreamReader input Input Stream.
Returns
Type Description
SparqlQuery
| Improve this Doc View Source

Parse(TextReader)

Parses a SPARQL Query from an arbitrary Input.
Declaration
public SparqlQuery Parse(TextReader input)
Parameters
Type Name Description
System.IO.TextReader input Input.
Returns
Type Description
SparqlQuery
| Improve this Doc View Source

ParseFromFile(String)

Parses a SPARQL Query from a File.
Declaration
public SparqlQuery ParseFromFile(string queryFile)
Parameters
Type Name Description
System.String queryFile File containing the Query.
Returns
Type Description
SparqlQuery
| Improve this Doc View Source

ParseFromString(String)

Parses a SPARQL Query from a String.
Declaration
public SparqlQuery ParseFromString(string queryString)
Parameters
Type Name Description
System.String queryString A SPARQL Query.
Returns
Type Description
SparqlQuery
| Improve this Doc View Source

ParseFromString(SparqlParameterizedString)

Parses a SPARQL Query from a SPARQL Parameterized String.
Declaration
public SparqlQuery ParseFromString(SparqlParameterizedString queryString)
Parameters
Type Name Description
SparqlParameterizedString queryString A SPARQL Parameterized String.
Returns
Type Description
SparqlQuery
Remarks
The SparqlParameterizedString class allows you to use parameters in a String in a manner similar to SQL Commands in the ADO.Net model. See the documentation for SparqlParameterizedString for details of this.
| Improve this Doc View Source

TryParseGraphPattern(SparqlQueryParserContext, Boolean)

Tries to parse a Graph Pattern from the given Parser Context.
Declaration
protected GraphPattern TryParseGraphPattern(SparqlQueryParserContext context, bool requireOpeningLeftBracket)
Parameters
Type Name Description
SparqlQueryParserContext context Parser Context.
System.Boolean requireOpeningLeftBracket Whether the opening Left Curly Bracket is required.
Returns
Type Description
GraphPattern

Events

| Improve this Doc View Source

Warning

Event raised when a non-fatal issue with the SPARQL Query being parsed is detected
Declaration
public event SparqlWarning Warning
Event Type
Type Description
SparqlWarning

Implements

ITraceableTokeniser
IObjectParser<T>

Extension Methods

Extensions.AsEnumerable<T>(T)
  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • SparqlQueryParser()
    • SparqlQueryParser(SparqlQuerySyntax)
    • SparqlQueryParser(TokenQueueMode)
    • SparqlQueryParser(TokenQueueMode, SparqlQuerySyntax)
  • Properties
    • DefaultBaseUri
    • ExpressionFactories
    • QueryOptimiser
    • SyntaxMode
    • TraceTokeniser
  • Methods
    • ExcessTokensString(SparqlQueryParserContext, Int32)
    • Parse(StreamReader)
    • Parse(TextReader)
    • ParseFromFile(String)
    • ParseFromString(String)
    • ParseFromString(SparqlParameterizedString)
    • TryParseGraphPattern(SparqlQueryParserContext, Boolean)
  • Events
    • Warning
  • Implements
  • Extension Methods
Back to top Generated by DocFX