com.evolveum.midpoint.prism

Class PrismObject<O extends Objectable>

java.lang.Object

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

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

com.evolveum.midpoint.prism.PrismObject<O>

All Implemented Interfaces:

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

public class PrismObject<O extends Objectable>
extends PrismContainer<O>

Common supertype for all identity objects. Defines basic properties that each object must have to live in our system (identifier, name). Objects consists of identifier and name (see definition below) and a set of properties represented as XML elements in the object's body. The attributes are represented as first-level XML elements (tags) of the object XML representation and may be also contained in other tags (e.g. extension, attributes). The QName (namespace and local name) of the element holding the property is considered to be a property name. This class is named PrismObject instead of Object to avoid confusion with java.lang.Object.

Author:

Radovan Semancik Class invariant: has at most one value (potentially empty). When making this object immutable and there's no value, we create one; in order to prevent exceptions on later getValue calls.

See Also:

Serialized Form

Field Summary

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

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

Constructor and Description
PrismObject(QName name, Class<O> compileTimeClass)
PrismObject(QName name, Class<O> compileTimeClass, PrismContext prismContext)
PrismObject(QName name, PrismObjectDefinition<O> definition, PrismContext prismContext)

Method Summary

Modifier and Type	Method and Description
boolean	add(PrismContainerValue newValue, boolean checkUniqueness)
<I extends Item> void	addExtensionItem(I item)
protected String	additionalDumpDescription()
void	addReplaceExisting(Item<?,?> item)
void	applyDefinition(PrismContainerDefinition<O> definition)
O	asObjectable()
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
PrismObject<O>	clone()
PrismObject<O>	cloneIfImmutable()
protected void	copyValues(PrismObject<O> clone)
ObjectDelta<O>	createAddDelta()
ObjectDelta<O>	createDeleteDelta()
ObjectDelta<O>	createDelta(ChangeType changeType)
PrismContainer<?>	createExtension()
PrismObject<O>	createImmutableClone()
ObjectDelta<O>	createModifyDelta()
PrismObjectValue<O>	createNewValue()
PrismObjectDefinition<O>	deepCloneDefinition(boolean ultraDeep)
ObjectDelta<O>	diff(PrismObject<O> other)
ObjectDelta<O>	diff(PrismObject<O> other, boolean ignoreMetadata, boolean isLiteral)
boolean	equivalent(Object obj) this method ignores some part of the object during comparison (e.g.
<I extends Item> I	findExtensionItem(QName elementName)
String	getBusinessDisplayName() Return display name intended for business users of midPoint
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
PrismObjectDefinition<O>	getDefinition() Returns applicable property container definition.
PrismContainer<?>	getExtension()
PolyString	getName()
String	getOid() Returns Object ID (OID).
PrismValue	getParent()
ItemPath	getPath()
PrismObjectValue<O>	getValue()
String	getVersion()
<IV extends PrismValue,ID extends ItemDefinition,I extends Item<IV,ID>> void	removeItem(ItemPath path, Class<I> itemType)
void	setImmutable(boolean immutable)
void	setOid(String oid)
void	setParent(PrismValue parentValue)
void	setValue(PrismContainerValue<O> value)
void	setVersion(String version)
String	toDebugName() Returns short string representing identity of this object.
String	toDebugType() Returns short string identification of object type.
String	toString()

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

accept, add, assertDefinitions, canRepresent, checkDefinition, containsEquivalentValue, containsItem, copyValues, createDelta, createDelta, createParentIfNeeded, debugDump, diff, diff, diffModifications, diffModifications, equals, find, findContainer, findContainer, findItem, findItem, findItem, findItem, findOrCreateContainer, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateProperty, findOrCreateReference, findOrCreateReference, findPartial, findProperty, findProperty, findReference, findReference, findReferenceByCompositeObjectElementName, findValue, getCompileTimeClass, getNextValue, getPreviousValue, getPropertyRealValue, getPropertyRealValue, getRealValue, getRealValues, getValue, hasCompleteDefinition, hashCode, isEmpty, mergeValue, mergeValues, mergeValues, newInstance, propagateDeepCloneDefinition, remove, removeContainer, removeContainer, removeProperty, removeProperty, removeReference, removeReference, setDefinition, setPropertyRealValue, trim

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, getPrismContext, getPrismContextLocal, getUserData, getUserData, getValue, getValues, hasRaw, hasRealValue, hasValue, hasValue, isImmutable, isRaw, isSingleValue, match, merge, normalize, remove, remove, removeAll, replace, replaceAll, resetParentCollection, revive, setElementName, 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, getPrismContext

Constructor Detail

PrismObject

public PrismObject(QName name,
                   Class<O> compileTimeClass)

PrismObject

public PrismObject(QName name,
                   Class<O> compileTimeClass,
                   PrismContext prismContext)

PrismObject

public PrismObject(QName name,
                   PrismObjectDefinition<O> definition,
                   PrismContext prismContext)

Method Detail

createNewValue

public PrismObjectValue<O> createNewValue()

Overrides:

createNewValue in class PrismContainer<O extends Objectable>

getValue

@NotNull
public PrismObjectValue<O> getValue()

Overrides:

getValue in class PrismContainer<O extends Objectable>

setValue

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

Overrides:

setValue in class PrismContainer<O extends Objectable>

Throws:

SchemaException

add

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

Overrides:

add in class PrismContainer<O extends Objectable>

Throws:

SchemaException

getOid

public String getOid()

Returns Object ID (OID). May return null if the object does not have an OID.

Returns:

Object ID (OID)

setOid

public void setOid(String oid)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getDefinition

public PrismObjectDefinition<O> getDefinition()

Description copied from class: PrismContainer

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<O extends Objectable>

Overrides:

getDefinition in class PrismContainer<O extends Objectable>

Returns:

applicable property container definition

asObjectable

@NotNull
public O asObjectable()

getName

public PolyString getName()

getExtension

public PrismContainer<?> getExtension()

findExtensionItem

public <I extends Item> I findExtensionItem(QName elementName)

addExtensionItem

public <I extends Item> void addExtensionItem(I item)
                                       throws SchemaException

Throws:

SchemaException

createExtension

public PrismContainer<?> createExtension()
                                  throws SchemaException

Throws:

SchemaException

applyDefinition

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

Overrides:

applyDefinition in class PrismContainer<O extends Objectable>

Throws:

SchemaException

removeItem

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

Overrides:

removeItem in class PrismContainer<O extends Objectable>

addReplaceExisting

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

Throws:

SchemaException

clone

public PrismObject<O> clone()

Overrides:

clone in class PrismContainer<O extends Objectable>

copyValues

protected void copyValues(PrismObject<O> clone)

deepCloneDefinition

public PrismObjectDefinition<O> deepCloneDefinition(boolean ultraDeep)

Overrides:

deepCloneDefinition in class PrismContainer<O extends Objectable>

diff

@NotNull
public ObjectDelta<O> diff(PrismObject<O> other)

diff

@NotNull
public ObjectDelta<O> diff(PrismObject<O> other,
                                    boolean ignoreMetadata,
                                    boolean isLiteral)

createDelta

public ObjectDelta<O> createDelta(ChangeType changeType)

createAddDelta

public ObjectDelta<O> createAddDelta()

createModifyDelta

public ObjectDelta<O> createModifyDelta()

createDeleteDelta

public ObjectDelta<O> createDeleteDelta()

setParent

public void setParent(PrismValue parentValue)

Overrides:

setParent in class Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

getParent

public PrismValue getParent()

Overrides:

getParent in class Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

getPath

public ItemPath getPath()

Specified by:

getPath in interface Itemable

Overrides:

getPath in class Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

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.

Overrides:

equivalent in class PrismContainer<O extends Objectable>

toString

public String toString()

Overrides:

toString in class PrismContainer<O extends Objectable>

toDebugName

public String toDebugName()

Returns short string representing identity of this object. It should container object type, OID and name. It should be presented in a form suitable for log and diagnostic messages (understandable for system administrator).

toDebugType

public String toDebugType()

Returns short string identification of object type. It should be in a form suitable for log messages. There is no requirement for the type name to be unique, but it rather has to be compact. E.g. short element names are preferred to long QNames or URIs.

Returns:

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class PrismContainer<O extends Objectable>

additionalDumpDescription

protected String additionalDumpDescription()

Overrides:

additionalDumpDescription in class PrismContainer<O extends Objectable>

getBusinessDisplayName

public String getBusinessDisplayName()

Return display name intended for business users of midPoint

checkConsistenceInternal

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

Overrides:

checkConsistenceInternal in class PrismContainer<O extends Objectable>

setImmutable

public void setImmutable(boolean immutable)

Overrides:

setImmutable in class Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

cloneIfImmutable

public PrismObject<O> cloneIfImmutable()

createImmutableClone

public PrismObject<O> createImmutableClone()