org.licas_text.query.sparql.model

Class SparqlElement

java.lang.Object

org.licas_text.query.sparql.model.SparqlElement

Direct Known Subclasses:

SparqlEndpoint, SparqlQuery, SparqlWhere

public abstract class SparqlElement
extends java.lang.Object

The base element type for a SPARQL query component.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filter The filter that the sub-clause can belong to
protected java.lang.String	function The function that can be applied to the filter
protected boolean	not True if not function declared
protected java.lang.String	type Additional description if this is an end element
protected java.lang.String	uuid A unique id for this element, for identification purposes only
protected java.lang.String	value Value if this is an end element

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract SparqlElement	getElement(java.lang.String elemID) Get the element with the specified unique ID.
java.lang.String	getType() Get the additional descriptive type value.
java.lang.String	getUuid() Get the uuid for this element.
java.lang.String	getValue() Get the value for this element.
abstract java.lang.String	partToString() Get a string-based description of this query component, with add type as true.
abstract java.lang.String	queryString() Get a string-based description of this query component.
void	reset() Reset the values
void	setFilter(java.lang.String thisFilter) Set the optional outer filter type for this sub-where clause.
void	setFunction(java.lang.String thisFunction) Set the filter function for this sub-where clause.
void	setNot(boolean thisNot) Set the function inverse or not declaration.
void	setType(java.lang.String thisType) Set the additional descriptive type field: distinct, named.
protected void	setUuid(java.lang.String thisUuid) Set the uuid for this element.
void	setValue(java.lang.String thisValue) Set the value for this element.

Methods inherited from class java.lang.Object

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

Field Detail

uuid

protected java.lang.String uuid

A unique id for this element, for identification purposes only

value

protected java.lang.String value

Value if this is an end element

type

protected java.lang.String type

Additional description if this is an end element

filter

protected java.lang.String filter

The filter that the sub-clause can belong to

function

protected java.lang.String function

The function that can be applied to the filter

not

protected boolean not

True if not function declared

Constructor Detail

SparqlElement

public SparqlElement()

Create a new instance of SparqlElement

Method Detail

reset

public void reset()

Reset the values

partToString

public abstract java.lang.String partToString()

Get a string-based description of this query component, with add type as true.

Returns:

a string-based description of this query part.

queryString

public abstract java.lang.String queryString()

Get a string-based description of this query component.

Returns:

a string-based description of this query part.

getElement

public abstract SparqlElement getElement(java.lang.String elemID)

Get the element with the specified unique ID.

Parameters:

elemID - the element id.

Returns:

the element in the query with that id.

setUuid

protected void setUuid(java.lang.String thisUuid)

Set the uuid for this element. Typically, this is carried out internally when the element is created, when getUuid can retrieve it. So only set the uuid in special cases.

Parameters:

thisUuid - the uuid.

getUuid

public java.lang.String getUuid()

Get the uuid for this element.

Returns:

the value of uuid.

setValue

public void setValue(java.lang.String thisValue)

Set the value for this element.

Parameters:

thisValue - the name or value.

getValue

public java.lang.String getValue()

Get the value for this element.

Returns:

the value of value.

setType

public void setType(java.lang.String thisType)

Set the additional descriptive type field: distinct, named.

Parameters:

thisType - the descriptive value.

getType

public java.lang.String getType()

Get the additional descriptive type value.

Returns:

the value of type.

setFilter

public void setFilter(java.lang.String thisFilter)

Set the optional outer filter type for this sub-where clause.

Parameters:

thisFilter - the sub-clause function.

setFunction

public void setFunction(java.lang.String thisFunction)

Set the filter function for this sub-where clause.

Parameters:

thisFunction - the filter function.

setNot

public void setNot(boolean thisNot)

Set the function inverse or not declaration.

Parameters:

thisNot - true if require the function inverse to be true.