org.licas_text.query.sparql

Class SparqlQuery

java.lang.Object

org.licas_text.query.sparql.model.SparqlElement

org.licas_text.query.sparql.SparqlQuery

public class SparqlQuery
extends SparqlElement

Sparql query client.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	A
static java.lang.String	ANYVAR Query keywords
static java.lang.String	AS
static java.lang.String	ASTERIX
static java.lang.String	AVG
static java.lang.String	BASE
static java.lang.String	COUNT
static java.lang.String	DESCR
static java.lang.String	DISTINCT
static java.lang.String	EQ
static java.lang.String	FILTER
static java.lang.String	FROM
static java.lang.String	GRAPH
static java.lang.String	GROUPBY
static java.lang.String	GT
static java.lang.String	ISURI
static java.lang.String	LIMIT
static java.lang.String	LT
static java.lang.String	MAX
static java.lang.String	MIN
static java.lang.String	MINUS
static java.lang.String	NAMED
static java.lang.String	NE
static java.lang.String	NOTEXISTS
static java.lang.String	NSEP
static java.lang.String	NULL
static java.lang.String	OBJECT
static java.lang.String	OFFSET
static java.lang.String	ONTOLOGY
static java.lang.String	OPTIONAL
static java.lang.String	ORDERBY
static java.lang.String	PLUS
static java.lang.String	PREDICATE
static java.lang.String	PREFIX Statement headings
static java.lang.String	REDUCED
static java.lang.String	REGEX Functions
static java.lang.String	RS
static java.lang.String	SELECT
static java.lang.String	SERVICE
static java.lang.String	SUBJECT RDF headings
static java.lang.String	SUM
static java.lang.String	TUPLE
static java.lang.String	UCASE
static java.lang.String	UNION
static java.lang.String	WHERE

Fields inherited from class org.licas_text.query.sparql.model.SparqlElement

filter, function, not, type, uuid, value

Constructor Summary

Constructors

Constructor and Description
SparqlQuery() Create a new instance of SparqlQuery

Method Summary

Modifier and Type	Method and Description
boolean	addBase(java.net.URI uri) Add a new prefix URI for the query.
void	addClause(java.lang.String key, java.lang.Object value) Add a new clause value, overwriting any existing one.
java.lang.String	addFrom(SparqlTriple thisFrom) Add a from statement URI.
java.lang.String	addPrefix(java.lang.String pref, java.net.URI uri) Add a new prefix with prefix URI for the query.
java.lang.String	addSelect(SparqlTriple thisSelect) Add a select statement projection.
java.lang.String	addSelect(SparqlTriple thisSelect, SparqlWhere addTo) Add a select statement projection.
java.lang.String	addWhere(SparqlSubWhere thisWhere) Add a new sub-where clause.
java.lang.String	addWhere(SparqlTriple thisWhere) Add a new where clause.
void	changeClause(java.lang.String key, java.lang.Object value) Reset this additional clauses to empty and then add a new clause.
java.lang.String	changeFrom(SparqlTriple thisFrom) Reset this from statement to empty and then add a new from statement URI.
java.lang.String	changePrefix(java.lang.String pref, java.net.URI uri) Reset the prefixes list to empty and then add a new prefix.
java.lang.String	changeSelect(SparqlTriple thisSelect) Reset this select statement to empty and then add a new statement projection.
java.lang.String	changeWhere(SparqlSubWhere thisWhere) Reset this where statement to empty and then add a new where sub-clause.
java.lang.String	changeWhere(SparqlTriple thisWhere) Reset this where statement to empty and then add a new where clause.
java.lang.String	createQuery() Concatenate the query description to create the query string.
java.util.HashMap<java.lang.String,java.lang.Object>	getClauses() Get the list of additional clauses.
static java.util.ArrayList<java.lang.String>	getClauseTypes() Get the clause type keywords.
SparqlElement	getElement(java.lang.String elemID) Get the element with the specified unique ID.
java.lang.String	getEndpoint() Get the endpoint for the query server.
static java.util.ArrayList<java.lang.String>	getFilterFunctions(java.lang.String filterType) Get any filter functions that can be applied to a filter type, including ANYVAR '---'.
static java.util.ArrayList<java.lang.String>	getFilterTypes(java.lang.String clauseType) Get the filter type keywords, including '*'.
SparqlFrom	getFrom() Get the from statement.
static java.util.ArrayList<java.lang.String>	getKeywords() Get the list of sparql keywords.
java.util.ArrayList<SparqlPrefix>	getPrefixes() Get the list of prefixes.
static java.util.ArrayList<java.lang.String>	getRegexTypes() Get the regular expression type keywords.
SparqlSelect	getSelect() Get the select statement, to add condition or other to it.
SparqlWhere	getWhere() Get the where clause, or null if not set.
static boolean	isClauseType(java.lang.String keyword) Return true if the keyword is a clause type word: DISTINCT, LIMIT, excluding '*'.
static boolean	isFilterSPO(java.lang.String keyword) Return true if the keyword is a filter type that allows subject-predicate-object: SUM, excluding '*'.
static boolean	isFilterType(java.lang.String keyword) Return true if the keyword is a filter type word: DISTINCT, NAMED, excluding '*'.
static boolean	isFilterWithFunction(java.lang.String keyword) Return true if the keyword is a filter that can have a function: FILTER.
static boolean	isKeyword(java.lang.String keyword) Return true if the keyword is a statement word.
static boolean	isReservedWord(java.lang.String keyword) Return true if the keyword is a reserved word of any type.
java.lang.String	partToString() Get a string-based description of this query component for info purposes only.
java.lang.String	partToString(java.lang.String elemID) Convert the element clauseType only into a string-based description.
java.lang.String	queryString() Get a string-based description of this query component.
boolean	setEndpoint(java.net.URI uri) Set the endpoint endpoint for the query server.

