Package com.evolveum.midpoint.prism.impl

Class PrismReferenceImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

com.evolveum.midpoint.prism.impl.PrismReferenceImpl

All Implemented Interfaces:

Freezable, Item<PrismReferenceValue,PrismReferenceDefinition>, Itemable, ItemDefinitionTransformer.TransformableItem, ParentVisitable, PathVisitable, PrismContextSensitive, PrismReference, Revivable, Visitable, DebugDumpable, Serializable

public class PrismReferenceImpl
extends ItemImpl<PrismReferenceValue,PrismReferenceDefinition>
implements PrismReference

Object Reference is a property that describes reference to an object. It is used to represent association between objects. For example reference from User object to Account objects that belong to the user. The reference is a simple uni-directional link using an OID as an identifier. This type should be used for all object references so the implementations can detect them and automatically resolve them.

Author:

semancik

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.impl.ItemImpl

definition, elementName, incomplete, parent, values

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismReferenceImpl(QName name)
PrismReferenceImpl(QName name, PrismReferenceDefinition definition, PrismContext prismContext)

Method Summary

Modifier and Type	Method	Description
protected void	checkDefinition(PrismReferenceDefinition def)
PrismReferenceImpl	clone()	Literal clone.
PrismReferenceImpl	cloneComplex(CloneStrategy strategy)	Complex clone with different cloning strategies.
protected void	copyValues(CloneStrategy strategy, PrismReferenceImpl clone)
ReferenceDelta	createDelta()	Creates specific subclass of ItemDelta appropriate for type of item that this definition represents (e.g.
ReferenceDelta	createDelta(ItemPath path)
PrismReference	createImmutableClone()
String	debugDump(int indent)
Object	find(ItemPath path)	Returns object (Item or PrismValue) pointed to by the given path.
<IV extends PrismValue, ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
<I extends Item<?, ?>> I	findReferencedItem(ItemPath path, Class<I> type)	Tries to find referenced path (path starting with object derefence) in-memory.
PrismReferenceValue	findValueByOid(String oid)
@NotNull Collection<PrismValue>	getAllValues(ItemPath path)	Returns all values corresponding to the provided path.
protected String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
String	getOid()
Referencable	getRealValue()	Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items.
@NotNull Collection<Referencable>	getRealValues()	Returns (potentially empty) collection of "real values".
PolyString	getTargetName()
@NotNull PrismReferenceValue	getValue()	Returns the value, if there is only one.
boolean	merge(PrismReferenceValue value)
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.impl.ItemImpl

accept, accept, acceptParentVisitor, add, addAll, addForced, addIgnoringEquivalents, addInternal, addInternalExecution, addRespectingMetadataAndCloning, appendDebugDumpSuffix, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, clear, copyValues, diff, equals, equals, equals, fixupDelta, getAllItems, getDefinition, getElementName, getHighestId, getParent, getPath, getPathComponent, getPrismContext, getPrismContextLocal, getRealValue, getRealValuesArray, getUserData, getUserData, getValues, hashCode, hashCode, hashCode, isIncomplete, merge, normalize, performFreeze, propagateDeepCloneDefinition, recomputeAllValues, remove, remove, removeAll, removeRespectingMetadata, replace, replaceAll, revive, setDefinition, setElementName, setIncomplete, setParent, setPrismContext, setUserData, transformDefinition, valueRemoved

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

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

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

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

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

acceptParentVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, clear, contains, contains, copy, diff, diff, equals, equals, equals, filterValues, filterYields, findValue, findValue, getAllItems, getAnyValue, getAnyValue, getClonedValues, getDefinition, getDisplayName, getElementName, getHelp, getHighestId, getParent, getPath, getPrismContextLocal, getRealValue, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, getValues, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, setDefinition, setElementName, setIncomplete, setParent, setPrismContext, setUserData, size, valuesStream

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

accept

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

getPrismContext

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

revive

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

accept

Constructor Details

PrismReferenceImpl

public PrismReferenceImpl(QName name)

PrismReferenceImpl

public PrismReferenceImpl(QName name,
 PrismReferenceDefinition definition,
 PrismContext prismContext)

Method Details

getValue

@NotNull
public @NotNull PrismReferenceValue getValue()

Description copied from interface: Item

Returns the value, if there is only one. Throws exception if there are more values. If there is no value, this method either: - returns null (for properties) - throws an exception (for items that can hold multiple values) - creates an empty value (for containers and references). TODO think again whether getOrCreateValue would not be better

Specified by:

getValue in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Overrides:

getValue in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

getRealValue

public Referencable getRealValue()

Description copied from interface: Item

Returns the "real value" (content) of this item: - value contained in PrismPropertyValue - Referencable in PrismReferenceValue - Containerable in PrismContainerValue - Objectable in PrismObjectValue Note that the real value can contain operational items. It can also contain container IDs (although they are not considered to be part of the real value). It does not contain information about item element name nor other metadata like origin, definition, etc. (Although e.g. Containerable can be converted back into PrismContainerValue that can be used to retrieve this information.)

Specified by:

getRealValue in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

getRealValue in interface PrismReference

Overrides:

getRealValue in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

getRealValues

@NotNull
public @NotNull Collection<Referencable> getRealValues()

Description copied from interface: Item

Returns (potentially empty) collection of "real values".

Specified by:

getRealValues in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

getRealValues in interface PrismReference

merge

public boolean merge(PrismReferenceValue value)

Specified by:

merge in interface PrismReference

getOid

public String getOid()

Specified by:

getOid in interface PrismReference

getTargetName

public PolyString getTargetName()

Specified by:

getTargetName in interface PrismReference

findValueByOid

public PrismReferenceValue findValueByOid(String oid)

Specified by:

findValueByOid in interface PrismReference

find

public Object find(ItemPath path)

Description copied from interface: Item

Returns object (Item or PrismValue) pointed to by the given path.

Specified by:

find in interface Item<PrismReferenceValue,PrismReferenceDefinition>

findPartial

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

Specified by:

findPartial in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

findPartial in interface PrismReference

createDelta

public ReferenceDelta createDelta()

Description copied from interface: Item

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

Specified by:

createDelta in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

createDelta in interface PrismReference

createDelta

public ReferenceDelta createDelta(ItemPath path)

Specified by:

createDelta in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

createDelta in interface PrismReference

checkDefinition

protected void checkDefinition(PrismReferenceDefinition def)

Specified by:

checkDefinition in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

clone

public PrismReferenceImpl clone()

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

clone in interface PrismReference

Specified by:

clone in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

createImmutableClone

public PrismReference createImmutableClone()

Specified by:

createImmutableClone in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

createImmutableClone in interface PrismReference

Overrides:

createImmutableClone in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

cloneComplex

public PrismReferenceImpl cloneComplex(CloneStrategy strategy)

Description copied from interface: Item

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Specified by:

cloneComplex in interface PrismReference

See Also:

• CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
 PrismReferenceImpl clone)

toString

public String toString()

Specified by:

toString in interface PrismReference

Overrides:

toString in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Specified by:

debugDump in interface PrismReference

Overrides:

debugDump in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>

findReferencedItem

public <I extends Item<?,
?>> I findReferencedItem(ItemPath path,
 Class<I> type)

Description copied from interface: PrismReference

Tries to find referenced path (path starting with object derefence) in-memory. This works only for single-value references, whose value also contains embedded object. The search is performed on embedded object.

Specified by:

findReferencedItem in interface PrismReference

getAllValues

@NotNull
public @NotNull Collection<PrismValue> getAllValues(ItemPath path)

Description copied from interface: Item

Returns all values corresponding to the provided path. The path may contain ambiguous segments (e.g. `assignment/targetRef` when there are more assignments). Limitations: . The path can contain only name segments and the "identifier" (`#`) segment - at least for now. No ID segments. . There are no guarantees about duplicate values. They may or may not be present in the returned collections. . The caller should not modify the returned collection in any way. Note to implementors: Please take care about the performance of this method.

Specified by:

getAllValues in interface Item<PrismReferenceValue,PrismReferenceDefinition>

Overrides:

getAllValues in class ItemImpl<PrismReferenceValue,PrismReferenceDefinition>