Package com.evolveum.midpoint.prism.query

Interface ObjectFilter

All Superinterfaces:

DebugDumpable, Freezable, Revivable, Serializable

All Known Subinterfaces:

AllFilter, AndFilter, AnyInFilter<T>, ComparativeFilter<T>, EqualFilter<T>, ExistsFilter, FullTextFilter, FuzzyStringMatchFilter<T>, GreaterFilter<T>, InOidFilter, LessFilter<T>, LogicalFilter, NaryLogicalFilter, NoneFilter, NotFilter, OrFilter, OrgFilter, OwnedByFilter, PropertyValueFilter<T>, ReferencedByFilter, RefFilter, SubstringFilter<T>, TypeFilter, UnaryLogicalFilter, UndefinedFilter, ValueFilter<V,D>

All Known Implementing Classes:

AbstractItemFilter, AllFilterImpl, AndFilterImpl, AnyInFilterImpl, ComparativeFilterImpl, EqualFilterImpl, ExistsFilterImpl, FullTextFilterImpl, FuzzyStringMatchFilterImpl, GreaterFilterImpl, InOidFilterImpl, LessFilterImpl, LogicalFilterImpl, NaryLogicalFilterImpl, NoneFilterImpl, NotFilterImpl, ObjectFilterImpl, OrFilterImpl, OrgFilterImpl, OwnedByFilterImpl, PropertyValueFilterImpl, ReferencedByFilterImpl, RefFilterImpl, SubstringFilterImpl, TypeFilterImpl, UnaryLogicalFilterImpl, UndefinedFilterImpl, ValueFilterImpl

public interface ObjectFilter
extends DebugDumpable, Serializable, Revivable, Freezable

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)
void	checkConsistence(boolean requireDefinitions)
ObjectFilter	clone()	Does a SHALLOW clone.
void	collectUsedPaths(TypedItemPath base, Consumer<TypedItemPath> pathConsumer, boolean expandReferences)
static boolean	equals(@Nullable ObjectFilter filter, @Nullable Object other, boolean exact)	Utility method performing equals(Object, boolean) on two nullable objects.
boolean	equals(Object o, boolean exact)
boolean	match(PrismContainerValue<?> value, MatchingRuleRegistry matchingRuleRegistry)
default boolean	matchesOnly(ItemPath... paths)	Returns true, if filter processes only enumerated item paths and does not use referencedBy, ownedBy where path context changes drastically.
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static?
void	transformItemPaths(ItemPath parentPath, ItemDefinition<?> parentDef, FilterItemPathTransformer transformer)
default Collection<TypedItemPath>	usedPaths(TypedItemPath base, boolean expandReferences)

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

Method Details

clone

ObjectFilter clone()

Does a SHALLOW clone.

match

boolean match(PrismContainerValue<?> value,
 MatchingRuleRegistry matchingRuleRegistry)
       throws SchemaException

Throws:

SchemaException

accept

void accept(Visitor visitor)

revive

void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

checkConsistence

void checkConsistence(boolean requireDefinitions)

equals

boolean equals(Object o,
 boolean exact)

equals

static boolean equals(@Nullable
 @Nullable ObjectFilter filter,
 @Nullable
 @Nullable Object other,
 boolean exact)

Utility method performing equals(Object, boolean) on two nullable objects.

matchesOnly

@Experimental
default boolean matchesOnly(ItemPath... paths)

Returns true, if filter processes only enumerated item paths and does not use referencedBy, ownedBy where path context changes drastically. Useful to find if filter could be executed with limited set of information (e.g. only access to target name in RefFilter

usedPaths

default Collection<TypedItemPath> usedPaths(TypedItemPath base,
 boolean expandReferences)

collectUsedPaths

void collectUsedPaths(TypedItemPath base,
 Consumer<TypedItemPath> pathConsumer,
 boolean expandReferences)

transformItemPaths

void transformItemPaths(ItemPath parentPath,
 ItemDefinition<?> parentDef,
 FilterItemPathTransformer transformer)