Package com.evolveum.midpoint.prism.impl

Class PrismPropertyImpl<T>

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

com.evolveum.midpoint.prism.impl.PrismPropertyImpl<T>

All Implemented Interfaces:

Freezable, Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>, Itemable, ItemDefinitionTransformer.TransformableItem, ParentVisitable, PathVisitable, PrismContextSensitive, PrismProperty<T>, Revivable, Visitable, DebugDumpable, Serializable

Direct Known Subclasses:

ResourceAttributeImpl

public class PrismPropertyImpl<T>
extends ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>
implements PrismProperty<T>

Property is a specific characteristic of an object. It may be considered object "attribute" or "field". For example User has fullName property that contains string value of user's full name.

Properties may be single-valued or multi-valued

Properties may contain primitive types or complex types (defined by XSD schema)

Property values are unordered, implementation may change the order of values

Duplicate values of properties should be silently removed by implementations, but clients must be able tolerate presence of duplicate values.

Operations that modify the objects work with the granularity of properties. They add/remove/replace the values of properties, but do not "see" inside the property.

Property is mutable.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.impl.ItemImpl

definition, elementName, incomplete, parent, values

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismPropertyImpl(QName name)
PrismPropertyImpl(QName name, PrismContext prismContext)
PrismPropertyImpl(QName name, PrismPropertyDefinition<T> definition, PrismContext prismContext)

Method Summary

Modifier and Type	Method	Description
boolean	add(@NotNull PrismPropertyValue<T> newValue)	Adds a given value, overwriting existing one.
void	addForced(@NotNull PrismPropertyValue<T> newValue)	Adds a given value with no checks, no definition application, and so on.
protected boolean	addInternalExecution(@NotNull PrismPropertyValue<T> newValue)
void	addRealValue(T valueToAdd)
void	addRealValueSkipUniquenessCheck(T valueToAdd)
void	addValue(PrismPropertyValue<T> pValueToAdd)
void	addValue(PrismPropertyValue<T> pValueToAdd, boolean checkUniqueness)
void	addValues(Collection<PrismPropertyValue<T>> pValuesToAdd)
protected void	checkDefinition(PrismPropertyDefinition<T> def)
void	clear()	Removes all values from the item.
PrismProperty<T>	clone()	Literal clone.
PrismProperty<T>	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
protected void	copyValues(CloneStrategy strategy, PrismPropertyImpl<T> clone)
PropertyDelta<T>	createDelta()	Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.
PropertyDelta<T>	createDelta(ItemPath path)
PrismProperty<T>	createImmutableClone()
String	debugDump(int indent)
boolean	deleteValue(PrismPropertyValue<T> pValueToDelete)
boolean	deleteValues(Collection<PrismPropertyValue<T>> pValuesToDelete)
PropertyDelta<T>	diff(PrismProperty<T> other)
PropertyDelta<T>	diff(PrismProperty<T> other, ParameterizedEquivalenceStrategy strategy)
Object	find(ItemPath path)	Returns object (Item or PrismValue) pointed to by the given path.
<IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
protected ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>	fixupDelta(ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> delta, Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>> otherItem)
T	getAnyRealValue()
protected String	getDebugDumpClassName()	Return a human-readable name of this class suitable for logs.
PrismPropertyDefinition<T>	getDefinition()	Returns applicable property definition.
T	getRealValue()	Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items.
@NotNull Collection<T>	getRealValues()	Returns (potentially empty) collection of "real values".
<X> Collection<X>	getRealValues(Class<X> type)	Type override, also for compatibility.
<X> PrismPropertyValue<X>	getValue(Class<X> type)	Type override, also for compatibility.
Class<T>	getValueClass()
<X> List<PrismPropertyValue<X>>	getValues(Class<X> type)	Type override, also for compatibility.
boolean	hasRealValue(PrismPropertyValue<T> value)
void	replaceValues(Collection<PrismPropertyValue<T>> valuesToReplace)
void	setDefinition(PrismPropertyDefinition<T> definition)	Sets applicable property definition.
void	setRealValue(T realValue)
void	setRealValues(T... realValues)
void	setValue(PrismPropertyValue<T> value)	Means as a short-hand for setting just a value for single-valued attributes.
String	toHumanReadableString()
String	toString()
protected void	valueRemoved(PrismPropertyValue<T> currentValue)

