org.xorm.query
Interface QueryLanguage

All Superinterfaces:

Cloneable

All Known Implementing Classes:

AbstractQueryLanguage, CodeParser

public interface QueryLanguage

extends Cloneable

This small interface must be implemented by any dialect of a query language that will be used with XORM. The query can be executed by JDO by calling PersistenceManager.newQuery(QueryLanguage.LANGUAGE, this) where "this" is an instance of QueryLanguage.

Field Summary

static String

LANGUAGE

Method Summary

void	compile() A hint that the implementation should undertake the work of generating the Expression object now for future use.
Class	getCandidateClass() Gets the class of candidate instances for the query.
Expression	getExpression() Returns the query expression generated by this object.
QueryOrdering[]	getOrdering() Gets the ordering that should be used in returning the values.

Field Detail

LANGUAGE

public static final String LANGUAGE

See Also:

Constant Field Values

Method Detail

getCandidateClass

public Class getCandidateClass()

Gets the class of candidate instances for the query.

compile

public void compile()
             throws QuerySyntaxException

A hint that the implementation should undertake the work of generating the Expression object now for future use.

QuerySyntaxException

getExpression

public Expression getExpression()

Returns the query expression generated by this object. This method may return null if compile() has not been called.

getOrdering

public QueryOrdering[] getOrdering()

Gets the ordering that should be used in returning the values.