com.evolveum.midpoint.prism.delta

Class PropertyDelta<T>

java.lang.Object

com.evolveum.midpoint.prism.delta.ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

com.evolveum.midpoint.prism.delta.PropertyDelta<T>

All Implemented Interfaces:

Itemable, PathVisitable, Visitable, DebugDumpable, Serializable

public class PropertyDelta<T>
extends ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Relative difference (delta) of a property values.

This class describes what values are to be added, removed or replaced in the property. The delta can be either add+delete or replace, but not both. It either describes what values to add and delete from the property (add+delete) or what is the new set of values (replace). Add+delete deltas can be merged without a loss. There are ideal for multi-value properties. If replace deltas are merged, only the last value will be present. These are better suited for single-value properties.

Author:

Radovan Semancik

See Also:

ObjectDelta, Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.delta.ItemDelta

definition, elementName, estimatedOldValues, parentPath, valuesToAdd, valuesToDelete, valuesToReplace

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
PropertyDelta(ItemPath propertyPath, PrismPropertyDefinition<T> propertyDefinition, PrismContext prismContext)
PropertyDelta(ItemPath parentPath, QName name, PrismPropertyDefinition<T> propertyDefinition, PrismContext prismContext)
PropertyDelta(PrismPropertyDefinition<T> propertyDefinition, PrismContext prismContext)
PropertyDelta(QName name, PrismPropertyDefinition<T> propertyDefinition, PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDefinition(PrismPropertyDefinition<T> definition)
PropertyDelta<T>	clone()
protected void	copyValues(PropertyDelta<T> clone)
static <O extends Objectable> PropertyDelta	createAddDelta(PrismContainerDefinition<O> containerDefinition, QName propertyName, Object... realValues)
static <O extends Objectable> PropertyDelta	createDeleteDelta(PrismContainerDefinition<O> containerDefinition, QName propertyName, Object... realValues)
static <O extends Objectable,T> PropertyDelta<T>	createDelta(ItemPath propertyPath, Class<O> compileTimeClass, PrismContext prismContext)
static <O extends Objectable,T> PropertyDelta<T>	createDelta(ItemPath propertyPath, PrismObjectDefinition<O> objectDefinition)
static <O extends Objectable,T> PropertyDelta<T>	createDelta(QName propertyName, Class<O> compileTimeClass, PrismContext prismContext)
static <O extends Objectable,T> PropertyDelta<T>	createDelta(QName propertyName, PrismObjectDefinition<O> objectDefinition)
static <T> PropertyDelta<T>	createModificationAddProperty(ItemPath propertyPath, PrismPropertyDefinition propertyDefinition, T... propertyValues)
static <T> PropertyDelta<T>	createModificationDeleteProperty(ItemPath propertyPath, PrismPropertyDefinition propertyDefinition, T... propertyValues)
static <T> PropertyDelta<T>	createModificationReplaceProperty(ItemPath propertyPath, PrismObjectDefinition<?> objectDefinition, Collection<T> propertyValues)
static <T> PropertyDelta<T>	createModificationReplaceProperty(ItemPath propertyPath, PrismObjectDefinition<?> objectDefinition, T... propertyValues) Convenience method for quick creation of object deltas that replace a single object property.
static <T> PropertyDelta<T>	createModificationReplaceProperty(ItemPath propertyPath, PrismPropertyDefinition propertyDefinition, T... propertyValues)
static <T> PropertyDelta<T>	createModificationReplaceProperty(QName propertyName, PrismObjectDefinition<?> objectDefinition, T... propertyValues)
static Collection<? extends ItemDelta>	createModificationReplacePropertyCollection(QName propertyName, PrismObjectDefinition<?> objectDefinition, Object... propertyValues) Convenience method for quick creation of object deltas that replace a single object property.
static <O extends Objectable,T> PropertyDelta<T>	createReplaceDelta(PrismContainerDefinition<O> containerDefinition, QName propertyName, PrismPropertyValue<T>... pValues)
static <O extends Objectable,T> PropertyDelta<T>	createReplaceDelta(PrismContainerDefinition<O> containerDefinition, QName propertyName, T... realValues)
static <O extends Objectable,T> PropertyDelta<T>	createReplaceDeltaOrEmptyDelta(PrismObjectDefinition<O> objectDefinition, QName propertyName, T realValue)
static <O extends Objectable> PropertyDelta	createReplaceEmptyDelta(PrismObjectDefinition<O> objectDefinition, ItemPath propertyPath)
static <O extends Objectable> PropertyDelta	createReplaceEmptyDelta(PrismObjectDefinition<O> objectDefinition, QName propertyName) Create delta that deletes all values of the specified property.
static <T> PropertyDelta<T>	findPropertyDelta(Collection<? extends ItemDelta> modifications, ItemPath propertyPath)
static <T> PropertyDelta<T>	findPropertyDelta(Collection<? extends ItemDelta> modifications, QName propertyName)
T	getAnyRealValue()
Class<PrismProperty>	getItemClass()
PrismPropertyDefinition<T>	getPropertyDefinition()
PrismProperty<T>	getPropertyNewMatchingPath() Returns the "new" state of the property - the state that would be after the delta is applied.
PrismProperty<T>	getPropertyNewMatchingPath(PrismProperty<T> propertyOld) Returns the "new" state of the property - the state that would be after the delta is applied.
<T> Collection<PrismPropertyValue<T>>	getValues(Class<T> type) Returns all values regardless of whether they are added or removed or replaced.
<P extends PrismProperty> P	instantiateEmptyProperty()
protected boolean	isApplicableToType(Item item)
boolean	isRealValueToAdd(PrismPropertyValue<?> value)
boolean	isRealValueToDelete(PrismPropertyValue<?> value)
boolean	isRedundant(PrismObject<? extends Objectable> object, MatchingRule<T> matchingRule)
PropertyDelta<T>	narrow(PrismObject<? extends Objectable> object) Filters out all delta values that are meaningless to apply.
PropertyDelta<T>	narrow(PrismObject<? extends Objectable> object, MatchingRule<T> matchingRule)
void	setDefinition(PrismPropertyDefinition<T> definition)

Methods inherited from class com.evolveum.midpoint.prism.delta.ItemDelta

accept, accept, accept, accept, addAll, addEstimatedOldValue, addEstimatedOldValues, addEstimatedOldValues, addsAnyValue, addToReplaceDelta, addValuesToAdd, addValuesToAdd, addValuesToDelete, addValuesToDelete, addValueToAdd, addValueToDelete, addValueToReplace, applyDefinition, applyDefinition, applyTo, applyTo, applyTo, applyToMatchingPath, applyToMatchingPath, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, clear, clearValuesToAdd, clearValuesToDelete, clearValuesToReplace, cloneCollection, contains, containsEquivalentValue, copyValues, debugDump, debugDump, distributeReplace, dumpValues, equals, equivalent, findContainerDelta, findContainerDelta, findItemDelta, findItemDelta, findItemDeltasSubPath, findPropertyDelta, findReferenceModification, getAnyValue, getDefinition, getElementName, getEstimatedOldValues, getItemNew, getItemNew, getItemNewMatchingPath, getParentPath, getPath, getPrismContext, getSubDelta, getValuesToAdd, getValuesToDelete, getValuesToReplace, hasCompleteDefinition, hasEquivalent, hashCode, isAdd, isApplicableTo, isDelete, isEmpty, isEmpty, isRaw, isRedundant, isRedundant, isReplace, isValueEquivalent, isValueToAdd, isValueToAdd, isValueToDelete, isValueToDelete, isValueToReplace, isValueToReplace, merge, merge, mergeAll, mergeValuesToAdd, mergeValuesToAdd, mergeValuesToDelete, mergeValuesToDelete, mergeValuesToReplace, mergeValuesToReplace, mergeValueToAdd, mergeValueToDelete, mergeValueToReplace, narrow, normalize, removeItemDelta, removeItemDelta, removeValueToAdd, removeValueToDelete, removeValueToReplace, resetValuesToAdd, resetValuesToDelete, resetValuesToReplace, revive, setElementName, setEstimatedOldValues, setParentPath, setValuesToReplace, setValuesToReplace, setValueToReplace, setValueToReplace, simplify, toDeltaSetTriple, toDeltaSetTriple, toDeltaSetTriple, toDeltaSetTriple, toString, validate, validate

Methods inherited from class java.lang.Object

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

Property Detail

instantiateEmpty

Constructor Detail

PropertyDelta

public PropertyDelta(PrismPropertyDefinition<T> propertyDefinition,
             PrismContext prismContext)

PropertyDelta

public PropertyDelta(QName name,
             PrismPropertyDefinition<T> propertyDefinition,
             PrismContext prismContext)

PropertyDelta

public PropertyDelta(ItemPath parentPath,
             QName name,
             PrismPropertyDefinition<T> propertyDefinition,
             PrismContext prismContext)

PropertyDelta

public PropertyDelta(ItemPath propertyPath,
             PrismPropertyDefinition<T> propertyDefinition,
             PrismContext prismContext)

Method Detail

getPropertyDefinition

public PrismPropertyDefinition<T> getPropertyDefinition()

setDefinition

public void setDefinition(PrismPropertyDefinition<T> definition)

Overrides:

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

applyDefinition

public void applyDefinition(PrismPropertyDefinition<T> definition)
                     throws SchemaException

Overrides:

applyDefinition in class ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

Throws:

SchemaException

getItemClass

public Class<PrismProperty> getItemClass()

Specified by:

getItemClass in class ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

getValues

public <T> Collection<PrismPropertyValue<T>> getValues(Class<T> type)

Returns all values regardless of whether they are added or removed or replaced. Useful for iterating over all the changed values.

getAnyRealValue

public T getAnyRealValue()

instantiateEmptyProperty

public <P extends PrismProperty> P instantiateEmptyProperty()

isApplicableToType

protected boolean isApplicableToType(Item item)

Specified by:

isApplicableToType in class ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

clone

public PropertyDelta<T> clone()

Specified by:

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

copyValues

protected void copyValues(PropertyDelta<T> clone)

createReplaceDelta

public static <O extends Objectable,T> PropertyDelta<T> createReplaceDelta(PrismContainerDefinition<O> containerDefinition,
                                                           QName propertyName,
                                                           T... realValues)

createReplaceDelta

public static <O extends Objectable,T> PropertyDelta<T> createReplaceDelta(PrismContainerDefinition<O> containerDefinition,
                                                           QName propertyName,
                                                           PrismPropertyValue<T>... pValues)

createAddDelta

public static <O extends Objectable> PropertyDelta createAddDelta(PrismContainerDefinition<O> containerDefinition,
                                                  QName propertyName,
                                                  Object... realValues)

createDeleteDelta

public static <O extends Objectable> PropertyDelta createDeleteDelta(PrismContainerDefinition<O> containerDefinition,
                                                     QName propertyName,
                                                     Object... realValues)

createReplaceEmptyDelta

public static <O extends Objectable> PropertyDelta createReplaceEmptyDelta(PrismObjectDefinition<O> objectDefinition,
                                                           QName propertyName)

Create delta that deletes all values of the specified property.

createReplaceEmptyDelta

public static <O extends Objectable> PropertyDelta createReplaceEmptyDelta(PrismObjectDefinition<O> objectDefinition,
                                                           ItemPath propertyPath)

createReplaceDeltaOrEmptyDelta

public static <O extends Objectable,T> PropertyDelta<T> createReplaceDeltaOrEmptyDelta(PrismObjectDefinition<O> objectDefinition,
                                                                       QName propertyName,
                                                                       T realValue)

isRealValueToAdd

public boolean isRealValueToAdd(PrismPropertyValue<?> value)

isRealValueToDelete

public boolean isRealValueToDelete(PrismPropertyValue<?> value)

getPropertyNewMatchingPath

public PrismProperty<T> getPropertyNewMatchingPath()
                                            throws SchemaException

Returns the "new" state of the property - the state that would be after the delta is applied.

Throws:

SchemaException

getPropertyNewMatchingPath

public PrismProperty<T> getPropertyNewMatchingPath(PrismProperty<T> propertyOld)
                                            throws SchemaException

Returns the "new" state of the property - the state that would be after the delta is applied.

Throws:

SchemaException

narrow

public PropertyDelta<T> narrow(PrismObject<? extends Objectable> object)

Description copied from class: ItemDelta

Filters out all delta values that are meaningless to apply. E.g. removes all values to add that the property already has, removes all values to delete that the property does not have, etc.

Overrides:

narrow in class ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>

narrow

public PropertyDelta<T> narrow(PrismObject<? extends Objectable> object,
                      MatchingRule<T> matchingRule)

isRedundant

public boolean isRedundant(PrismObject<? extends Objectable> object,
                  MatchingRule<T> matchingRule)

createDelta

public static <O extends Objectable,T> PropertyDelta<T> createDelta(QName propertyName,
                                                    PrismObjectDefinition<O> objectDefinition)

createDelta

public static <O extends Objectable,T> PropertyDelta<T> createDelta(ItemPath propertyPath,
                                                    PrismObjectDefinition<O> objectDefinition)

createDelta

public static <O extends Objectable,T> PropertyDelta<T> createDelta(QName propertyName,
                                                    Class<O> compileTimeClass,
                                                    PrismContext prismContext)

createDelta

public static <O extends Objectable,T> PropertyDelta<T> createDelta(ItemPath propertyPath,
                                                    Class<O> compileTimeClass,
                                                    PrismContext prismContext)

createModificationReplaceProperty

public static <T> PropertyDelta<T> createModificationReplaceProperty(QName propertyName,
                                                     PrismObjectDefinition<?> objectDefinition,
                                                     T... propertyValues)

createModificationReplaceProperty

public static <T> PropertyDelta<T> createModificationReplaceProperty(ItemPath propertyPath,
                                                     PrismObjectDefinition<?> objectDefinition,
                                                     T... propertyValues)

Convenience method for quick creation of object deltas that replace a single object property. This is used quite often to justify a separate method.

createModificationReplaceProperty

public static <T> PropertyDelta<T> createModificationReplaceProperty(ItemPath propertyPath,
                                                     PrismObjectDefinition<?> objectDefinition,
                                                     Collection<T> propertyValues)

createModificationReplaceProperty

public static <T> PropertyDelta<T> createModificationReplaceProperty(ItemPath propertyPath,
                                                     PrismPropertyDefinition propertyDefinition,
                                                     T... propertyValues)

createModificationAddProperty

public static <T> PropertyDelta<T> createModificationAddProperty(ItemPath propertyPath,
                                                 PrismPropertyDefinition propertyDefinition,
                                                 T... propertyValues)

createModificationDeleteProperty

public static <T> PropertyDelta<T> createModificationDeleteProperty(ItemPath propertyPath,
                                                    PrismPropertyDefinition propertyDefinition,
                                                    T... propertyValues)

createModificationReplacePropertyCollection

public static Collection<? extends ItemDelta> createModificationReplacePropertyCollection(QName propertyName,
                                                                          PrismObjectDefinition<?> objectDefinition,
                                                                          Object... propertyValues)

Convenience method for quick creation of object deltas that replace a single object property. This is used quite often to justify a separate method.

findPropertyDelta

public static <T> PropertyDelta<T> findPropertyDelta(Collection<? extends ItemDelta> modifications,
                                     ItemPath propertyPath)

findPropertyDelta

public static <T> PropertyDelta<T> findPropertyDelta(Collection<? extends ItemDelta> modifications,
                                     QName propertyName)