Methods inherited from class org.licas_text.query.sparql.model.SparqlElement

getType, getUuid, getValue, reset, setFilter, setFunction, setNot, setType, setUuid, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX

public static final java.lang.String PREFIX

Statement headings

See Also:

Constant Field Values

SELECT

public static final java.lang.String SELECT

See Also:

Constant Field Values

FROM

public static final java.lang.String FROM

See Also:

Constant Field Values

SERVICE

public static final java.lang.String SERVICE

See Also:

Constant Field Values

WHERE

public static final java.lang.String WHERE

See Also:

Constant Field Values

NAMED

public static final java.lang.String NAMED

See Also:

Constant Field Values

DISTINCT

public static final java.lang.String DISTINCT

See Also:

Constant Field Values

REDUCED

public static final java.lang.String REDUCED

See Also:

Constant Field Values

OPTIONAL

public static final java.lang.String OPTIONAL

See Also:

Constant Field Values

UNION

public static final java.lang.String UNION

See Also:

Constant Field Values

FILTER

public static final java.lang.String FILTER

See Also:

Constant Field Values

NOTEXISTS

public static final java.lang.String NOTEXISTS

See Also:

Constant Field Values

MIN

public static final java.lang.String MIN

See Also:

Constant Field Values

MAX

public static final java.lang.String MAX

See Also:

Constant Field Values

AVG

public static final java.lang.String AVG

See Also:

Constant Field Values

SUM

public static final java.lang.String SUM

See Also:

Constant Field Values

COUNT

public static final java.lang.String COUNT

See Also:

Constant Field Values

MINUS

public static final java.lang.String MINUS

See Also:

Constant Field Values

LIMIT

public static final java.lang.String LIMIT

See Also:

Constant Field Values

UCASE

public static final java.lang.String UCASE

See Also:

Constant Field Values

GROUPBY

public static final java.lang.String GROUPBY

See Also:

Constant Field Values

ORDERBY

public static final java.lang.String ORDERBY

See Also:

Constant Field Values

OFFSET

public static final java.lang.String OFFSET

See Also:

Constant Field Values

BASE

public static final java.lang.String BASE

See Also:

Constant Field Values

GRAPH

public static final java.lang.String GRAPH

See Also:

Constant Field Values

DESCR

public static final java.lang.String DESCR

See Also:

Constant Field Values

REGEX

public static final java.lang.String REGEX

Functions

See Also:

Constant Field Values

ISURI

public static final java.lang.String ISURI

See Also:

Constant Field Values

ASTERIX

public static final java.lang.String ASTERIX

See Also:

Constant Field Values

PLUS

public static final java.lang.String PLUS

