de.ipcon.db.oql

Class InterpretedOQLQuery

java.lang.Object

de.ipcon.db.oql.InterpretedOQLQuery

public class InterpretedOQLQuery
extends java.lang.Object

Interprets a given OQL query and provides easily useable information about it and helper objects to check and handle BOs accordingly.

FIXME! TT 2023-03-09: Note that a lot of MyTISM OQL constructs are not yet supported. FIXME! TT 2023-03-09: It might be nice if the parameter values need not be given upon construction but could be dynamically set and changed later.

Constructor Summary

Constructors

Constructor and Description
InterpretedOQLQuery(OQLQuery oqlQuery, java.lang.Object[] parameters)
InterpretedOQLQuery(SchemaI schema, java.lang.String query, java.lang.Object[] parameters)

Method Summary

Modifier and Type	Method and Description
EntityI	getEntity()
int	getLimit()
CBOSorter.BOComparator	getOrderByComparator()
OQLQueryPredicate	getPredicate()
java.lang.String	getQuery()
boolean	hasLimitAndIsSorted() Checks if a limit is present with sorting.
boolean	isSorted()
java.util.List	queryBO(java.util.Collection<BOI> bos) "Queries" BOs (or scalars) from the given collection by filtering them according to this interpreter's OQL query's "WHERE" clause, sorting them according to possible "ORDER BY" clauses and limiting the number of results by a possible "LIMIT" clause.
java.util.List	queryBO(java.util.Collection<BOI> bos, boolean ignoreLimitAndOrderClauses) "Queries" BOs from the given collection by filtering them according to this interpreter's OQL query's "WHERE" clause, sorting them according to possible "ORDER BY" clauses and limiting the number of results by a possible "LIMIT" clause.
void	setEntity(EntityI entity)
void	setLimit(int limit)
void	setOrderByComparator(CBOSorter.BOComparator orderByComparator)
void	setPredicate(OQLQueryPredicate predicate)
void	setQuery(java.lang.String query)
java.util.List<BOI>	sortBOs(java.util.Collection<BOI> bos)
java.util.List<BOI>	sortBOs(java.util.Iterator<BOI> it)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InterpretedOQLQuery

public InterpretedOQLQuery(SchemaI schema,
                           java.lang.String query,
                           java.lang.Object[] parameters)
                    throws OQLException,
                           UnsupportedQueryException

Throws:

OQLException

UnsupportedQueryException

InterpretedOQLQuery

public InterpretedOQLQuery(OQLQuery oqlQuery,
                           java.lang.Object[] parameters)
                    throws OQLException,
                           UnsupportedQueryException

Throws:

OQLException

UnsupportedQueryException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

queryBO

public java.util.List queryBO(java.util.Collection<BOI> bos)

"Queries" BOs (or scalars) from the given collection by filtering them according to this interpreter's OQL query's "WHERE" clause, sorting them according to possible "ORDER BY" clauses and limiting the number of results by a possible "LIMIT" clause.

Parameters:

bos - the collection of BOs (or scalars) to "query" from

Returns:

the list of results (normally BOs) from the given collection matching this interpreters OQL query

queryBO

public java.util.List queryBO(java.util.Collection<BOI> bos,
                              boolean ignoreLimitAndOrderClauses)

"Queries" BOs from the given collection by filtering them according to this interpreter's OQL query's "WHERE" clause, sorting them according to possible "ORDER BY" clauses and limiting the number of results by a possible "LIMIT" clause.

Parameters:

bos - the collection of BOs to "query" from

ignoreLimitAndOrderClauses - if true the "limit" and "order" clauses will be ignored; needed only for special handling in Transaction, normally the default (false) should be kept

Returns:

the list of results (normally BOs) from the given collection matching this interpreters OQL query

isSorted

public boolean isSorted()

hasLimitAndIsSorted

public boolean hasLimitAndIsSorted()

Checks if a limit is present with sorting.

sortBOs

public java.util.List<BOI> sortBOs(java.util.Collection<BOI> bos)

sortBOs

public java.util.List<BOI> sortBOs(java.util.Iterator<BOI> it)

getEntity

public EntityI getEntity()

setEntity

public void setEntity(EntityI entity)

getPredicate

public OQLQueryPredicate getPredicate()

setPredicate

public void setPredicate(OQLQueryPredicate predicate)

getOrderByComparator

public CBOSorter.BOComparator getOrderByComparator()

setOrderByComparator

public void setOrderByComparator(CBOSorter.BOComparator orderByComparator)

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

getQuery

public java.lang.String getQuery()

setQuery

public void setQuery(java.lang.String query)