com.evolveum.midpoint.prism

Class PrismContainer<C extends Containerable>

java.lang.Object

com.evolveum.midpoint.prism.Item<PrismContainerValue<C>,PrismContainerDefinition<C>>

com.evolveum.midpoint.prism.PrismContainer<C>

All Implemented Interfaces:

Itemable, PathVisitable, PrismContainerable<C>, Revivable, Visitable, DebugDumpable, Serializable

Direct Known Subclasses:

PrismObject, ResourceAttributeContainer

public class PrismContainer<C extends Containerable>
extends Item<PrismContainerValue<C>,PrismContainerDefinition<C>>
implements PrismContainerable<C>

Property container groups properties into logical blocks.The reason for grouping may be as simple as better understandability of data structure. But the group usually means different meaning, source or structure of the data. For example, the property container is frequently used to hold properties that are dynamic, not fixed by a static schema. Such grouping also naturally translates to XML and helps to "quarantine" such properties to avoid Unique Particle Attribute problems.

Property Container contains a set of (potentially multi-valued) properties or inner property containers. The order of properties is not significant, regardless of the fact that it may be fixed in the XML representation. In the XML representation, each element inside Property Container must be either Property or a Property Container.

Property Container is mutable.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<C>	compileTimeClass

Fields inherited from class com.evolveum.midpoint.prism.Item

definition, elementName, immutable, parent, prismContext, values

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

INDENT_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
	PrismContainer(QName name)
	PrismContainer(QName name, Class<C> compileTimeClass)
	PrismContainer(QName name, Class<C> compileTimeClass, PrismContext prismContext)