See Also:

Constant Field Values

ANYVAR

public static final java.lang.String ANYVAR

Query keywords

See Also:

Constant Field Values

NSEP

public static final java.lang.String NSEP

See Also:

Constant Field Values

A

public static final java.lang.String A

See Also:

Constant Field Values

AS

public static final java.lang.String AS

See Also:

Constant Field Values

EQ

public static final java.lang.String EQ

See Also:

Constant Field Values

NE

public static final java.lang.String NE

See Also:

Constant Field Values

LT

public static final java.lang.String LT

See Also:

Constant Field Values

GT

public static final java.lang.String GT

See Also:

Constant Field Values

NULL

public static final java.lang.String NULL

See Also:

Constant Field Values

SUBJECT

public static final java.lang.String SUBJECT

RDF headings

See Also:

Constant Field Values

PREDICATE

public static final java.lang.String PREDICATE

See Also:

Constant Field Values

OBJECT

public static final java.lang.String OBJECT

See Also:

Constant Field Values

ONTOLOGY

public static final java.lang.String ONTOLOGY

See Also:

Constant Field Values

TUPLE

public static final java.lang.String TUPLE

See Also:

Constant Field Values

RS

public static final java.lang.String RS

See Also:

Constant Field Values

Constructor Detail

SparqlQuery

public SparqlQuery()

Create a new instance of SparqlQuery

Method Detail

createQuery

public java.lang.String createQuery()

Concatenate the query description to create the query string. NOTE: this does not include the endpoint that can be retrieved separately.

Returns:

a full query description as a string.

partToString

public java.lang.String partToString(java.lang.String elemID)

Convert the element clauseType only into a string-based description.

Parameters:

elemID - the unique ID created when the element was created.

Returns:

string-based description.

queryString

public java.lang.String queryString()

Get a string-based description of this query component.

Specified by:

queryString in class SparqlElement

Returns:

a string-based description of this query part.

partToString

public java.lang.String partToString()

Get a string-based description of this query component for info purposes only. Most of the formatting is removed and each clause is a single line.

Specified by:

partToString in class SparqlElement

Returns:

a string-based description of this query part.

getElement

public SparqlElement getElement(java.lang.String elemID)

Get the element with the specified unique ID.

Specified by:

getElement in class SparqlElement

Parameters:

elemID - the element id.

Returns:

the element in the query with that id.

setEndpoint

public boolean setEndpoint(java.net.URI uri)

Set the endpoint endpoint for the query server.

Parameters:

uri - the endpoint address.

Returns:

false if the bases already exists, true otherwise.

getEndpoint

public java.lang.String getEndpoint()

Get the endpoint for the query server.

Returns:

the URI for the query server.

addBase

public boolean addBase(java.net.URI uri)

Add a new prefix URI for the query.

Parameters:

uri - the prefix address.

Returns:

true.

addPrefix

public java.lang.String addPrefix(java.lang.String pref,
                                  java.net.URI uri)

Add a new prefix with prefix URI for the query.

Parameters:

pref - the prefix prefix.

uri - the prefix address.

Returns:

the unique id of the added prefix.

changePrefix

public java.lang.String changePrefix(java.lang.String pref,
                                     java.net.URI uri)

Reset the prefixes list to empty and then add a new prefix.

Parameters:

pref - the prefix prefix.

uri - the prefix address.

Returns:

the unique id of the added prefix.

getPrefixes

public java.util.ArrayList<SparqlPrefix> getPrefixes()

Get the list of prefixes.

Returns:

the value of prefixes, of type SparqlPrefix.

addSelect

public java.lang.String addSelect(SparqlTriple thisSelect)

Add a select statement projection.

Parameters:

thisSelect - the projection statement to add.

Returns:

the unique id of the added select statement.

addSelect

public java.lang.String addSelect(SparqlTriple thisSelect,
                                  SparqlWhere addTo)

Add a select statement projection.

Parameters:

thisSelect - the projection statement to add.

addTo - the where clause to add the select clause to.

Returns:

the unique id of the added select statement.

changeSelect

public java.lang.String changeSelect(SparqlTriple thisSelect)

Reset this select statement to empty and then add a new statement projection.

Parameters:

thisSelect - the projection statement to add.

Returns:

the unique id of the added select statement.

