com.edorasware.api.query

Interface HierarchyOperand

All Known Subinterfaces:

PathField

All Known Implementing Classes:

HierarchyOperandImpl, PathFieldImpl

public interface HierarchyOperand

Defines the methods to build hierarchy-specific Predicate instances.

Method Summary

Modifier and Type	Method and Description
Predicate	childOf(String id) Builds a predicate matching direct children of object with the given ID.
Predicate	childrenOf(Collection<String> ids) Builds a predicate matching direct children of the objects with the given IDs.
Predicate	descendantOf(String id) Builds a predicate matching all descendants of the object with the given ID.
Predicate	descendantOfOrEq(String id) Builds a predicate matching all descendants of the object with the given ID, including the parent object.
Predicate	isRoot() Builds a predicate matching objects at the root of the hierarchy (i.e. with no parent).
Ordering	orderAsc() Builds an ordering criterion which sorts by the operand value in ascending order.
Ordering	orderDesc() Builds an ordering criterion which sorts by the operand value in descending order.

Method Detail

descendantOf

Predicate descendantOf(String id)

Builds a predicate matching all descendants of the object with the given ID.

Parameters:

id - the id of the (direct or indirect) parent object

Returns:

the new predicate instance

descendantOfOrEq

Predicate descendantOfOrEq(String id)

Builds a predicate matching all descendants of the object with the given ID, including the parent object.

Parameters:

id - the id of the (direct or indirect) parent object

Returns:

the new predicate instance

childOf

Predicate childOf(String id)

Builds a predicate matching direct children of object with the given ID.

Parameters:

id - the id of the direct parent object

Returns:

the new predicate instance

childrenOf

Predicate childrenOf(Collection<String> ids)

Builds a predicate matching direct children of the objects with the given IDs.

Parameters:

ids - the ids of the direct parent objects

Returns:

the new predicate instance

isRoot

Predicate isRoot()

Builds a predicate matching objects at the root of the hierarchy (i.e. with no parent).

Returns:

the new predicate instance

orderAsc

Ordering orderAsc()

Builds an ordering criterion which sorts by the operand value in ascending order.

Returns:

the new ordering instance

orderDesc

Ordering orderDesc()

Builds an ordering criterion which sorts by the operand value in descending order.

Returns:

the new ordering instance