Methods inherited from class com.evolveum.midpoint.prism.impl.ItemImpl

accept, accept, acceptParentVisitor, add, addAll, addIgnoringEquivalents, addInternal, addRespectingMetadataAndCloning, appendDebugDumpSuffix, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, copyValues, diff, equals, equals, equals, getAllItems, getAllValues, getElementName, getHighestId, getParent, getPath, getPathComponent, getPrismContext, getPrismContextLocal, getRealValue, getRealValuesArray, getUserData, getUserData, getValue, getValues, hashCode, hashCode, hashCode, isIncomplete, merge, normalize, performFreeze, propagateDeepCloneDefinition, recomputeAllValues, remove, remove, removeAll, removeRespectingMetadata, replace, replaceAll, revive, setElementName, setIncomplete, setParent, setPrismContext, setUserData, transformDefinition

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

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

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

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

acceptParentVisitor, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, contains, contains, copy, diff, diff, equals, equals, equals, filterValues, filterYields, findValue, findValue, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDisplayName, getElementName, getHelp, getHighestId, getParent, getPath, getPrismContextLocal, getRealValue, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, getValue, getValues, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, setElementName, setIncomplete, setParent, setPrismContext, setUserData, size, valuesStream

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

accept

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

getPrismContext

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

addRealValues

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

revive

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

accept

Constructor Detail

PrismPropertyImpl

public PrismPropertyImpl(QName name)

PrismPropertyImpl

public PrismPropertyImpl(QName name,
                         PrismContext prismContext)

PrismPropertyImpl

public PrismPropertyImpl(QName name,
                         PrismPropertyDefinition<T> definition,
                         PrismContext prismContext)

Method Detail

getDefinition

public PrismPropertyDefinition<T> getDefinition()

Returns applicable property definition.

May return null if no definition is applicable or the definition is not know.

Specified by:

getDefinition in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

getDefinition in interface Itemable

Overrides:

getDefinition in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Returns:

applicable property definition

setDefinition

public void setDefinition(PrismPropertyDefinition<T> definition)

Sets applicable property definition. TODO remove (method in Item is sufficient)

Specified by:

setDefinition in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Overrides:

setDefinition in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Parameters:

definition - the definition to set

getValues

public <X> List<PrismPropertyValue<X>> getValues(Class<X> type)

Type override, also for compatibility.

Specified by:

getValues in interface PrismProperty<T>

getRealValues

@NotNull
public @NotNull Collection<T> getRealValues()

Description copied from interface: Item

Returns (potentially empty) collection of "real values".

Specified by:

getRealValues in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

getRealValues in interface PrismProperty<T>

getRealValues

public <X> Collection<X> getRealValues(Class<X> type)

Type override, also for compatibility.

Specified by:

getRealValues in interface PrismProperty<T>

getAnyRealValue

public T getAnyRealValue()

Specified by:

getAnyRealValue in interface PrismProperty<T>

getRealValue

public T getRealValue()

Description copied from interface: Item

Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items. It can also contain container IDs (although they are not considered to be part of the real value). It does not contain information about item element name nor other metadata like origin, definition, etc. (Although e.g. Containerable can be converted back into PrismContainerValue that can be used to retrieve this information.)

Specified by:

getRealValue in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

getRealValue in interface PrismProperty<T>

Overrides:

getRealValue in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

getValue

public <X> PrismPropertyValue<X> getValue(Class<X> type)

Type override, also for compatibility.

Specified by:

getValue in interface PrismProperty<T>

setValue

public void setValue(PrismPropertyValue<T> value)

Means as a short-hand for setting just a value for single-valued attributes. Will remove all existing values.

Specified by:

setValue in interface PrismProperty<T>

setRealValue

public void setRealValue(T realValue)

Specified by:

setRealValue in interface PrismProperty<T>

setRealValues

public void setRealValues(T... realValues)

Specified by:

setRealValues in interface PrismProperty<T>

addValues

public void addValues(Collection<PrismPropertyValue<T>> pValuesToAdd)

Specified by:

addValues in interface PrismProperty<T>

add

public boolean add(@NotNull
                   @NotNull PrismPropertyValue<T> newValue)
            throws SchemaException

Description copied from interface: Item

