Package com.evolveum.midpoint.prism.impl.query

Class ObjectPagingImpl

java.lang.Object

com.evolveum.midpoint.prism.impl.query.ObjectPagingImpl

All Implemented Interfaces:

ObjectPaging, DebugDumpable, Serializable

public final class ObjectPagingImpl
extends Object
implements ObjectPaging

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	addGroupingInstruction(ItemPath groupBy)
void	addOrderingInstruction(ItemPath orderBy, OrderDirection direction)
ObjectPaging	clone()
static ObjectPaging	createEmptyPaging()
static ObjectPaging	createPaging(ItemPath groupBy)
static ObjectPaging	createPaging(ItemPath orderBy, OrderDirection direction)
static ObjectPaging	createPaging(ItemPath orderBy, OrderDirection direction, ItemPath groupBy)
static ObjectPaging	createPaging(Integer offset, Integer maxSize)
static ObjectPaging	createPaging(Integer offset, Integer maxSize, ItemPath groupBy)
static ObjectPaging	createPaging(Integer offset, Integer maxSize, ItemPath orderBy, OrderDirection direction)
static ObjectPaging	createPaging(Integer offset, Integer maxSize, ItemPath orderBy, OrderDirection direction, ItemPath groupBy)
static ObjectPaging	createPaging(Integer offset, Integer maxSize, List<ObjectOrdering> orderings)
static ObjectPaging	createPaging(Integer offset, Integer maxSize, List<ObjectOrdering> orderings, List<ObjectGrouping> groupings)
String	debugDump()	Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
boolean	equals(Object o)
boolean	equals(Object o, boolean exact)
String	getCookie()	Returns the paging cookie.
OrderDirection	getDirection()
ItemPath	getGroupBy()
List<? extends ObjectGrouping>	getGroupingInstructions()
Integer	getMaxSize()
Integer	getOffset()
ItemPath	getOrderBy()
List<? extends ObjectOrdering>	getOrderingInstructions()
ObjectGrouping	getPrimaryGrouping()
ObjectOrdering	getPrimaryOrdering()
boolean	hasCookie()
boolean	hasGrouping()
int	hashCode()
boolean	hasOrdering()
void	setCookie(String cookie)	Sets paging cookie.
void	setGrouping(ItemPath groupBy)
void	setGrouping(ObjectGrouping... groupings)
void	setGrouping(Collection<ObjectGrouping> groupings)
void	setMaxSize(Integer maxSize)
void	setOffset(Integer offset)
void	setOrdering(ItemPath orderBy, OrderDirection direction)
void	setOrdering(ObjectOrdering... orderings)
void	setOrdering(Collection<? extends ObjectOrdering> orderings)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDumpLazily, debugDumpLazily

Method Detail

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize)

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize,
                                        ItemPath orderBy,
                                        OrderDirection direction)

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize,
                                        ItemPath groupBy)

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize,
                                        ItemPath orderBy,
                                        OrderDirection direction,
                                        ItemPath groupBy)

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize,
                                        List<ObjectOrdering> orderings)

createPaging

public static ObjectPaging createPaging(Integer offset,
                                        Integer maxSize,
                                        List<ObjectOrdering> orderings,
                                        List<ObjectGrouping> groupings)

createPaging

public static ObjectPaging createPaging(ItemPath orderBy,
                                        OrderDirection direction)

createPaging

public static ObjectPaging createPaging(ItemPath orderBy,
                                        OrderDirection direction,
                                        ItemPath groupBy)

createPaging

public static ObjectPaging createPaging(ItemPath groupBy)

createEmptyPaging

public static ObjectPaging createEmptyPaging()

getDirection

public OrderDirection getDirection()

Specified by:

getDirection in interface ObjectPaging

getOrderBy

public ItemPath getOrderBy()

Specified by:

getOrderBy in interface ObjectPaging

getPrimaryOrdering

