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

Class R_Filter

java.lang.Object

com.evolveum.midpoint.prism.impl.query.builder.R_Filter

All Implemented Interfaces:

S_FilterEntry, S_FilterEntryOrEmpty, S_FilterExit, S_QueryExit

public class R_Filter
extends Object
implements S_FilterEntryOrEmpty

Implementation of the top-level of the Query fluent API grammar (see QueryBuilder). See R_AtomicFilter for low-level filters.

Method Summary

Modifier and Type	Method	Description
S_FilterExit	all()
S_FilterEntry	and()
S_QueryExit	asc(ItemPath path)
S_QueryExit	asc(QName... names)
S_FilterEntryOrEmpty	block()
ObjectQuery	build()
ObjectFilter	buildFilter()
static S_FilterEntryOrEmpty	create(QueryBuilder builder)
static S_FilterEntryOrEmpty	create(QueryBuilder builder, PrismReferenceDefinition refDefinition)
S_QueryExit	desc(ItemPath path)
S_QueryExit	desc(QName... names)
S_FilterExit	endBlock()	Closes the S_FilterEntry.block() construction.
S_FilterEntryOrEmpty	exists(Object... components)
S_FilterExit	filter(ObjectFilter filter)
S_FilterExit	fullText(String... words)
<C> Class<C>	getCurrentClass()	Client-friendly getter that assumes the expected type.
PrismContext	getPrismContext()
protected boolean	hasRestriction()
S_FilterExit	id(long... identifiers)
S_FilterExit	id(String... identifiers)
S_FilterExit	isChildOf(PrismReferenceValue value)
S_FilterExit	isChildOf(String oid)
S_FilterExit	isDirectChildOf(PrismReferenceValue value)
S_FilterExit	isDirectChildOf(String oid)
S_FilterExit	isInScopeOf(PrismReferenceValue value, OrgFilter.Scope scope)
S_FilterExit	isInScopeOf(String oid, OrgFilter.Scope scope)
S_FilterExit	isParentOf(PrismReferenceValue value)
S_FilterExit	isParentOf(String oid)
S_FilterExit	isRoot()
S_ConditionEntry	item(ItemPath itemPath)
S_ConditionEntry	item(ItemPath itemPath, ItemDefinition<?> itemDefinition)
S_ConditionEntry	item(PrismContainerDefinition<?> containerDefinition, ItemPath itemPath)
S_ConditionEntry	item(PrismContainerDefinition<?> containerDefinition, QName... names)
S_ConditionEntry	item(String... names)
S_ConditionEntry	item(QName... names)
S_MatchingRuleEntry	itemAs(PrismProperty<?> property)
S_ConditionEntry	itemWithDef(ItemDefinition<?> itemDefinition, QName... names)
S_QueryExit	maxSize(Integer n)
S_FilterExit	none()
S_FilterEntry	not()
S_QueryExit	offset(Integer n)
S_FilterEntry	or()
com.evolveum.midpoint.prism.impl.query.builder.R_Filter.OwnedByEntry	ownedBy(Class<? extends Containerable> type, ItemPath path)
S_FilterExit	ownerId(long... identifiers)
S_FilterExit	ownerId(String... identifiers)
S_FilterEntryOrEmpty	ref(ItemPath path, QName targetType, QName relation, String... oids)	Ref filter with single value and optional ref-target filter that can follow this call immediately.
S_FilterEntryOrEmpty	referencedBy(@NotNull Class<? extends Containerable> type, @NotNull ItemPath path, QName relation)	Creates `referencedBy` filter that matches if the queried object is referenced by other specified object or container.
S_FilterEntryOrEmpty	type(@NotNull QName typeName)
S_FilterEntryOrEmpty	type(Class<? extends Containerable> type)
S_FilterExit	undefined()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.prism.query.builder.S_FilterEntry

ownedBy, ownedBy, ref, ref, referencedBy

Method Detail

create

public static S_FilterEntryOrEmpty create(QueryBuilder builder)

create

public static S_FilterEntryOrEmpty create(QueryBuilder builder,
                                          PrismReferenceDefinition refDefinition)

all

public S_FilterExit all()

Specified by:

all in interface S_FilterEntry

none

public S_FilterExit none()

Specified by:

none in interface S_FilterEntry

undefined

public S_FilterExit undefined()

Specified by:

undefined in interface S_FilterEntry

filter

public S_FilterExit filter(ObjectFilter filter)

Specified by:

filter in interface S_FilterEntry

id

public S_FilterExit id(String... identifiers)

Specified by:

id in interface S_FilterEntry

id

public S_FilterExit id(long... identifiers)

Specified by:

id in interface S_FilterEntry

ownerId

public S_FilterExit ownerId(String... identifiers)

Specified by:

ownerId in interface S_FilterEntry

ownerId

public S_FilterExit ownerId(long... identifiers)

Specified by:

ownerId in interface S_FilterEntry

isDirectChildOf

public S_FilterExit isDirectChildOf(PrismReferenceValue value)

Specified by:

isDirectChildOf in interface S_FilterEntry

isChildOf

public S_FilterExit isChildOf(PrismReferenceValue value)

Specified by:

isChildOf in interface S_FilterEntry

isParentOf

public S_FilterExit isParentOf(PrismReferenceValue value)

Specified by:

isParentOf in interface S_FilterEntry

isDirectChildOf

public S_FilterExit isDirectChildOf(String oid)

Specified by:

isDirectChildOf in interface S_FilterEntry

isChildOf

public S_FilterExit isChildOf(String oid)

Specified by:

