Package com.evolveum.midpoint.schema.selector.spec

Class ValueSelector

java.lang.Object

com.evolveum.midpoint.schema.selector.spec.ValueSelector

All Implemented Interfaces:

DebugDumpable, Serializable

public class ValueSelector
extends Object
implements DebugDumpable, Serializable

Parsed form of ObjectSelectorType and its subtypes. It was created to allow easy manipulation and (eventually) better performance due to optimized data structures. Immutable.

See Also:

• Serialized Form

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
ObjectFilter	computeFilter(@NotNull FilteringContext ctx)	Converts the clause into ObjectFilter.
String	debugDump(int indent)
static @NotNull ValueSelector	empty()	Covers all values.
static ValueSelector	forType(@NotNull QName typeName)
@Nullable ObjectSelectorType	getBean()
@NotNull List<SelectorClause>	getClauses()
@NotNull Class<?>	getEffectiveType()
String	getHumanReadableDesc()
@Nullable ParentClause	getParentClause()
@NotNull Class<?>	getTypeClass(@NotNull Class<?> superType)
@Nullable QName	getTypeName()
boolean	isParentLess()
boolean	isPureSelf()
boolean	isSubObject()
boolean	matches(@NotNull PrismValue value, @NotNull MatchingContext ctx)	Returns `true` if the `value` matches this selector.
static ValueSelector	of(@NotNull TypeClause typeClause, @NotNull ParentClause parentClause)
static ValueSelector	of(SelectorClause... clauses)
static @NotNull ValueSelector	parse(@NotNull ObjectSelectorType bean)	The bean is frozen during the parsing process.
ValueSelector	sameWithType(@NotNull QName newType)	Returns a selector that is the same as this one, except that the type is as specified.
boolean	toFilter(@NotNull FilteringContext ctx)	Converts the selector into ObjectFilter (passed to FilteringContext.filterCollector).
ValueSelector	withParentRemoved()	Returns a selector that is the same as this one (or even this one), except that it has no parent clause.

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.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Method Details

empty

@NotNull
public static @NotNull ValueSelector empty()

Covers all values.

of

public static ValueSelector of(@NotNull
 @NotNull TypeClause typeClause,
 @NotNull
 @NotNull ParentClause parentClause)

of

public static ValueSelector of(SelectorClause... clauses)

parse

@NotNull
public static @NotNull ValueSelector parse(@NotNull
 @NotNull ObjectSelectorType bean)
                                    throws ConfigurationException

The bean is frozen during the parsing process.

Throws:

ConfigurationException

forType

public static ValueSelector forType(@NotNull
 @NotNull QName typeName)

getTypeName

@Nullable
public @Nullable QName getTypeName()

getClauses

@NotNull
public @NotNull List<SelectorClause> getClauses()

getBean

@Nullable
public @Nullable ObjectSelectorType getBean()

matches

public boolean matches(@NotNull
 @NotNull PrismValue value,
 @NotNull
 @NotNull MatchingContext ctx)
                throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException

Returns `true` if the `value` matches this selector.

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

computeFilter

public ObjectFilter computeFilter(@NotNull
 @NotNull FilteringContext ctx)
                           throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException

Converts the clause into ObjectFilter. If not applicable, returns `none` filter.

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

toFilter

public boolean toFilter(@NotNull
 @NotNull FilteringContext ctx)
                 throws SchemaException,
ExpressionEvaluationException,
CommunicationException,
SecurityViolationException,
ConfigurationException,
ObjectNotFoundException

Converts the selector into ObjectFilter (passed to FilteringContext.filterCollector). Returns `false` if the selector is not applicable to given situation.

Throws:

SchemaException

ExpressionEvaluationException

CommunicationException

SecurityViolationException

ConfigurationException

ObjectNotFoundException

getParentClause

@Nullable
public @Nullable ParentClause getParentClause()

getEffectiveType

@NotNull
public @NotNull Class<?> getEffectiveType()

getTypeClass

@NotNull
public @NotNull Class<?> getTypeClass(@NotNull
 @NotNull Class<?> superType)
                               throws ConfigurationException

Throws:

ConfigurationException

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

getHumanReadableDesc

public String getHumanReadableDesc()

sameWithType

public ValueSelector sameWithType(@NotNull
 @NotNull QName newType)

Returns a selector that is the same as this one, except that the type is as specified. May return the same object if types are equal. The type must be qualified.

withParentRemoved

public ValueSelector withParentRemoved()

Returns a selector that is the same as this one (or even this one), except that it has no parent clause.

isSubObject

public boolean isSubObject()

isPureSelf

public boolean isPureSelf()

isParentLess

public boolean isParentLess()