com.evolveum.midpoint.prism

Class PrismReferenceValue

java.lang.Object

com.evolveum.midpoint.prism.PrismValue

com.evolveum.midpoint.prism.PrismReferenceValue

All Implemented Interfaces:

IPrismValue, PathVisitable, Revivable, Visitable, DebugDumpable, ShortDumpable, Serializable

public class PrismReferenceValue
extends PrismValue
implements DebugDumpable, Serializable, ShortDumpable

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

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

immutable, prismContext

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

INDENT_STRING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	applyDefinition(ItemDefinition definition, boolean force)
void	applyDefinition(PrismReferenceDefinition definition, boolean force)
Referencable	asReferencable()
static List<Referencable>	asReferencables(Collection<PrismReferenceValue> values)
static List<PrismReferenceValue>	asReferenceValues(Collection<? extends Referencable> referencables)
void	checkConsistenceInternal(Itemable rootItem, boolean requireDefinitions, boolean prohibitRaw, ConsistencyCheckScope scope)
PrismReferenceValue	clone() Literal clone.
PrismReferenceValue	cloneComplex(CloneStrategy strategy) Complex clone with different cloning strategies.
static boolean	containsOid(Collection<PrismReferenceValue> values, String oid)
protected void	copyValues(CloneStrategy strategy, PrismReferenceValue clone)
static PrismReferenceValue	createFromTarget(PrismObject<?> refTarget)
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(Object obj)
boolean	equalsComplex(PrismReferenceValue other, boolean ignoreMetadata, boolean isLiteral)
boolean	equalsComplex(PrismValue other, boolean ignoreMetadata, boolean isLiteral)
Object	find(ItemPath path)
<IV extends PrismValue,ID extends ItemDefinition> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
PrismReferenceDefinition	getDefinition()
String	getDescription()
SearchFilterType	getFilter()
PrismObject	getObject() Returns object that this reference points to.
String	getOid() OID of the object that this reference refers to (reference target).
Class<?>	getRealClass()
Referencable	getRealValue()
QName	getRelation()
EvaluationTimeType	getResolutionTime()
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()
Class<Objectable>	getTargetTypeCompileTimeClass(PrismContext prismContext)
int	hashCode()
boolean	isEmpty()
boolean	isRaw() Returns true if the value is raw.
boolean	match(PrismValue otherValue)
void	recompute(PrismContext prismContext)
PrismReferenceValue	relation(QName relation)
boolean	representsSameValue(PrismReferenceValue other)
boolean	representsSameValue(PrismValue other, boolean lax) Returns true if this and other value represent the same value.
void	revive(PrismContext prismContext)
void	setDescription(String description)
void	setFilter(SearchFilterType filter)
void	setObject(PrismObject object)
void	setOid(String oid)
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.
PrismReferenceValue	toCanonical() Returns a version of this value that is canonical, that means it has the minimal form.
String	toHumanReadableString() Returns a short (one-line) representation of the real value stored in this object.
String	toString()

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

accept, accept, appendOriginDump, applyDefinition, checkMutability, clearParent, clearParent, cloneCollection, cloneCollectionComplex, cloneValues, collectionContainsEquivalentValue, contains, containsAll, containsRealValue, containsRealValue, copyValues, diff, diff, equals, equals, equalsRealValue, equalsRealValue, equalsRealValues, fromRealValue, getAllValues, getOriginObject, getOriginType, getParent, getParentContainerValue, getParentContainerValue, getPath, getPrismContext, getRealValuesOfCollection, getRootValue, getTypeName, getUserData, getUserData, isImmutable, normalize, recompute, resetParentCollection, setImmutable, setOriginObject, setOriginType, setParent, setPrismContext, setUserData

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.util.ShortDumpable

shortDump, shortDumpLazily

Constructor Detail

PrismReferenceValue

public PrismReferenceValue()

PrismReferenceValue

public PrismReferenceValue(String oid)

PrismReferenceValue

public PrismReferenceValue(String oid,
                           QName targetType)

PrismReferenceValue

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

