ome.parameters

Class Filter

java.lang.Object

ome.parameters.Filter

All Implemented Interfaces:

Serializable

public class Filter
extends Object
implements Serializable

parameter to generally reduce the size of a query result set.

Since:

3.0-M2

Version:

3.0 (Internal version: $Revision$ $Date$)

Author:

Josh Moore josh.moore@gmx.de

See Also:

ome.parameters.Page, ome.parameters.Order, , Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Timestamp	endTime
Integer	limit
Integer	offset
Timestamp	startTime

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Methods

Modifier and Type	Method and Description
long	group()
Filter	group(long groupId)
boolean	isUnique() check uniqueness for this query.
long	owner()
Filter	owner(long ownerId)
Filter	page(Integer offset, Integer limit)
String	toString()
Filter	unique() state that this Filter should only return a single value if possible.

Methods inherited from class java.lang.Object

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

Field Detail

limit

public Integer limit

offset

public Integer offset

startTime

public Timestamp startTime

endTime

public Timestamp endTime

Constructor Detail

Filter

public Filter()

Method Detail

page

public Filter page(Integer offset,
          Integer limit)

unique

public Filter unique()

state that this Filter should only return a single value if possible. By default, a Filter will make no assumptions regarding the uniquesness of a query.

isUnique

public boolean isUnique()

check uniqueness for this query. Participating queries will attempt to call uniqueResult rather than list. This may throw a ValidationException on execution.

owner

public Filter owner(long ownerId)

owner

public long owner()

group

public Filter group(long groupId)

group

public long group()

toString

public String toString()

Overrides:

toString in class Object