protected	PrismContainer(QName name, PrismContainerDefinition<C> definition, PrismContext prismContext)
	PrismContainer(QName name, PrismContext prismContext)

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor visitor, ItemPath path, boolean recursive)
void	add(Item<?,?> item) Convenience method.
boolean	add(PrismContainerValue newValue, boolean checkUniqueness)
protected String	additionalDumpDescription()
void	applyDefinition(PrismContainerDefinition<C> definition)
void	assertDefinitions(boolean tolarateRaw, String sourceDescription)
boolean	canRepresent(Class<?> compileTimeClass) Returns true if this object can represent specified compile-time class.
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
protected void	checkDefinition(PrismContainerDefinition<C> def)
PrismContainer<C>	clone()
boolean	containsEquivalentValue(PrismContainerValue<C> value)
boolean	containsItem(ItemPath itemPath, boolean acceptEmptyItem)
protected void	copyValues(PrismContainer<C> clone)
ContainerDelta<C>	createDelta() Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.
ContainerDelta<C>	createDelta(ItemPath path)
PrismContainerValue<C>	createNewValue()
static <V extends PrismContainerValue> void	createParentIfNeeded(V value, ItemDefinition definition)
String	debugDump(int indent)
PrismContainerDefinition<C>	deepCloneDefinition(boolean ultraDeep)
ContainerDelta<C>	diff(PrismContainer<C> other)
ContainerDelta<C>	diff(PrismContainer<C> other, boolean ignoreMetadata, boolean isLiteral)
List<? extends ItemDelta>	diffModifications(PrismContainer<C> other)
List<? extends ItemDelta>	diffModifications(PrismContainer<C> other, boolean ignoreMetadata, boolean isLiteral)
boolean	equals(Object obj) Note: hashcode and equals compare the objects in the "java way".
boolean	equivalent(Object obj) This method ignores some part of the object during comparison (e.g.
Object	find(ItemPath path)
<T extends Containerable> PrismContainer<T>	findContainer(ItemPath path)
<T extends Containerable> PrismContainer<T>	findContainer(QName containerName)
<IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID>	findItem(ItemPath path)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findItem(ItemPath path, Class<I> type)
<IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID>	findItem(QName itemQName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findItem(QName itemQName, Class<I> type)
<T extends Containerable> PrismContainer<T>	findOrCreateContainer(ItemPath containerPath)
<T extends Containerable> PrismContainer<T>	findOrCreateContainer(QName containerName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findOrCreateItem(ItemPath containerPath, Class<I> type)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findOrCreateItem(ItemPath containerPath, Class<I> type, ID definition)
<T> PrismProperty<T>	findOrCreateProperty(ItemPath propertyPath)
<T> PrismProperty<T>	findOrCreateProperty(QName propertyName)
PrismReference	findOrCreateReference(ItemPath propertyPath)
PrismReference	findOrCreateReference(QName propertyName)
<IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
<T> PrismProperty<T>	findProperty(ItemPath path)
<T> PrismProperty<T>	findProperty(QName propertyQName)
PrismReference	findReference(ItemPath path)
PrismReference	findReference(QName referenceQName)
PrismReference	findReferenceByCompositeObjectElementName(QName elementName)
PrismContainerValue<C>	findValue(long id)
Class<C>	getCompileTimeClass()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
PrismContainerDefinition<C>	getDefinition() Returns applicable property container definition.
PrismContainerValue<C>	getNextValue(PrismValue value) Returns values that is following the specified value.
PrismContainerValue<C>	getPreviousValue(PrismValue value) Returns value that is previous to the specified value.
<T> T	getPropertyRealValue(ItemPath propertyPath, Class<T> type)
<T> T	getPropertyRealValue(QName propertyName, Class<T> type)
C	getRealValue()
Collection<C>	getRealValues()
PrismContainerValue<C>	getValue()
PrismContainerValue<C>	getValue(Long id)
boolean	hasCompleteDefinition() Returns true if the object and all contained prisms have proper definition.
int	hashCode() Note: hashcode and equals compare the objects in the "java way".
boolean	isEmpty()
void	mergeValue(PrismContainerValue<C> otherValue)
void	mergeValues(Collection<PrismContainerValue<C>> otherValues)
void	mergeValues(PrismContainer<C> other)
static <V extends Containerable> PrismContainer<V>	newInstance(PrismContext prismContext, QName type)
protected void	propagateDeepCloneDefinition(boolean ultraDeep, PrismContainerDefinition<C> clonedDef)
void	remove(Item<?,?> item) Convenience method.
void	removeContainer(ItemPath path)
void	removeContainer(QName containerQName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> void	removeItem(ItemPath path, Class<I> itemType)
void	removeProperty(ItemPath path)
void	removeProperty(QName propertyQName)
void	removeReference(ItemPath path)
void	removeReference(QName referenceQName)
void	setDefinition(PrismContainerDefinition<C> definition) Sets applicable property container definition.
void	setPropertyRealValue(QName propertyName, Object realValue)
void	setValue(PrismContainerValue<C> value)
String	toString()
void	trim() Remove all empty values

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

accept, add, addAll, applyDefinition, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkMutability, clear, cloneCollection, contains, contains, contains, containsRealValue, copyValues, createNewDefinitionlessItem, debugDump, diff, diff, diffInternal, equalsRealValue, filterValues, findValue, fixupDelta, getClonedValues, getDisplayName, getElementName, getHelp, getParent, getPath, getPrismContext, getPrismContextLocal, getUserData, getUserData, getValue, getValues, hasRaw, hasRealValue, hasValue, hasValue, isImmutable, isRaw, isSingleValue, match, merge, normalize, remove, remove, removeAll, replace, replaceAll, resetParentCollection, revive, setElementName, setImmutable, setParent, setPrismContext, setUserData, size

Methods inherited from class java.lang.Object

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

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

getComplexTypeDefinition

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

getElementName, getPath, getPrismContext

Field Detail

compileTimeClass

protected Class<C extends Containerable> compileTimeClass

Constructor Detail

PrismContainer

public PrismContainer(QName name)

PrismContainer

public PrismContainer(QName name,
                      PrismContext prismContext)

PrismContainer

public PrismContainer(QName name,
                      Class<C> compileTimeClass)

PrismContainer

public PrismContainer(QName name,
                      Class<C> compileTimeClass,
                      PrismContext prismContext)

PrismContainer

protected PrismContainer(QName name,
                         PrismContainerDefinition<C> definition,
                         PrismContext prismContext)

Method Detail

getCompileTimeClass

public Class<C> getCompileTimeClass()

Specified by:

getCompileTimeClass in interface PrismContainerable<C extends Containerable>

canRepresent

public boolean canRepresent(Class<?> compileTimeClass)

Returns true if this object can represent specified compile-time class. I.e. this object can be presented in the compile-time form that is an instance of a specified class.

getRealValues

public Collection<C> getRealValues()

Specified by:

getRealValues in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

getRealValue

public C getRealValue()

Specified by:

getRealValue in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

getValue

public PrismContainerValue<C> getValue()

setValue

public void setValue(@NotNull
                     PrismContainerValue<C> value)
              throws SchemaException

Throws:

SchemaException

add

public boolean add(@NotNull
                   PrismContainerValue newValue,
                   boolean checkUniqueness)
            throws SchemaException

Overrides:

add in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

Throws:

SchemaException

getPreviousValue

public PrismContainerValue<C> getPreviousValue(PrismValue value)

Description copied from class: Item

Returns value that is previous to the specified value. Note that the order is semantically insignificant and this is used only for presentation consistency in order-sensitive formats such as XML or JSON.

Overrides:

getPreviousValue in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

getNextValue

public PrismContainerValue<C> getNextValue(PrismValue value)

Description copied from class: Item

Returns values that is following the specified value. Note that the order is semantically insignificant and this is used only for presentation consistency in order-sensitive formats such as XML or JSON.

Overrides:

getNextValue in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

getValue

public PrismContainerValue<C> getValue(Long id)

setPropertyRealValue

public void setPropertyRealValue(QName propertyName,
                                 Object realValue)
                          throws SchemaException

Throws:

SchemaException

getPropertyRealValue

public <T> T getPropertyRealValue(QName propertyName,
                                  Class<T> type)

getPropertyRealValue

public <T> T getPropertyRealValue(ItemPath propertyPath,
                                  Class<T> type)

add

public void add(Item<?,?> item)
         throws SchemaException

Convenience method. Works only on single-valued containers.

Throws:

SchemaException

createNewValue

public PrismContainerValue<C> createNewValue()

mergeValues

public void mergeValues(PrismContainer<C> other)
                 throws SchemaException

Throws:

SchemaException

mergeValues

public void mergeValues(Collection<PrismContainerValue<C>> otherValues)
                 throws SchemaException

Throws:

SchemaException

mergeValue

public void mergeValue(PrismContainerValue<C> otherValue)
                throws SchemaException

Throws:

SchemaException

trim

public void trim()

Remove all empty values

getDefinition

public PrismContainerDefinition<C> getDefinition()

Returns applicable property container definition.

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

Specified by:

getDefinition in interface Itemable

Specified by:

getDefinition in interface PrismContainerable<C extends Containerable>

Overrides:

getDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

Returns:

applicable property container definition

setDefinition

public void setDefinition(PrismContainerDefinition<C> definition)

Sets applicable property container definition.

Overrides:

setDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

Parameters:

definition - the definition to set

applyDefinition

public void applyDefinition(PrismContainerDefinition<C> definition)
                     throws SchemaException

Overrides:

applyDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

Throws:

SchemaException

findItem

public <IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I findItem(QName itemQName,
                                                                                          Class<I> type)

hasCompleteDefinition

public boolean hasCompleteDefinition()

Returns true if the object and all contained prisms have proper definition.

Overrides:

hasCompleteDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

find

public Object find(ItemPath path)

Specified by:

find in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

findPartial

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

Specified by:

findPartial in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

findItem

public <IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID> findItem(QName itemQName)

findItem

public <IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I findItem(ItemPath path,
                                                                                          Class<I> type)

findItem

public <IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID> findItem(ItemPath path)

containsItem

public boolean containsItem(ItemPath itemPath,
                            boolean acceptEmptyItem)
                     throws SchemaException

Throws:

SchemaException

findValue

public PrismContainerValue<C> findValue(long id)

findContainer

public <T extends Containerable> PrismContainer<T> findContainer(ItemPath path)

findContainer

public <T extends Containerable> PrismContainer<T> findContainer(QName containerName)

findProperty

public <T> PrismProperty<T> findProperty(ItemPath path)

findProperty

public <T> PrismProperty<T> findProperty(QName propertyQName)

findReference

public PrismReference findReference(ItemPath path)

findReference

public PrismReference findReference(QName referenceQName)

findReferenceByCompositeObjectElementName

public PrismReference findReferenceByCompositeObjectElementName(QName elementName)

findOrCreateItem

public <IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I findOrCreateItem(ItemPath containerPath,
                                                                                                  Class<I> type)
                                                                                           throws SchemaException

Throws:

SchemaException

findOrCreateItem

public <IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I findOrCreateItem(ItemPath containerPath,
                                                                                                  Class<I> type,
                                                                                                  ID definition)
                                                                                           throws SchemaException

Throws:

SchemaException

findOrCreateContainer

public <T extends Containerable> PrismContainer<T> findOrCreateContainer(ItemPath containerPath)
                                                                  throws SchemaException

Throws:

SchemaException

findOrCreateContainer

public <T extends Containerable> PrismContainer<T> findOrCreateContainer(QName containerName)
                                                                  throws SchemaException

Throws:

SchemaException

findOrCreateProperty

public <T> PrismProperty<T> findOrCreateProperty(ItemPath propertyPath)
                                          throws SchemaException

Throws:

SchemaException

findOrCreateProperty

public <T> PrismProperty<T> findOrCreateProperty(QName propertyName)
                                          throws SchemaException

Throws:

SchemaException

findOrCreateReference

public PrismReference findOrCreateReference(ItemPath propertyPath)
                                     throws SchemaException

Throws:

SchemaException

findOrCreateReference

public PrismReference findOrCreateReference(QName propertyName)
                                     throws SchemaException

Throws:

SchemaException

remove

public void remove(Item<?,?> item)

Convenience method. Works only on single-valued containers.

removeProperty

public void removeProperty(QName propertyQName)

removeProperty

public void removeProperty(ItemPath path)

removeContainer

public void removeContainer(QName containerQName)

removeContainer

public void removeContainer(ItemPath path)

removeReference

public void removeReference(QName referenceQName)

removeReference

public void removeReference(ItemPath path)

removeItem

public <IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> void removeItem(ItemPath path,
                                                                                               Class<I> itemType)

createDelta

public ContainerDelta<C> createDelta()

Description copied from class: Item

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

Specified by:

createDelta in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

createDelta

public ContainerDelta<C> createDelta(ItemPath path)

Specified by:

createDelta in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

checkDefinition

protected void checkDefinition(PrismContainerDefinition<C> def)

Specified by:

checkDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

checkConsistenceInternal

public void checkConsistenceInternal(Itemable rootItem,
                                     boolean requireDefinitions,
                                     boolean prohibitRaw,
                                     ConsistencyCheckScope scope)

Overrides:

checkConsistenceInternal in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

assertDefinitions

public void assertDefinitions(boolean tolarateRaw,
                              String sourceDescription)
                       throws SchemaException

Overrides:

assertDefinitions in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

Throws:

SchemaException

diff

public ContainerDelta<C> diff(PrismContainer<C> other)

diff

public ContainerDelta<C> diff(PrismContainer<C> other,
                              boolean ignoreMetadata,
                              boolean isLiteral)

diffModifications

public List<? extends ItemDelta> diffModifications(PrismContainer<C> other)

diffModifications

public List<? extends ItemDelta> diffModifications(PrismContainer<C> other,
                                                   boolean ignoreMetadata,
                                                   boolean isLiteral)

clone

public PrismContainer<C> clone()

Specified by:

clone in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

copyValues

protected void copyValues(PrismContainer<C> clone)

deepCloneDefinition

public PrismContainerDefinition<C> deepCloneDefinition(boolean ultraDeep)

propagateDeepCloneDefinition

protected void propagateDeepCloneDefinition(boolean ultraDeep,
                                            PrismContainerDefinition<C> clonedDef)

Overrides:

propagateDeepCloneDefinition in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

containsEquivalentValue

public boolean containsEquivalentValue(PrismContainerValue<C> value)

Overrides:

containsEquivalentValue in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

accept

public void accept(Visitor visitor,
                   ItemPath path,
                   boolean recursive)

Specified by:

accept in interface PathVisitable

Overrides:

accept in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

hashCode

public int hashCode()

Note: hashcode and equals compare the objects in the "java way". That means the objects must be almost precisely equal to match (e.g. including source demarcation in values and other "annotations"). For a method that compares the "meaningful" parts of the objects see equivalent().

Overrides:

hashCode in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

equals

public boolean equals(Object obj)

Note: hashcode and equals compare the objects in the "java way". That means the objects must be almost precisely equal to match (e.g. including source demarcation in values and other "annotations"). For a method that compares the "meaningful" parts of the objects see equivalent().

Overrides:

equals in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

equivalent

public boolean equivalent(Object obj)

This method ignores some part of the object during comparison (e.g. source demarcation in values) These methods compare the "meaningful" parts of the objects.

toString

public String toString()

Overrides:

toString in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

additionalDumpDescription

protected String additionalDumpDescription()

newInstance

public static <V extends Containerable> PrismContainer<V> newInstance(PrismContext prismContext,
                                                                      QName type)
                                                               throws SchemaException

Throws:

SchemaException

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class Item<PrismContainerValue<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>

createParentIfNeeded

public static <V extends PrismContainerValue> void createParentIfNeeded(V value,
                                                                        ItemDefinition definition)
                                                                 throws SchemaException

Throws:

SchemaException