Adds a given value, overwriting existing one. It compares values using DEFAULT_FOR_EQUALS (DATA) strategy, so it e.g. takes value metadata differences into account. It is because this method is used during parsing, internal computations (typically using generated beans), and similar situations where we expect little sophistication when it comes to value comparison. The less surprises the better.

Specified by:

add in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Throws:

SchemaException

addValue

public void addValue(PrismPropertyValue<T> pValueToAdd)

Specified by:

addValue in interface PrismProperty<T>

addValue

public void addValue(PrismPropertyValue<T> pValueToAdd,
                     boolean checkUniqueness)

addInternalExecution

protected boolean addInternalExecution(@NotNull
                                       @NotNull PrismPropertyValue<T> newValue)

Overrides:

addInternalExecution in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

addRealValue

public void addRealValue(T valueToAdd)

Specified by:

addRealValue in interface PrismProperty<T>

addRealValueSkipUniquenessCheck

public void addRealValueSkipUniquenessCheck(T valueToAdd)

Specified by:

addRealValueSkipUniquenessCheck in interface PrismProperty<T>

deleteValues

public boolean deleteValues(Collection<PrismPropertyValue<T>> pValuesToDelete)

Specified by:

deleteValues in interface PrismProperty<T>

deleteValue

public boolean deleteValue(PrismPropertyValue<T> pValueToDelete)

Specified by:

deleteValue in interface PrismProperty<T>

replaceValues

public void replaceValues(Collection<PrismPropertyValue<T>> valuesToReplace)

Specified by:

replaceValues in interface PrismProperty<T>

hasRealValue

public boolean hasRealValue(PrismPropertyValue<T> value)

Specified by:

hasRealValue in interface PrismProperty<T>

getValueClass

public Class<T> getValueClass()

Specified by:

getValueClass in interface PrismProperty<T>

createDelta

public PropertyDelta<T> createDelta()

Description copied from interface: Item

Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g. PropertyDelta, ContainerDelta, ...)

Specified by:

createDelta in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

createDelta in interface PrismProperty<T>

createDelta

public PropertyDelta<T> createDelta(ItemPath path)

Specified by:

createDelta in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

createDelta in interface PrismProperty<T>

find

public Object find(ItemPath path)

Description copied from interface: Item

Returns object (Item or PrismValue) pointed to by the given path.

Specified by:

find in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

findPartial

public <IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID> findPartial(ItemPath path)

Specified by:

findPartial in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

findPartial in interface PrismProperty<T>

diff

public PropertyDelta<T> diff(PrismProperty<T> other)

Specified by:

diff in interface PrismProperty<T>

diff

public PropertyDelta<T> diff(PrismProperty<T> other,
                             ParameterizedEquivalenceStrategy strategy)

Specified by:

diff in interface PrismProperty<T>

checkDefinition

protected void checkDefinition(PrismPropertyDefinition<T> def)

Specified by:

checkDefinition in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

clone

public PrismProperty<T> clone()

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

clone in interface PrismProperty<T>

Specified by:

clone in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

createImmutableClone

public PrismProperty<T> createImmutableClone()

Specified by:

createImmutableClone in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

createImmutableClone in interface PrismProperty<T>

Overrides:

createImmutableClone in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

cloneComplex

public PrismProperty<T> cloneComplex(CloneStrategy strategy)

Description copied from interface: Item

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Specified by:

cloneComplex in interface PrismProperty<T>

See Also:

CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
                          PrismPropertyImpl<T> clone)

fixupDelta

protected ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> fixupDelta(ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> delta,
                                                                                       Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>> otherItem)

Overrides:

fixupDelta in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

toString

public String toString()

Overrides:

toString in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

toHumanReadableString

public String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismProperty<T>

getDebugDumpClassName

protected String getDebugDumpClassName()

Return a human-readable name of this class suitable for logs.

Overrides:

getDebugDumpClassName in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

addForced

public void addForced(@NotNull
                      @NotNull PrismPropertyValue<T> newValue)

Description copied from class: ItemImpl

Adds a given value with no checks, no definition application, and so on. For internal use only.

Overrides:

addForced in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

valueRemoved

protected void valueRemoved(PrismPropertyValue<T> currentValue)

Overrides:

valueRemoved in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

clear

public void clear()

Description copied from interface: Item

Removes all values from the item.

Specified by:

clear in interface Item<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Overrides:

clear in class ItemImpl<PrismPropertyValue<T>,PrismPropertyDefinition<T>>