isChildOf in interface S_FilterEntry

isInScopeOf

public S_FilterExit isInScopeOf(String oid,
                                OrgFilter.Scope scope)

Specified by:

isInScopeOf in interface S_FilterEntry

isInScopeOf

public S_FilterExit isInScopeOf(PrismReferenceValue value,
                                OrgFilter.Scope scope)

Specified by:

isInScopeOf in interface S_FilterEntry

isParentOf

public S_FilterExit isParentOf(String oid)

Specified by:

isParentOf in interface S_FilterEntry

isRoot

public S_FilterExit isRoot()

Specified by:

isRoot in interface S_FilterEntry

fullText

public S_FilterExit fullText(String... words)

Specified by:

fullText in interface S_FilterEntry

block

public S_FilterEntryOrEmpty block()

Specified by:

block in interface S_FilterEntry

type

public S_FilterEntryOrEmpty type(Class<? extends Containerable> type)

Specified by:

type in interface S_FilterEntry

referencedBy

public S_FilterEntryOrEmpty referencedBy(@NotNull
                                         @NotNull Class<? extends Containerable> type,
                                         @NotNull
                                         @NotNull ItemPath path,
                                         QName relation)

Description copied from interface: S_FilterEntry

Creates `referencedBy` filter that matches if the queried object is referenced by other specified object or container. This is a "blocky" filter that allows for inner filter, applied to the referencing entity. For example: ---- // query for role referenced by user assignment, with inner filter applied to user .referencedBy(UserType.class, ItemPath.create(F_ASSIGNMENT, F_TARGET_REF)) .block() .not().item(UserType.F_COST_CENTER).isNull() .and() .item(UserType.F_POLICY_SITUATION).isNull() .endBlock() ----

Specified by:

referencedBy in interface S_FilterEntry

Parameters:

type - type of the referenced object (can be an abstract type too)

path - item path of the reference

relation - optional relation of the incoming reference, null means it does not matter (any)

ref

public S_FilterEntryOrEmpty ref(ItemPath path,
                                QName targetType,
                                QName relation,
                                String... oids)

Description copied from interface: S_FilterEntry

Ref filter with single value and optional ref-target filter that can follow this call immediately. Use combo S_FilterEntry.item(ItemPath) and S_ConditionEntry.ref(PrismReferenceValue...) for simple REF filters and multi-value support.

Specified by:

ref in interface S_FilterEntry

ownedBy

public com.evolveum.midpoint.prism.impl.query.builder.R_Filter.OwnedByEntry ownedBy(Class<? extends Containerable> type,
                                                                                    ItemPath path)

Specified by:

ownedBy in interface S_FilterEntry

type

public S_FilterEntryOrEmpty type(@NotNull
                                 @NotNull QName typeName)

Specified by:

type in interface S_FilterEntry

exists

public S_FilterEntryOrEmpty exists(Object... components)

Specified by:

exists in interface S_FilterEntry

and

public S_FilterEntry and()

Specified by:

and in interface S_FilterExit

or

public S_FilterEntry or()

Specified by:

or in interface S_FilterExit

not

public S_FilterEntry not()

Specified by:

not in interface S_FilterEntry

item

public S_ConditionEntry item(QName... names)

Specified by:

item in interface S_FilterEntry

item

public S_ConditionEntry item(String... names)

Specified by:

item in interface S_FilterEntry

item

public S_ConditionEntry item(ItemPath itemPath)

Specified by:

item in interface S_FilterEntry

itemWithDef

public S_ConditionEntry itemWithDef(ItemDefinition<?> itemDefinition,
                                    QName... names)

Specified by:

itemWithDef in interface S_FilterEntry

item

public S_ConditionEntry item(ItemPath itemPath,
                             ItemDefinition<?> itemDefinition)

Specified by:

item in interface S_FilterEntry

item

public S_ConditionEntry item(PrismContainerDefinition<?> containerDefinition,
                             QName... names)

Specified by:

item in interface S_FilterEntry

item

public S_ConditionEntry item(PrismContainerDefinition<?> containerDefinition,
                             ItemPath itemPath)

Specified by:

item in interface S_FilterEntry

itemAs

public S_MatchingRuleEntry itemAs(PrismProperty<?> property)

Specified by:

itemAs in interface S_FilterEntry

endBlock

public S_FilterExit endBlock()

Description copied from interface: S_QueryExit

Closes the S_FilterEntry.block() construction. It is a bit high in hierarchy to allow empty block().end() construction without additional interface.

Specified by:

endBlock in interface S_QueryExit

hasRestriction

protected boolean hasRestriction()

asc

public S_QueryExit asc(QName... names)

Specified by:

asc in interface S_QueryExit

asc

public S_QueryExit asc(ItemPath path)

Specified by:

asc in interface S_QueryExit

desc

public S_QueryExit desc(QName... names)

Specified by:

desc in interface S_QueryExit

desc

public S_QueryExit desc(ItemPath path)

Specified by:

desc in interface S_QueryExit

offset

public S_QueryExit offset(Integer n)

Specified by:

offset in interface S_QueryExit

maxSize

public S_QueryExit maxSize(Integer n)

Specified by:

maxSize in interface S_QueryExit

build

public ObjectQuery build()

Specified by:

build in interface S_QueryExit

buildFilter

public ObjectFilter buildFilter()

Specified by:

buildFilter in interface S_QueryExit

getPrismContext

public PrismContext getPrismContext()

getCurrentClass

public <C> Class<C> getCurrentClass()

Client-friendly getter that assumes the expected type. This was created to make working with both containers and references easier.