com.evolveum.midpoint.prism

Class PrismContainerValue<C extends Containerable>

java.lang.Object

com.evolveum.midpoint.prism.PrismValue

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

All Implemented Interfaces:

PathVisitable, Revivable, Visitable, DebugDumpable, Serializable

public class PrismContainerValue<C extends Containerable>
extends PrismValue
implements DebugDumpable

Author:

semancik

See Also:

Serialized Form

Field Summary

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

domElement

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
PrismContainerValue()
PrismContainerValue(OriginType type, Objectable source, PrismContainerable container, Long id, QName concreteType, PrismContext prismContext)
PrismContainerValue(PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor)
void	accept(Visitor visitor, ItemPath path, boolean recursive)
<IV extends PrismValue,ID extends ItemDefinition> boolean	add(Item<IV,ID> item)
<IV extends PrismValue,ID extends ItemDefinition> boolean	add(Item<IV,ID> item, boolean checkUniquness) Adds an item to a property container.
void	addAll(Collection<? extends Item<?,?>> itemsToAdd) Adds a collection of items to a property container.
void	addAllReplaceExisting(Collection<? extends Item<?,?>> itemsToAdd) Adds a collection of items to a property container.
boolean	addRawElement(Object element)
<IV extends PrismValue,ID extends ItemDefinition> void	addReplaceExisting(Item<IV,ID> item) Adds an item to a property container.
void	applyDefinition(ItemDefinition definition, boolean force)
void	applyDefinition(PrismContainerDefinition<C> containerDef, boolean force)
C	asContainerable()
C	asContainerable(Class<C> defaultClazz)
void	assertDefinitions(boolean tolerateRaw, String sourceDescription)
void	assertDefinitions(String sourceDescription)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
void	clear()
PrismContainerValue<C>	clone()
boolean	contains(Item item)
boolean	contains(QName itemName)
static void	copyDefinition(Containerable aClone, Containerable original)
protected void	copyValues(PrismContainerValue<C> clone)
<X extends Containerable> PrismContainer<X>	createContainer(QName containerName)
<X> PrismProperty<X>	createProperty(PrismPropertyDefinition propertyDefinition)
<X> PrismProperty<X>	createProperty(QName propertyName)
String	debugDump() Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
protected void	deepCloneDefinition(boolean ultraDeep, PrismContainerDefinition<C> clonedContainerDef)
boolean	deleteRawElement(Object element)
boolean	equals(Object obj)
boolean	equalsComplex(PrismContainerValue<?> other, boolean ignoreMetadata, boolean isLiteral)
boolean	equalsComplex(PrismValue other, boolean ignoreMetadata, boolean isLiteral)
boolean	equivalent(PrismContainerValue<?> other)
Object	find(ItemPath path)
<X extends Containerable> PrismContainer<X>	findContainer(QName containerName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findItem(ItemDefinition itemDefinition, Class<I> type)
<IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID>	findItem(ItemPath itemPath)
<IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID>	findItem(QName itemName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findItem(QName itemName, Class<I> type)
<T extends Containerable> PrismContainer<T>	findOrCreateContainer(QName containerName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findOrCreateItem(ItemPath path, Class<I> type, ID definition)
<IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID>	findOrCreateItem(QName containerName)
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> I	findOrCreateItem(QName containerName, Class<I> type)
<X> PrismProperty<X>	findOrCreateProperty(ItemPath propertyPath)
<X> PrismProperty<X>	findOrCreateProperty(PrismPropertyDefinition propertyDef)
<X> PrismProperty<X>	findOrCreateProperty(QName propertyQName)
PrismReference	findOrCreateReference(QName referenceName)
<IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
<X> PrismProperty<X>	findProperty(ItemPath propertyPath)
<X> PrismProperty<X>	findProperty(PrismPropertyDefinition<X> propertyDefinition) Finds a specific property in the container by definition.
<X> PrismProperty<X>	findProperty(QName propertyQName)
PrismReference	findReference(QName elementName)
PrismReference	findReferenceByCompositeObjectElementName(QName elementName)
static <T extends Containerable> List<T>	fromPcvList(List<PrismContainerValue<T>> values)
QName	getConcreteType()
PrismContainerDefinition	getConcreteTypeDefinition()
PrismContainer<C>	getContainer()
protected PrismContainerDefinition<C>	getDefinition()
Long	getId()
List<Item<?,?>>	getItems() Returns a set of items that the property container contains.
Item<?,?>	getNextItem(Item<?,?> referenceItem)
PrismContainerable<C>	getParent()
ItemPath	getPath()
Item<?,?>	getPreviousItem(Item<?,?> referenceItem)
PrismContext	getPrismContext()
Set<PrismProperty<?>>	getProperties() Returns a set of properties that the property container contains.
Collection<QName>	getPropertyNames()
<T> T	getPropertyRealValue(QName propertyName, Class<T> type)
List<Object>	getRawElements()
MapXNode	getRawXNode()
C	getValue()
boolean	hasCompleteDefinition()
int	hashCode()
boolean	isEmpty()
boolean	isRaw() Returns true if the value is raw.
boolean	match(PrismValue otherValue)
<IV extends PrismValue,ID extends ItemDefinition> boolean	merge(Item<IV,ID> item) Merges the provided item into this item.
void	normalize()
void	recompute(PrismContext prismContext)
<IV extends PrismValue,ID extends ItemDefinition> void	remove(Item<IV,ID> item)
void	removeAll()
void	removeContainer(ItemPath itemPath)
void	removeContainer(QName containerName)
void	removeProperty(ItemPath propertyPath)
void	removeProperty(QName propertyName)
boolean	removeRawElement(Object element)
void	removeReference(ItemPath path)
void	removeReference(QName name)
<IV extends PrismValue,ID extends ItemDefinition> void	replace(Item<IV,ID> oldItem, Item<IV,ID> newItem)
boolean	representsSameValue(PrismContainerValue<C> other)
boolean	representsSameValue(PrismValue other) Returns true if this and other value represent the same value.
void	revive(PrismContext prismContext)
void	setConcreteType(QName concreteType)
void	setId(Long id)
void	setPropertyRealValue(QName propertyName, Object realValue, PrismContext prismContext)
<IV extends PrismValue,ID extends ItemDefinition> boolean	substract(Item<IV,ID> item) Substract the provided item from this item.
String	toHumanReadableString() Returns a short (one-line) representation of the real value stored in this object.
static <T extends Containerable> List<PrismContainerValue<T>>	toPcvList(List<T> beans)
String	toString()

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

appendOriginDump, applyDefinition, clearParent, clearParent, cloneCollection, cloneValues, containsRealValue, copyValues, diff, diff, equals, equals, equalsRealValue, equalsRealValue, equalsRealValues, getOriginObject, getOriginType, getRealValuesOfCollection, getUserData, getUserData, recompute, resetParentCollection, setOriginObject, setOriginType, setParent, setUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

PrismContainerValue

public PrismContainerValue()

PrismContainerValue

public PrismContainerValue(PrismContext prismContext)

PrismContainerValue

public PrismContainerValue(OriginType type,
                   Objectable source,
                   PrismContainerable container,
                   Long id,
                   QName concreteType,
                   PrismContext prismContext)

Method Detail

getPrismContext

public PrismContext getPrismContext()

Overrides:

getPrismContext in class PrismValue

getItems

public List<Item<?,?>> getItems()

Returns a set of items that the property container contains. The items may be properties or inner property containers.

The set may be null. In case there are no properties an empty set is returned.

Returned set is mutable. Live object is returned.

Returns:

set of items that the property container contains.

getNextItem

public Item<?,?> getNextItem(Item<?,?> referenceItem)

getPreviousItem

public Item<?,?> getPreviousItem(Item<?,?> referenceItem)

getProperties

public Set<PrismProperty<?>> getProperties()

Returns a set of properties that the property container contains.

The set must not be null. In case there are no properties an empty set is returned.

Returned set is immutable! Any change to it will be ignored.

Returns:

set of properties that the property container contains.

getId

public Long getId()

setId

public void setId(Long id)

getParent

public PrismContainerable<C> getParent()

Overrides:

getParent in class PrismValue

getContainer

public PrismContainer<C> getContainer()

getPath

public ItemPath getPath()

Overrides:

getPath in class PrismValue

getValue

public C getValue()

asContainerable

public C asContainerable()

asContainerable

public C asContainerable(Class<C> defaultClazz)

getPropertyNames

public Collection<QName> getPropertyNames()

add

public <IV extends PrismValue,ID extends ItemDefinition> boolean add(Item<IV,ID> item)
            throws SchemaException

Throws:

SchemaException

add

public <IV extends PrismValue,ID extends ItemDefinition> boolean add(Item<IV,ID> item,
                                                            boolean checkUniquness)
            throws SchemaException

Adds an item to a property container.

Parameters:

item - item to add.

Throws:

SchemaException

IllegalArgumentException - an attempt to add value that already exists

merge

public <IV extends PrismValue,ID extends ItemDefinition> boolean merge(Item<IV,ID> item)
              throws SchemaException

Merges the provided item into this item. The values are joined together. Returns true if new item or value was added.

Throws:

SchemaException

substract

public <IV extends PrismValue,ID extends ItemDefinition> boolean substract(Item<IV,ID> item)
                  throws SchemaException

Substract the provided item from this item. The values of the provided item are deleted from this item. Returns true if this item was changed.

Throws:

SchemaException

addReplaceExisting

public <IV extends PrismValue,ID extends ItemDefinition> void addReplaceExisting(Item<IV,ID> item)
                        throws SchemaException

Adds an item to a property container. Existing value will be replaced.

Parameters:

item - item to add.

Throws:

SchemaException

remove

public <IV extends PrismValue,ID extends ItemDefinition> void remove(Item<IV,ID> item)

removeAll

public void removeAll()

addAll

public void addAll(Collection<? extends Item<?,?>> itemsToAdd)
            throws SchemaException

Adds a collection of items to a property container.

Parameters:

itemsToAdd - items to add

Throws:

IllegalArgumentException - an attempt to add value that already exists

SchemaException

addAllReplaceExisting

public void addAllReplaceExisting(Collection<? extends Item<?,?>> itemsToAdd)
                           throws SchemaException

Adds a collection of items to a property container. Existing values will be replaced.

Parameters:

itemsToAdd - items to add

Throws:

SchemaException

replace

public <IV extends PrismValue,ID extends ItemDefinition> void replace(Item<IV,ID> oldItem,
                                                             Item<IV,ID> newItem)
             throws SchemaException

Throws:

SchemaException

clear

public void clear()

contains

public boolean contains(Item item)

contains

public boolean contains(QName itemName)

find

public Object find(ItemPath path)

Specified by:

find in class PrismValue

findPartial

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

Specified by:

findPartial in class PrismValue

findProperty

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

findProperty

public <X> PrismProperty<X> findProperty(ItemPath propertyPath)

findProperty

public <X> PrismProperty<X> findProperty(PrismPropertyDefinition<X> propertyDefinition)

Finds a specific property in the container by definition.

Returns null if nothing is found.

Parameters:

propertyDefinition - property definition to find.

Returns:

found property or null

findContainer

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

findReference

public PrismReference findReference(QName elementName)

findReferenceByCompositeObjectElementName

public PrismReference findReferenceByCompositeObjectElementName(QName elementName)

findItem

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

findItem

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

findItem

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

findItem

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

findOrCreateContainer

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

Throws:

SchemaException

findOrCreateReference

public PrismReference findOrCreateReference(QName referenceName)
                                     throws SchemaException

Throws:

SchemaException

findOrCreateItem

public <IV extends PrismValue,ID extends ItemDefinition> Item<IV,ID> findOrCreateItem(QName containerName)
                                                                       throws SchemaException

Throws:

SchemaException

findOrCreateItem

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

Throws:

SchemaException

findOrCreateItem

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

Throws:

SchemaException

findOrCreateProperty

public <X> PrismProperty<X> findOrCreateProperty(QName propertyQName)
                                      throws SchemaException

Throws:

SchemaException

findOrCreateProperty

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

Throws:

SchemaException

findOrCreateProperty

public <X> PrismProperty<X> findOrCreateProperty(PrismPropertyDefinition propertyDef)
                                      throws SchemaException

Throws:

SchemaException

createContainer

public <X extends Containerable> PrismContainer<X> createContainer(QName containerName)
                                                        throws SchemaException

Throws:

SchemaException

createProperty

public <X> PrismProperty<X> createProperty(QName propertyName)
                                throws SchemaException

Throws:

SchemaException

createProperty

public <X> PrismProperty<X> createProperty(PrismPropertyDefinition propertyDefinition)
                                throws SchemaException

Throws:

SchemaException

removeProperty

public void removeProperty(QName propertyName)

removeProperty

public void removeProperty(ItemPath propertyPath)

removeContainer

public void removeContainer(QName containerName)

removeContainer

public void removeContainer(ItemPath itemPath)

removeReference

public void removeReference(QName name)

removeReference

public void removeReference(ItemPath path)

setPropertyRealValue

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

Throws:

SchemaException

getPropertyRealValue

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

recompute

public void recompute(PrismContext prismContext)

Specified by:

recompute in class PrismValue

accept

public void accept(Visitor visitor)

Specified by:

accept in interface Visitable

Overrides:

accept in class PrismValue

accept

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

Specified by:

accept in interface PathVisitable

Overrides:

accept in class PrismValue

hasCompleteDefinition

public boolean hasCompleteDefinition()

representsSameValue

public boolean representsSameValue(PrismValue other)

Description copied from class: PrismValue

Returns true if this and other value represent the same value. E.g. if they have the same IDs, OIDs or it is otherwise know that they "belong together" without a deep examination of the values.

Overrides:

representsSameValue in class PrismValue

representsSameValue

public boolean representsSameValue(PrismContainerValue<C> other)

isRaw

public boolean isRaw()

Description copied from class: PrismValue

Returns true if the value is raw. Raw value is a semi-parsed value. A value for which we don't have a full definition yet and therefore the parsing could not be finished until the defintion is supplied.

Specified by:

isRaw in class PrismValue

getRawXNode

public MapXNode getRawXNode()

getRawElements

public List<Object> getRawElements()

addRawElement

public boolean addRawElement(Object element)
                      throws SchemaException

Throws:

SchemaException

deleteRawElement

public boolean deleteRawElement(Object element)
                         throws SchemaException

Throws:

SchemaException

removeRawElement

public boolean removeRawElement(Object element)

getDefinition

protected PrismContainerDefinition<C> getDefinition()

Overrides:

getDefinition in class PrismValue

applyDefinition

public void applyDefinition(ItemDefinition definition,
                   boolean force)
                     throws SchemaException

Overrides:

applyDefinition in class PrismValue

Throws:

SchemaException

applyDefinition

public void applyDefinition(PrismContainerDefinition<C> containerDef,
                   boolean force)
                     throws SchemaException

Throws:

SchemaException

revive

public void revive(PrismContext prismContext)
            throws SchemaException

Specified by:

revive in interface Revivable

Overrides:

revive in class PrismValue

Throws:

SchemaException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class PrismValue

normalize

public void normalize()

Overrides:

normalize in class PrismValue

checkConsistenceInternal

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

Specified by:

checkConsistenceInternal in class PrismValue

assertDefinitions

public void assertDefinitions(String sourceDescription)
                       throws SchemaException

Throws:

SchemaException

assertDefinitions

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

Throws:

SchemaException

clone

public PrismContainerValue<C> clone()

Specified by:

clone in class PrismValue

copyValues

protected void copyValues(PrismContainerValue<C> clone)

deepCloneDefinition

protected void deepCloneDefinition(boolean ultraDeep,
                       PrismContainerDefinition<C> clonedContainerDef)

equalsComplex

public boolean equalsComplex(PrismValue other,
                    boolean ignoreMetadata,
                    boolean isLiteral)

Overrides:

equalsComplex in class PrismValue

equalsComplex

public boolean equalsComplex(PrismContainerValue<?> other,
                    boolean ignoreMetadata,
                    boolean isLiteral)

equivalent

public boolean equivalent(PrismContainerValue<?> other)

equals

public boolean equals(Object obj)

Overrides:

equals in class PrismValue

hashCode

public int hashCode()

Overrides:

hashCode in class PrismValue

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

match

public boolean match(PrismValue otherValue)

Specified by:

match in class PrismValue

toHumanReadableString

public String toHumanReadableString()

Description copied from class: PrismValue

Returns a short (one-line) representation of the real value stored in this object. The value is returned without any decorations or type demarcations (such as PPV, PRV, etc.)

Specified by:

toHumanReadableString in class PrismValue

copyDefinition

public static void copyDefinition(Containerable aClone,
                  Containerable original)

getConcreteType

public QName getConcreteType()

setConcreteType

public void setConcreteType(QName concreteType)

getConcreteTypeDefinition

public PrismContainerDefinition getConcreteTypeDefinition()

toPcvList

public static <T extends Containerable> List<PrismContainerValue<T>> toPcvList(List<T> beans)

fromPcvList

public static <T extends Containerable> List<T> fromPcvList(List<PrismContainerValue<T>> values)