org.plasma.query

Interface Query

All Superinterfaces:

Term

All Known Subinterfaces:

DomainQuery, XPathQuery

All Known Implementing Classes:

DomainRoot, QConstraint, QGlobalVariable, QGlobalVariable, QTable, QTable, QTableColumn, QTableColumn, QTableColumnComment, QTableColumnConstraint, QTableColumnConstraint, QTableColumnKeyUsage, QTableComment, QTableConstraint, Query, QVersion, QVersion, QView, QView, QViewColumn, QViewColumnComment, QViewComment

public interface Query
extends Term

The PlasmaQuery#8482; API provides a flexible mechanism to fully describe any arbitrary SDO results Data Graph, independent of any persistence framework or type of data store. PlasmaQuery#8482; supports XPath expressions as a free-text "surface language", parsed by the API implementation and used to construct an underlying query object model representation. As an alternative to free-text, PlasmaQuery#8482; contains a query Domain Specific Language (DSL) generator and API facilitating (IDE) code-completion, 100% compile-time checking and resulting in code with an almost "fluent" English appearance based on your business model. At runtime the PlasmaQuery#8482; DSL implementation constructs an underlying query object model representation. The detailed query object model can also be manipulated directly and consists of various criteria entities such as expressions, properties, operators, parameters, etc... as well as convenient factory operations which allow precise user and system control over the various elements constituting a query. The object model can also be serialized as XML for wire transport, persistence, flat file or other usage.

Method Summary

Modifier and Type	Method and Description
void	addConfigurationProperty(String name, String value) Appends the given property to the configuration property list.
void	clearOrderByClause()
GroupBy	findGroupByClause()
List<Join>	findJoinClauses()
OrderBy	findOrderByClause()
Where	findWhereClause()
String	getConfigurationProperty(String name) Returns the configuration property value for the given name
Integer	getEndRange() Gets the value of the endRange property.
From	getFromClause()
Query	getModel() Returns the underlying query model for this query.
String	getName() Gets the value of the name property for the query.
Select	getSelectClause()
Integer	getStartRange() Gets the value of the startRange property.
Where	getWhereClause()
void	setEndRange(Integer value) Sets the value of the endRange property.
void	setName(String value) Sets the value of the name property for the query.
void	setStartRange(Integer value) Sets the value of the startRange property.

Method Detail

getStartRange

Integer getStartRange()

Gets the value of the startRange property.

Returns:

possible object is Integer

setStartRange

void setStartRange(Integer value)

Sets the value of the startRange property.

Parameters:

value - allowed object is Integer

getEndRange

Integer getEndRange()

Gets the value of the endRange property.

Returns:

possible object is Integer

setEndRange

void setEndRange(Integer value)

Sets the value of the endRange property.

Parameters:

value - allowed object is Integer

addConfigurationProperty

void addConfigurationProperty(String name,
                              String value)

Appends the given property to the configuration property list.

Parameters:

name - the property name

value - the property value

getConfigurationProperty

String getConfigurationProperty(String name)

Returns the configuration property value for the given name

Parameters:

name - the property name

Returns:

the property value

getName

String getName()

Gets the value of the name property for the query.

Returns:

possible object is String

setName

void setName(String value)

Sets the value of the name property for the query.

Parameters:

value - allowed object is String

getSelectClause

Select getSelectClause()

getFromClause

From getFromClause()

getWhereClause

Where getWhereClause()

findWhereClause

Where findWhereClause()

clearOrderByClause

void clearOrderByClause()

findOrderByClause

OrderBy findOrderByClause()

findGroupByClause

GroupBy findGroupByClause()

findJoinClauses

List<Join> findJoinClauses()

getModel

Query getModel()

Returns the underlying query model for this query.

Returns:

the underlying query model for this query