de.ipcon.db.core

Class BOQuery

java.lang.Object

de.ipcon.db.core.BOQuery

public class BOQuery
extends java.lang.Object

This class provides a more convenient way of creating (OQL) queries.

Constructor Summary

Constructors

Constructor and Description
BOQuery(java.lang.Class<? extends BOI> clazz) Creates a new BOQuery.
BOQuery(java.lang.Class<? extends BOI> clazz, java.lang.String whereClause)
BOQuery(java.lang.Class<? extends BOI> clazz, java.lang.String whereClause, java.lang.Object[] pvals)
BOQuery(java.lang.Class<? extends BOI> clazz, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted)
BOQuery(java.lang.Class<? extends BOI> clazz, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy)
BOQuery(java.lang.Class<? extends BOI> clazz, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy, int limit)
BOQuery(java.lang.String className) Creates a new BOQuery.
BOQuery(java.lang.String className, java.lang.String whereClause)
BOQuery(java.lang.String className, java.lang.String whereClause, java.lang.Object[] pvals)
BOQuery(java.lang.String className, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted)
BOQuery(java.lang.String className, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy)
BOQuery(java.lang.String className, java.lang.String whereClause, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy, int limit)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClazzName()
java.lang.String	getOQLString() Returns the OQL string that results from this BOQuery and which will be used on the database.
java.lang.String	getOQLString(boolean id)
java.lang.Object[]	getParameterObjects() Returns an array of the parameter objects that will be inserted for the "wildcards" in the OQL string (if any).
java.lang.String	getWhere()

Methods inherited from class java.lang.Object

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

Constructor Detail

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz)

Creates a new BOQuery.

Parameters:

clazz - the class of which objects should be retrieved

whereClause - an (optional, may be null) where clause (just the criteria like 'bo.bla = 1 AND bo.foo = "test"')

pvals - an (optional, may be null) object array corresponding with $n entries, $1 is pvals[0] and so forth.

includeDeleted - flag that specifies if deleted BOs should be returned too; defaults to false.

orderBy - an (optional, may be null) ORDER BY clause (just the criteria, like 'bo.bla ASC, bo.foo DESC')

limit - the (optional) maximum number of results to fetch

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz,
               java.lang.String whereClause)

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz,
               java.lang.String whereClause,
               java.lang.Object[] pvals)

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted)

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted,
               java.lang.String orderBy)

BOQuery

public BOQuery(java.lang.Class<? extends BOI> clazz,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted,
               java.lang.String orderBy,
               int limit)

BOQuery

public BOQuery(java.lang.String className)

Creates a new BOQuery.

Parameters:

className - the name of the class of which objects should be retrieved

whereClause - an (optional, may be null) where clause (just the criteria like 'bo.bla = 1 AND bo.foo = "test"')

pvals - an (optional, may be null) object array corresponding with $n entries, $1 is pvals[0] and so forth.

includeDeleted - flag that specifies if deleted BOs should be returned too; defaults to false.

orderBy - an (optional, may be null) ORDER BY clause (just the criteria, like 'bo.bla ASC, bo.foo DESC')

limit - the (optional) maximum number of results to fetch

BOQuery

public BOQuery(java.lang.String className,
               java.lang.String whereClause)

BOQuery

public BOQuery(java.lang.String className,
               java.lang.String whereClause,
               java.lang.Object[] pvals)

BOQuery

public BOQuery(java.lang.String className,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted)

BOQuery

public BOQuery(java.lang.String className,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted,
               java.lang.String orderBy)

BOQuery

public BOQuery(java.lang.String className,
               java.lang.String whereClause,
               java.lang.Object[] pvals,
               boolean includeDeleted,
               java.lang.String orderBy,
               int limit)

Method Detail

getOQLString

public java.lang.String getOQLString()

Returns the OQL string that results from this BOQuery and which will be used on the database.

Returns:

the OQL string that results from this BOQuery

getOQLString

public java.lang.String getOQLString(boolean id)

getParameterObjects

public java.lang.Object[] getParameterObjects()

Returns an array of the parameter objects that will be inserted for the "wildcards" in the OQL string (if any). If no parameters where given in the construction of the BOQuery returns an empty Object array.

Returns:

an array of the parameter objects

getClazzName

public java.lang.String getClazzName()

getWhere

public java.lang.String getWhere()