com.evolveum.midpoint.prism

Class Item<V extends PrismValue,D extends ItemDefinition>

java.lang.Object

com.evolveum.midpoint.prism.Item<V,D>

All Implemented Interfaces:

Itemable, PathVisitable, Revivable, Visitable, DebugDumpable, Serializable

Direct Known Subclasses:

PrismContainer, PrismProperty, PrismReference

public abstract class Item<V extends PrismValue,D extends ItemDefinition>
extends Object
implements Itemable, DebugDumpable, Visitable, PathVisitable, Serializable, Revivable

Item is a common abstraction of Property and PropertyContainer.

This is supposed to be a superclass for all items. Items are things that can appear in property containers, which generally means only a property and property container itself. Therefore this is in fact superclass for those two definitions.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected D	definition
protected QName	elementName
protected PrismValue	parent
protected PrismContext	prismContext

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

INDENT_STRING

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor)
void	accept(Visitor visitor, ItemPath path, boolean recursive)
boolean	add(V newValue)
boolean	add(V newValue, boolean checkUniqueness)
boolean	addAll(Collection<V> newValues)
void	applyDefinition(D definition)
void	applyDefinition(D definition, boolean force)
void	assertDefinitions()
void	assertDefinitions(boolean tolarateRawValues, String sourceDescription)
void	assertDefinitions(String sourceDescription)
void	checkConsistence()
void	checkConsistence(boolean requireDefinitions, boolean prohibitRaw)
void	checkConsistence(boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
void	checkConsistence(boolean requireDefinitions, ConsistencyCheckScope scope)
void	checkConsistence(ConsistencyCheckScope scope)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
protected abstract void	checkDefinition(D def)
void	clear()
abstract Item	clone()
static <T extends Item> Collection<T>	cloneCollection(Collection<T> items)
boolean	contains(V value)
boolean	contains(V value, boolean ignoreMetadata)
boolean	contains(V value, boolean ignoreMetadata, Comparator<V> comparator)
boolean	containsEquivalentValue(V value)
boolean	containsRealValue(V value)
protected void	copyValues(Item clone)
abstract ItemDelta<V,D>	createDelta() Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.
abstract ItemDelta<V,D>	createDelta(ItemPath path)
static <T extends Item> T	createNewDefinitionlessItem(QName name, Class<T> type, PrismContext prismContext)
String	debugDump() Provide terse and readable dump of the object suitable for log (at debug level).
String	debugDump(int indent)
ItemDelta<V,D>	diff(Item<V,D> other)
ItemDelta<V,D>	diff(Item<V,D> other, boolean ignoreMetadata, boolean isLiteral)
protected void	diffInternal(Item<V,D> other, Collection<? extends ItemDelta> deltas, boolean ignoreMetadata, boolean isLiteral)
boolean	equals(Object obj)
boolean	equalsRealValue(Object obj)
abstract Object	find(ItemPath path)
abstract <IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
PrismValue	findValue(PrismValue value, boolean ignoreMetadata) Returns value that is equal or equivalent to the provided value.
protected ItemDelta<V,D>	fixupDelta(ItemDelta<V,D> delta, Item<V,D> other, boolean ignoreMetadata)
Collection<V>	getClonedValues()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
D	getDefinition() Returns applicable property definition.
String	getDisplayName() Returns a display name for the property type.
QName	getElementName() Returns the name of the property.
String	getHelp() Returns help message defined for the property type.
PrismValue	getNextValue(PrismValue value) Returns values that is following the specified value.
PrismValue	getParent()
ItemPath	getPath()
PrismValue	getPreviousValue(PrismValue value) Returns value that is previous to the specified value.
PrismContext	getPrismContext()
Map<String,Object>	getUserData()
Object	getUserData(String key)
V	getValue(int index)
List<V>	getValues()
boolean	hasCompleteDefinition()
int	hashCode()
boolean	hasRaw() Returns true is at least one of the values is raw.
boolean	hasRealValue(PrismValue value)
boolean	hasValue(PrismValue value)
boolean	hasValue(PrismValue value, boolean ignoreMetadata)
boolean	isEmpty()
boolean	isRaw() Returns true is all the values are raw.
boolean	isSingleValue()
boolean	match(Object obj)
void	merge(Item<V,D> otherItem) Merge all the values of other item to this item.
void	normalize()
protected void	propagateDeepCloneDefinition(boolean ultraDeep, D clonedDefinition)
V	remove(int index)
boolean	remove(V newValue)
boolean	removeAll(Collection<V> newValues)
void	replace(V newValue)
void	replaceAll(Collection<V> newValues)
static <T extends Item> Collection<T>	resetParentCollection(Collection<T> items) Sets all parents to null.
void	revive(PrismContext prismContext)
void	setDefinition(D definition) Sets applicable property definition.
void	setElementName(QName elementName) Sets the name of the property.
void	setParent(PrismValue parentValue)
void	setPrismContext(PrismContext prismContext)
void	setUserData(String key, Object value)
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

elementName

protected QName elementName

parent

protected PrismValue parent

definition

protected D extends ItemDefinition definition

prismContext

protected transient PrismContext prismContext

Method Detail

getDefinition

public D getDefinition()

Returns applicable property definition.

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

Specified by:

getDefinition in interface Itemable

Returns:

applicable property definition

hasCompleteDefinition

public boolean hasCompleteDefinition()

getElementName

public QName getElementName()

Returns the name of the property.

The name is a QName. It uniquely defines a property.

The name may be null, but such a property will not work.

The name is the QName of XML element in the XML representation.

Specified by:

getElementName in interface Itemable

Returns:

property name

setElementName

public void setElementName(QName elementName)

Sets the name of the property.

The name is a QName. It uniquely defines a property.

The name may be null, but such a property will not work.

The name is the QName of XML element in the XML representation.

Parameters:

name - the name to set

setDefinition

public void setDefinition(D definition)

Sets applicable property definition.

Parameters:

definition - the definition to set

getDisplayName

public String getDisplayName()

Returns a display name for the property type.

Returns null if the display name cannot be determined.

The display name is fetched from the definition. If no definition (schema) is available, the display name will not be returned.

Returns:

display name for the property type

getHelp

public String getHelp()

Returns help message defined for the property type.

Returns null if the help message cannot be determined.

The help message is fetched from the definition. If no definition (schema) is available, the help message will not be returned.

Returns:

help message for the property type

getPrismContext

public PrismContext getPrismContext()

Specified by:

getPrismContext in interface Itemable

setPrismContext

public void setPrismContext(PrismContext prismContext)

getParent

public PrismValue getParent()

setParent

public void setParent(PrismValue parentValue)

getPath

public ItemPath getPath()

Specified by:

getPath in interface Itemable

getUserData

public Map<String,Object> getUserData()

getUserData

public Object getUserData(String key)

setUserData

public void setUserData(String key,
               Object value)

getValues

public List<V> getValues()

getValue

public V getValue(int index)

hasValue

public boolean hasValue(PrismValue value,
               boolean ignoreMetadata)

hasValue

public boolean hasValue(PrismValue value)

hasRealValue

public boolean hasRealValue(PrismValue value)

isSingleValue

public boolean isSingleValue()

findValue

public PrismValue findValue(PrismValue value,
                   boolean ignoreMetadata)

Returns value that is equal or equivalent to the provided value. The returned value is an instance stored in this item, while the provided value argument may not be.

getPreviousValue

public PrismValue getPreviousValue(PrismValue value)

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.

getNextValue

public PrismValue getNextValue(PrismValue value)

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.

getClonedValues

public Collection<V> getClonedValues()

contains

public boolean contains(V value)

containsEquivalentValue

public boolean containsEquivalentValue(V value)

contains

public boolean contains(V value,
               boolean ignoreMetadata,
               Comparator<V> comparator)

contains

public boolean contains(V value,
               boolean ignoreMetadata)

containsRealValue

public boolean containsRealValue(V value)

size

public int size()

addAll

public boolean addAll(Collection<V> newValues)
               throws SchemaException

Throws:

SchemaException

add

public boolean add(V newValue)
            throws SchemaException

Throws:

SchemaException

add

public boolean add(V newValue,
          boolean checkUniqueness)
            throws SchemaException

Throws:

SchemaException

removeAll

public boolean removeAll(Collection<V> newValues)

remove

public boolean remove(V newValue)

remove

public V remove(int index)

replaceAll

public void replaceAll(Collection<V> newValues)
                throws SchemaException

Throws:

SchemaException

replace

public void replace(V newValue)

clear

public void clear()

normalize

public void normalize()

merge

public void merge(Item<V,D> otherItem)
           throws SchemaException

Merge all the values of other item to this item.

Throws:

SchemaException

find

public abstract Object find(ItemPath path)

findPartial

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

diff

public ItemDelta<V,D> diff(Item<V,D> other)

diff

public ItemDelta<V,D> diff(Item<V,D> other,
                  boolean ignoreMetadata,
                  boolean isLiteral)

diffInternal

protected void diffInternal(Item<V,D> other,
                Collection<? extends ItemDelta> deltas,
                boolean ignoreMetadata,
                boolean isLiteral)

fixupDelta

protected ItemDelta<V,D> fixupDelta(ItemDelta<V,D> delta,
                        Item<V,D> other,
                        boolean ignoreMetadata)

createDelta

public abstract ItemDelta<V,D> createDelta()

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

createDelta

public abstract ItemDelta<V,D> createDelta(ItemPath path)

accept

public void accept(Visitor visitor)

Specified by:

accept in interface Visitable

accept

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

Specified by:

accept in interface PathVisitable

applyDefinition

public void applyDefinition(D definition)
                     throws SchemaException

Throws:

SchemaException

applyDefinition

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

Throws:

SchemaException

revive

public void revive(PrismContext prismContext)
            throws SchemaException

Specified by:

revive in interface Revivable

Throws:

SchemaException

clone

public abstract Item clone()

Overrides:

clone in class Object

copyValues

protected void copyValues(Item clone)

propagateDeepCloneDefinition

protected void propagateDeepCloneDefinition(boolean ultraDeep,
                                D clonedDefinition)

cloneCollection

public static <T extends Item> Collection<T> cloneCollection(Collection<T> items)

resetParentCollection

public static <T extends Item> Collection<T> resetParentCollection(Collection<T> items)

Sets all parents to null. This is good if the items are to be "transplanted" into a different Containerable.

createNewDefinitionlessItem

public static <T extends Item> T createNewDefinitionlessItem(QName name,
                                             Class<T> type,
                                             PrismContext prismContext)

checkConsistence

public void checkConsistence(boolean requireDefinitions,
                    ConsistencyCheckScope scope)

checkConsistence

public void checkConsistence(boolean requireDefinitions,
                    boolean prohibitRaw)

checkConsistence

public void checkConsistence(boolean requireDefinitions,
                    boolean prohibitRaw,
                    ConsistencyCheckScope scope)

checkConsistence

public void checkConsistence()

checkConsistence

public void checkConsistence(ConsistencyCheckScope scope)

checkConsistenceInternal

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

checkDefinition

protected abstract void checkDefinition(D def)

assertDefinitions

public void assertDefinitions()
                       throws SchemaException

Throws:

SchemaException

assertDefinitions

public void assertDefinitions(String sourceDescription)
                       throws SchemaException

Throws:

SchemaException

assertDefinitions

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

Throws:

SchemaException

isRaw

public boolean isRaw()

Returns true is all the values are raw.

hasRaw

public boolean hasRaw()

Returns true is at least one of the values is raw.

isEmpty

public boolean isEmpty()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equalsRealValue

public boolean equalsRealValue(Object obj)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

match

public boolean match(Object obj)

toString

public String toString()

Overrides:

toString in class Object

debugDump

public String debugDump()

Provide terse and readable dump of the object suitable for log (at debug level).

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

getDebugDumpClassName

protected String getDebugDumpClassName()

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