Method Detail

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.

Returns:

the target oid

setOid

public void setOid(String oid)

getObject

public PrismObject 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.

setObject

public void setObject(PrismObject object)

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.

Returns:

the target type name

setTargetType

public void setTargetType(QName targetType)

setTargetType

public void setTargetType(QName targetType,
                          boolean allowEmptyNamespace)

Parameters:

targetType -

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.

Returns:

cached name of the target object.

setTargetName

public void setTargetName(PolyString name)

setTargetName

public void setTargetName(PolyStringType name)

getTargetTypeCompileTimeClass

public Class<Objectable> getTargetTypeCompileTimeClass()

getTargetTypeCompileTimeClass

public Class<Objectable> getTargetTypeCompileTimeClass(PrismContext prismContext)

getRelation

public QName getRelation()

setRelation

public void setRelation(QName relation)

relation

public PrismReferenceValue relation(QName relation)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFilter

public SearchFilterType getFilter()

setFilter

public void setFilter(SearchFilterType filter)

getResolutionTime

public EvaluationTimeType getResolutionTime()

setResolutionTime

public void setResolutionTime(EvaluationTimeType resolutionTime)

getDefinition

public PrismReferenceDefinition getDefinition()

Overrides:

getDefinition in class PrismValue

isRaw

public boolean isRaw()

Description copied from interface: IPrismValue

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 definition is supplied.

Specified by:

isRaw in interface IPrismValue

find

public Object find(ItemPath path)

Specified by:

find in interface IPrismValue

findPartial

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

Specified by:

findPartial in interface IPrismValue

applyDefinition

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

Specified by:

applyDefinition in interface IPrismValue

Overrides:

applyDefinition in class PrismValue

Throws:

SchemaException

applyDefinition

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

Throws:

SchemaException

recompute

public void recompute(PrismContext prismContext)

Specified by:

recompute in interface IPrismValue

checkConsistenceInternal

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

Specified by:

checkConsistenceInternal in class PrismValue

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IPrismValue

toCanonical

public PrismReferenceValue 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.

equalsComplex

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

Overrides:

equalsComplex in class PrismValue

equalsComplex

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

equals

public boolean equals(Object obj)

Overrides:

equals in class PrismValue

hashCode

public int hashCode()

Overrides:

hashCode in class PrismValue

representsSameValue

public boolean representsSameValue(PrismValue other,
                                   boolean lax)

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

lax - If we can reasonably assume that the two values belong together even if they don't have the same ID, e.g. if they both belong to single-valued parent items. This is useful e.g. when comparing multi-valued containers. But can cause problems when we want to be sure we are removing the correct value.

representsSameValue

public boolean representsSameValue(PrismReferenceValue other)

createFromTarget

public static PrismReferenceValue createFromTarget(PrismObject<?> refTarget)

toString

public String toString()

Overrides:

toString in class Object

asReferencable

public Referencable asReferencable()

asReferencables

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

asReferenceValues

@NotNull
public static List<PrismReferenceValue> asReferenceValues(@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)

clone

public PrismReferenceValue clone()

Description copied from class: PrismValue

Literal clone.

Specified by:

clone in class PrismValue

cloneComplex

public PrismReferenceValue cloneComplex(CloneStrategy strategy)

Description copied from class: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in class PrismValue

See Also:

CloneStrategy

copyValues

protected void copyValues(CloneStrategy strategy,
                          PrismReferenceValue clone)

match

public boolean match(PrismValue otherValue)

Specified by:

match in interface IPrismValue

toHumanReadableString

public String toHumanReadableString()

Description copied from interface: IPrismValue

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 interface IPrismValue

getRealClass

public Class<?> getRealClass()

Specified by:

getRealClass in class PrismValue

getRealValue

@Nullable
public Referencable getRealValue()

Specified by:

getRealValue in class PrismValue

containsOid

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

revive

public void revive(PrismContext prismContext)
            throws SchemaException

Specified by:

revive in interface Revivable

Overrides:

revive in class PrismValue

Throws:

SchemaException

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.