getSelect

public SparqlSelect getSelect()

Get the select statement, to add condition or other to it.

Returns:

the select statement or null if one has not been added.

addFrom

public java.lang.String addFrom(SparqlTriple thisFrom)

Add a from statement URI.

Parameters:

thisFrom - the projection statement to add.

Returns:

the unique id of the added from statement.

changeFrom

public java.lang.String changeFrom(SparqlTriple thisFrom)

Reset this from statement to empty and then add a new from statement URI.

Parameters:

thisFrom - the projection statement to add.

Returns:

the unique id of the added from statement.

getFrom

public SparqlFrom getFrom()

Get the from statement.

Returns:

the from statement or null if one has not been added.

addWhere

public java.lang.String addWhere(SparqlTriple thisWhere)

Add a new where clause.

Parameters:

thisWhere - the where clause.

Returns:

the unique id of the added where statement.

changeWhere

public java.lang.String changeWhere(SparqlTriple thisWhere)

Reset this where statement to empty and then add a new where clause.

Parameters:

thisWhere - the where clause.

Returns:

the unique id of the added where statement.

addWhere

public java.lang.String addWhere(SparqlSubWhere thisWhere)

Add a new sub-where clause. The the base where clause is null, then replace it with the sub-where clause instead.

Parameters:

thisWhere - the where clause.

Returns:

the unique id of the added where statement.

changeWhere

public java.lang.String changeWhere(SparqlSubWhere thisWhere)

Reset this where statement to empty and then add a new where sub-clause.

Parameters:

thisWhere - the where clause.

Returns:

the unique id of the added where statement.

getWhere

public SparqlWhere getWhere()

Get the where clause, or null if not set.

Returns:

the value of where.

addClause

public void addClause(java.lang.String key,
                      java.lang.Object value)

Add a new clause value, overwriting any existing one.

Parameters:

key - the clause name.

value - the clause value.

changeClause

public void changeClause(java.lang.String key,
                         java.lang.Object value)

Reset this additional clauses to empty and then add a new clause.

Parameters:

key - the clause name.

value - the clause value.

getClauses

public java.util.HashMap<java.lang.String,java.lang.Object> getClauses()

Get the list of additional clauses.

Returns:

the value of clauses.

isReservedWord

public static boolean isReservedWord(java.lang.String keyword)

Return true if the keyword is a reserved word of any type.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

isKeyword

public static boolean isKeyword(java.lang.String keyword)

Return true if the keyword is a statement word.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

isFilterType

public static boolean isFilterType(java.lang.String keyword)

Return true if the keyword is a filter type word: DISTINCT, NAMED, excluding '*'.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

isFilterSPO

public static boolean isFilterSPO(java.lang.String keyword)

Return true if the keyword is a filter type that allows subject-predicate-object: SUM, excluding '*'.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

isFilterWithFunction

public static boolean isFilterWithFunction(java.lang.String keyword)

Return true if the keyword is a filter that can have a function: FILTER.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

isClauseType

public static boolean isClauseType(java.lang.String keyword)

Return true if the keyword is a clause type word: DISTINCT, LIMIT, excluding '*'.

Parameters:

keyword - the keyword to check.

Returns:

true if a known reserved word.

getKeywords

public static java.util.ArrayList<java.lang.String> getKeywords()

Get the list of sparql keywords.

Returns:

the list of reserved keywords.

getFilterTypes

public static java.util.ArrayList<java.lang.String> getFilterTypes(java.lang.String clauseType)

Get the filter type keywords, including '*'.

Parameters:

clauseType - the clause type to return for, SELECT, WHERE, for example.

Returns:

the value of filterTypes.

getFilterFunctions

public static java.util.ArrayList<java.lang.String> getFilterFunctions(java.lang.String filterType)

Get any filter functions that can be applied to a filter type, including ANYVAR '---'.

Parameters:

filterType - the filter type, FILTER, for example.

Returns:

a list of filter functions.

getClauseTypes

public static java.util.ArrayList<java.lang.String> getClauseTypes()

Get the clause type keywords.

Returns:

the value of clauseTypes.

getRegexTypes

public static java.util.ArrayList<java.lang.String> getRegexTypes()

Get the regular expression type keywords.

Returns:

the value of regexTypes.