public ObjectOrdering getPrimaryOrdering()

Specified by:

getPrimaryOrdering in interface ObjectPaging

getGroupBy

public ItemPath getGroupBy()

Specified by:

getGroupBy in interface ObjectPaging

getPrimaryGrouping

public ObjectGrouping getPrimaryGrouping()

Specified by:

getPrimaryGrouping in interface ObjectPaging

getOrderingInstructions

public List<? extends ObjectOrdering> getOrderingInstructions()

Specified by:

getOrderingInstructions in interface ObjectPaging

getGroupingInstructions

public List<? extends ObjectGrouping> getGroupingInstructions()

Specified by:

getGroupingInstructions in interface ObjectPaging

hasOrdering

public boolean hasOrdering()

Specified by:

hasOrdering in interface ObjectPaging

setOrdering

public void setOrdering(ItemPath orderBy,
                        OrderDirection direction)

Specified by:

setOrdering in interface ObjectPaging

hasGrouping

public boolean hasGrouping()

Specified by:

hasGrouping in interface ObjectPaging

setGrouping

public void setGrouping(ItemPath groupBy)

Specified by:

setGrouping in interface ObjectPaging

addOrderingInstruction

public void addOrderingInstruction(ItemPath orderBy,
                                   OrderDirection direction)

Specified by:

addOrderingInstruction in interface ObjectPaging

setOrdering

public void setOrdering(ObjectOrdering... orderings)

Specified by:

setOrdering in interface ObjectPaging

setOrdering

public void setOrdering(Collection<? extends ObjectOrdering> orderings)

Specified by:

setOrdering in interface ObjectPaging

addGroupingInstruction

public void addGroupingInstruction(ItemPath groupBy)

Specified by:

addGroupingInstruction in interface ObjectPaging

setGrouping

public void setGrouping(ObjectGrouping... groupings)

Specified by:

setGrouping in interface ObjectPaging

setGrouping

public void setGrouping(Collection<ObjectGrouping> groupings)

Specified by:

setGrouping in interface ObjectPaging

getOffset

public Integer getOffset()

Specified by:

getOffset in interface ObjectPaging

setOffset

public void setOffset(Integer offset)

Specified by:

setOffset in interface ObjectPaging

getMaxSize

public Integer getMaxSize()

Specified by:

getMaxSize in interface ObjectPaging

setMaxSize

public void setMaxSize(Integer maxSize)

Specified by:

setMaxSize in interface ObjectPaging

hasCookie

public boolean hasCookie()

Specified by:

hasCookie in interface ObjectPaging

getCookie

public String getCookie()

Returns the paging cookie. The paging cookie is used for optimization of paged searches. The presence of the cookie may allow the data store to correlate queries and associate them with the same server-side context. This may allow the data store to reuse the same pre-computed data. We want this as the sorted and paged searches may be quite expensive. It is expected that the cookie returned from the search will be passed back in the options when the next page of the same search is requested. It is OK to initialize a search without any cookie. If the datastore utilizes a re-usable context it will return a cookie in a search response.

Specified by:

getCookie in interface ObjectPaging

setCookie

public void setCookie(String cookie)

Sets paging cookie. The paging cookie is used for optimization of paged searches. The presence of the cookie may allow the data store to correlate queries and associate them with the same server-side context. This may allow the data store to reuse the same pre-computed data. We want this as the sorted and paged searches may be quite expensive. It is expected that the cookie returned from the search will be passed back in the options when the next page of the same search is requested. It is OK to initialize a search without any cookie. If the datastore utilizes a re-usable context it will return a cookie in a search response.

Specified by:

setCookie in interface ObjectPaging

clone

public ObjectPaging clone()

Specified by:

clone in interface ObjectPaging

Overrides:

clone in class Object

debugDump

public String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(Object o,
                      boolean exact)

Specified by:

equals in interface ObjectPaging

hashCode

public int hashCode()

Overrides:

hashCode in class Object