Package com.evolveum.midpoint.prism.impl

Class PrismReferenceValueImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.PrismValueImpl

com.evolveum.midpoint.prism.impl.PrismReferenceValueImpl

All Implemented Interfaces:

ComplexCopyable<PrismValue>, Freezable, ItemDefinitionTransformer.TransformableValue, MidpointOriginMetadata, PathVisitable, PrismReferenceValue, PrismValue, PrismVisitable, Revivable, SchemaLookup.Aware, Visitable, DebugDumpable, ShortDumpable, Serializable

Direct Known Subclasses:

ShadowReferenceAttributeValue

public class PrismReferenceValueImpl
extends PrismValueImpl
implements PrismReferenceValue

BEWARE! When adding data to this class, do not forget to update PrismForJAXBUtil.setReferenceValueAsRef(PrismContainerValue, QName, PrismReferenceValue)! TODO ... or, even better, provide "updateFrom(sourceReferenceValue)" method right here

Author:

Radovan Semancik

See Also:

• Serialized Form

Field Summary

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

defaultEquivalenceStrategy

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismReferenceValueImpl()
PrismReferenceValueImpl(String oid)
PrismReferenceValueImpl(String oid, OriginType type, Objectable source)
PrismReferenceValueImpl(String oid, QName targetType)

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)
PrismValue	applyDefinition(@NotNull ItemDefinition<?> definition, boolean force)	Definition application MAY change the value (currently only for container values).
PrismReferenceValue	applyDefinition(PrismReferenceDefinition definition, boolean force)
Referencable	asReferencable()
static @NotNull List<Referencable>	asReferencables(@NotNull Collection<PrismReferenceValue> values)
static @NotNull List<PrismReferenceValue>	asReferenceValues(@NotNull Collection<? extends Referencable> referencables)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
PrismReferenceValue	clone()	Literal clone.
@NotNull PrismReferenceValue	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
static boolean	containsOid(Collection<PrismReferenceValue> values, @NotNull String oid)
protected void	copyValues(CloneStrategy strategy, PrismReferenceValueImpl clone)
PrismReferenceValue	createImmutableClone()
String	debugDump()	Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
String	debugDump(int indent, boolean expandObject)
boolean	equals(PrismReferenceValue other, @NotNull ParameterizedEquivalenceStrategy strategy)
boolean	equals(PrismValue other, @NotNull ParameterizedEquivalenceStrategy strategy)
Object	find(ItemPath path)
<IV extends PrismValue, ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
<I extends Item<?, ?>> I	findReferencedItem(ItemPath path, Class<I> type)
@NotNull Collection<PrismValue>	getAllValues(ItemPath path)	See Item.getAllValues(ItemPath).
PrismReferenceDefinition	getDefinition()
String	getDescription()
SearchFilterType	getFilter()
<O extends Objectable> PrismObject<O>	getObject()	Returns object that this reference points to.
String	getOid()	OID of the object that this reference refers to (reference target).
Class<?>	getRealClass()
@NotNull Referencable	getRealValue()	Returns the statically-typed "real value".
ReferentialIntegrityType	getReferentialIntegrity()
QName	getRelation()
EvaluationTimeType	getResolutionTime()
SchemaContext	getSchemaContext()
PolyString	getTargetName()	Returns cached name of the target object.
QName	getTargetType()	Returns XSD type of the object that this reference refers to.
Class<Objectable>	getTargetTypeCompileTimeClass()
int	hashCode(@NotNull ParameterizedEquivalenceStrategy strategy)
boolean	isEmpty()
boolean	isRaw()
void	recompute(PrismContext prismContext)
PrismReferenceValueImpl	relation(QName relation)
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static?
void	setDescription(String description)
void	setFilter(SearchFilterType filter)
void	setObject(PrismObject object)
void	setOid(String oid)
void	setReferentialIntegrity(ReferentialIntegrityType referentialIntegrity)
void	setRelation(QName relation)
void	setResolutionTime(EvaluationTimeType resolutionTime)
void	setTargetName(PolyString name)
void	setTargetName(PolyStringType name)
void	setTargetType(QName targetType)
void	setTargetType(QName targetType, boolean allowEmptyNamespace)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.
PrismReferenceValueImpl	toCanonical()	Returns a version of this value that is canonical, that means it has the minimal form.
String	toHumanReadableString()
String	toString()
void	transformDefinition(ComplexTypeDefinition parentDef, ItemDefinition<?> itemDef, ItemDefinitionTransformer transformation)

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

accept, appendOriginDump, clearParent, copyValues, diff, diffMatchingRepresentation, diffMatchingRepresentation, equals, equals, getAllItems, getOriginObject, getOriginType, getParent, getParentContainerValue, getPath, getPathComponent, getRootValue, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataIfExists, hashCode, hashCode, hasValueMetadata, isTransient, normalize, performFreeze, recompute, representsSameValue, schemaLookup, setOriginObject, setOriginType, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata

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

debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.metadata.MidpointOriginMetadata

