org.ujoframework.orm
Class Query<UJO extends OrmUjo>

java.lang.Object
  org.ujoframework.orm.Query<UJO>

public class Query<UJO extends OrmUjo>
extends java.lang.Object

ORM query.

Author:

Pavel Ponec

Constructor Summary

Query(java.lang.Class<UJO> tableClass, Criterion<UJO> criterion, Session session)
Create new ORM query.

Query(MetaTable table, Criterion<UJO> criterion, Session session)
Create new ORM query.

Method Summary

Query<UJO>	addOrder(UjoProperty property) Add an item to the end of order list.
MetaColumn	getColumn(int index) Get Column List
java.util.List<MetaColumn>	getColumns() Get Column List
long	getCount() Returns a count of the items
Criterion<UJO>	getCriterion() Criterion
CriterionDecoder	getDecoder() Retuns a Criterion Decoder
int	getMaxRow() The max row for the resulset, default value 0 means an unlimited value
java.util.List<UjoProperty>	getOrder() Get the order item list.
Session	getSession() Session
java.sql.PreparedStatement	getStatement() Create a PreparedStatement include assigned parameter values
MetaTable	getTable() Returns table model
MetaTable	getTableModel() Table Type
boolean	isCountRequest() There is required to know a count of selected items before reading a resultset
boolean	isReadOnly() Result is a readOnly, default value is false
UjoIterator<UJO>	iterate() Create a new iterator by the query.
MetaColumn	readOrderColumn(int i) Returns an order column.
void	setCountRequest(boolean countRequest) There is required to know a count of selected items before reading a resultset
void	setMaxRow(int maxRow) The max row for the resulset, default value 0 means an unlimited value
Query<UJO>	setOrder(UjoProperty... order) Set the order item list to an SQL ORDER BY phrase.
<ITEM> void	setParameter(UjoProperty<UJO,ITEM> property, ITEM value)
void	setReadOnly(boolean readOnly) Result is a readOnly, default value is false

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(java.lang.Class<UJO> tableClass,
             Criterion<UJO> criterion,
             Session session)

Create new ORM query.

Parameters:

tableClass - Table can be null if the criterion parameter is not null and contains a table Property.

criterion - If criterion is null, then a TRUE constant criterion is used.

session - Session

Query

public Query(MetaTable table,
             Criterion<UJO> criterion,
             Session session)

Create new ORM query.

Parameters:

table - Table model

criterion - If criterion is null, then a TRUE constant criterion is used.

session - Session

Method Detail

getCount

public long getCount()

Returns a count of the items

setParameter

public <ITEM> void setParameter(UjoProperty<UJO,ITEM> property,
                                ITEM value)

isReadOnly

public boolean isReadOnly()

Result is a readOnly, default value is false

setReadOnly

public void setReadOnly(boolean readOnly)

Result is a readOnly, default value is false

isCountRequest

public boolean isCountRequest()

There is required to know a count of selected items before reading a resultset

setCountRequest

public void setCountRequest(boolean countRequest)

There is required to know a count of selected items before reading a resultset

getCriterion

public Criterion<UJO> getCriterion()

Criterion

getDecoder

public final CriterionDecoder getDecoder()

Retuns a Criterion Decoder

getSession

public Session getSession()

Session

getTableModel

public MetaTable getTableModel()

Table Type

getColumns

public java.util.List<MetaColumn> getColumns()

Get Column List

getColumn

public MetaColumn getColumn(int index)

Get Column List

iterate

public UjoIterator<UJO> iterate()

Create a new iterator by the query.

getOrder

public final java.util.List<UjoProperty> getOrder()

Get the order item list. The method returns a not null result allways.

getTable

public MetaTable getTable()

Returns table model

setOrder

public Query<UJO> setOrder(UjoProperty... order)

Set the order item list to an SQL ORDER BY phrase.

addOrder

public Query<UJO> addOrder(UjoProperty property)

Add an item to the end of order list.

readOrderColumn

public MetaColumn readOrderColumn(int i)

Returns an order column. A method for an internal use only.

getMaxRow

public int getMaxRow()

The max row for the resulset, default value 0 means an unlimited value

setMaxRow

public void setMaxRow(int maxRow)

The max row for the resulset, default value 0 means an unlimited value

getStatement

public java.sql.PreparedStatement getStatement()

Create a PreparedStatement include assigned parameter values