getOriginObject, getOriginType, setOriginObject, setOriginType

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

acceptVisitor, copy, determineTargetTypeName, getEffectiveResolutionTime, getObjectable, immutableCopy, mutableCopy

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

accept, applyDefinition, applyDefinitionLegacy, applyDefinitionLegacy, clearParent, cloneIfImmutable, deleteValueMetadata, diff, equals, getAllItems, getNearestValueOfType, getParent, getParentContainerValue, getPath, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getRootValue, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataAsContainer, getValueMetadataIfExists, hashCode, hasRealClass, hasValueMetadata, isObjectable, isOfType, isTransient, normalize, recompute, representsSameValue, schemaLookup, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata

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

shortDump, shortDumpLazily

Constructor Details

PrismReferenceValueImpl

public PrismReferenceValueImpl()

PrismReferenceValueImpl

public PrismReferenceValueImpl(String oid)

PrismReferenceValueImpl

public PrismReferenceValueImpl(String oid,
 QName targetType)

PrismReferenceValueImpl

public PrismReferenceValueImpl(String oid,
 OriginType type,
 Objectable source)

Method Details

getOid

public String getOid()

OID of the object that this reference refers to (reference target). May return null, but the reference is in that case incomplete and unusable.

Specified by:

getOid in interface PrismReferenceValue

Returns:

the target oid

setOid

public void setOid(String oid)

Specified by:

setOid in interface PrismReferenceValue

getObject

public <O extends Objectable> PrismObject<O> getObject()

Returns object that this reference points to. The object is supposed to be used for caching and optimizations. Only oid and type of the object really matters for the reference. The object is transient. It will NOT be serialized. Therefore the client must expect that the object can disappear when serialization boundary is crossed. The client must expect that the object is null.

Specified by:

getObject in interface PrismReferenceValue

setObject

public void setObject(PrismObject object)

Specified by:

setObject in interface PrismReferenceValue

getTargetType

public QName getTargetType()

Returns XSD type of the object that this reference refers to. It may be used in XPath expressions and similar filters. May return null if the type name is not set.

Specified by:

getTargetType in interface PrismReferenceValue

Returns:

the target type name

setTargetType

public void setTargetType(QName targetType)

Specified by:

setTargetType in interface PrismReferenceValue

setTargetType

public void setTargetType(QName targetType,
 boolean allowEmptyNamespace)

Specified by:

setTargetType in interface PrismReferenceValue

Parameters:

allowEmptyNamespace - This is an ugly hack. See comment in DOMUtil.validateNonEmptyQName.

getTargetName

public PolyString getTargetName()

Returns cached name of the target object. This is a ephemeral value. It is usually not stored. It may be computed at object retrieval time or it may not be present at all. This is NOT an authoritative information. Setting it or changing it will not influence the reference meaning. OID is the only authoritative linking mechanism.

Specified by:

getTargetName in interface PrismReferenceValue

Returns:

cached name of the target object.

setTargetName

public void setTargetName(PolyString name)

Specified by:

setTargetName in interface PrismReferenceValue

setTargetName

public void setTargetName(PolyStringType name)

Specified by:

setTargetName in interface PrismReferenceValue

getTargetTypeCompileTimeClass

public Class<Objectable> getTargetTypeCompileTimeClass()

Specified by:

getTargetTypeCompileTimeClass in interface PrismReferenceValue

getRelation

public QName getRelation()

Specified by:

getRelation in interface PrismReferenceValue

setRelation

public void setRelation(QName relation)

Specified by:

setRelation in interface PrismReferenceValue

relation

public PrismReferenceValueImpl relation(QName relation)

Specified by:

relation in interface PrismReferenceValue

getDescription

public String getDescription()

Specified by:

getDescription in interface PrismReferenceValue

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface PrismReferenceValue

getFilter

public SearchFilterType getFilter()

Specified by:

getFilter in interface PrismReferenceValue

setFilter

public void setFilter(SearchFilterType filter)

Specified by:

setFilter in interface PrismReferenceValue

getResolutionTime

public EvaluationTimeType getResolutionTime()

Specified by:

getResolutionTime in interface PrismReferenceValue

setResolutionTime

public void setResolutionTime(EvaluationTimeType resolutionTime)

Specified by:

setResolutionTime in interface PrismReferenceValue

getReferentialIntegrity

public ReferentialIntegrityType getReferentialIntegrity()

Specified by:

getReferentialIntegrity in interface PrismReferenceValue

setReferentialIntegrity

public void setReferentialIntegrity(ReferentialIntegrityType referentialIntegrity)

Specified by:

setReferentialIntegrity in interface PrismReferenceValue

getDefinition

public PrismReferenceDefinition getDefinition()

Specified by:

getDefinition in interface PrismReferenceValue

Overrides:

getDefinition in class PrismValueImpl

isRaw

public boolean isRaw()

Specified by:

isRaw in interface PrismValue

find

public Object find(ItemPath path)

Specified by:

find in interface PrismValue

findPartial

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

Specified by:

findPartial in interface PrismReferenceValue

applyDefinition

public PrismValue applyDefinition(@NotNull
 @NotNull ItemDefinition<?> definition,
 boolean force)
                           throws SchemaException

Description copied from interface: PrismValue

Definition application MAY change the value (currently only for container values). The caller must deal with that.

Specified by:

applyDefinition in interface PrismValue

Throws:

SchemaException

applyDefinition

public PrismReferenceValue applyDefinition(PrismReferenceDefinition definition,
 boolean force)
                                    throws SchemaException

Specified by:

applyDefinition in interface PrismReferenceValue

Throws:

SchemaException

recompute

public void recompute(PrismContext prismContext)

Specified by:

recompute in interface PrismValue

Specified by:

recompute in class PrismValueImpl

checkConsistenceInternal

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

Specified by:

checkConsistenceInternal in interface PrismValue

Specified by:

checkConsistenceInternal in class PrismValueImpl

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface PrismValue

toCanonical

public PrismReferenceValueImpl toCanonical()

Returns a version of this value that is canonical, that means it has the minimal form. E.g. it will have only OID and no object.

Specified by:

toCanonical in interface PrismReferenceValue

equals

public boolean equals(PrismValue other,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy strategy)

Specified by:

equals in interface PrismValue

Overrides:

equals in class PrismValueImpl

equals

public boolean equals(PrismReferenceValue other,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy strategy)

hashCode

public int hashCode(@NotNull
 @NotNull ParameterizedEquivalenceStrategy strategy)

Specified by:

hashCode in interface PrismValue

Overrides:

hashCode in class PrismValueImpl

toString

public String toString()

Overrides:

toString in class Object

asReferencable

public Referencable asReferencable()

Specified by:

asReferencable in interface PrismReferenceValue

asReferencables

@NotNull
public static @NotNull List<Referencable> asReferencables(@NotNull
 @NotNull Collection<PrismReferenceValue> values)

asReferenceValues

@NotNull
public static @NotNull List<PrismReferenceValue> asReferenceValues(@NotNull
 @NotNull Collection<? extends Referencable> referencables)

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

debugDump

public String debugDump(int indent,
 boolean expandObject)

Specified by:

debugDump in interface PrismReferenceValue

clone

public PrismReferenceValue clone()

Description copied from class: PrismValueImpl

Literal clone.

Specified by:

clone in interface PrismReferenceValue

Specified by:

clone in interface PrismValue

Specified by:

clone in class PrismValueImpl

createImmutableClone

public PrismReferenceValue createImmutableClone()

Specified by:

createImmutableClone in interface PrismReferenceValue

Specified by:

createImmutableClone in interface PrismValue

Overrides:

createImmutableClone in class PrismValueImpl

cloneComplex

@NotNull
public @NotNull PrismReferenceValue cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from class: PrismValueImpl

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface ComplexCopyable<PrismValue>

Specified by:

cloneComplex in interface PrismReferenceValue

Specified by:

cloneComplex in interface PrismValue

Specified by:

cloneComplex in class PrismValueImpl

See Also:

• CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
 PrismReferenceValueImpl clone)

toHumanReadableString

public String toHumanReadableString()

Specified by:

toHumanReadableString in interface PrismValue

Specified by:

toHumanReadableString in class PrismValueImpl

getRealClass

public Class<?> getRealClass()

Specified by:

getRealClass in interface PrismReferenceValue

Specified by:

getRealClass in interface PrismValue

Specified by:

getRealClass in class PrismValueImpl

getRealValue

@NotNull
public @NotNull Referencable getRealValue()

Description copied from interface: PrismValue

Returns the statically-typed "real value". TODO specify when exactly the returned value can be null. TODO decide for containers: they throw an exception if the value is not statically typed.

Specified by:

getRealValue in interface PrismReferenceValue

Specified by:

getRealValue in interface PrismValue

Specified by:

getRealValue in class PrismValueImpl

containsOid

public static boolean containsOid(Collection<PrismReferenceValue> values,
 @NotNull
 @NotNull String oid)

revive

public void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

Overrides:

revive in class PrismValueImpl

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.

accept

public void accept(Visitor visitor)

Specified by:

accept in interface PrismValue

Specified by:

accept in interface Visitable

Overrides:

accept in class PrismValueImpl

transformDefinition

public void transformDefinition(ComplexTypeDefinition parentDef,
 ItemDefinition<?> itemDef,
 ItemDefinitionTransformer transformation)

Specified by:

transformDefinition in interface ItemDefinitionTransformer.TransformableValue

findReferencedItem

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

Specified by:

findReferencedItem in interface PrismReferenceValue

getSchemaContext

public SchemaContext getSchemaContext()

Specified by:

getSchemaContext in interface PrismValue

Overrides:

getSchemaContext in class PrismValueImpl

getAllValues

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

Description copied from interface: PrismValue

See Item.getAllValues(ItemPath).

Specified by:

getAllValues in interface PrismValue

Overrides:

getAllValues in class PrismValueImpl