Package com.evolveum.midpoint.prism.impl

Class PrismReferenceDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

com.evolveum.midpoint.prism.impl.DefinitionImpl

com.evolveum.midpoint.prism.impl.ItemDefinitionImpl<PrismReference>

com.evolveum.midpoint.prism.impl.PrismReferenceDefinitionImpl

All Implemented Interfaces:

Definition, Definition.DefinitionBuilder, Definition.DefinitionMutator, DefinitionFragmentBuilder, Freezable, ItemDefinition<PrismReference>, ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemAccessDefinition.Mutable, PrismItemBasicDefinition, PrismItemBasicDefinition.Mutable, PrismItemStorageDefinition, PrismItemStorageDefinition.Mutable, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, PrismReferenceDefinition, PrismReferenceDefinition.PrismReferenceDefinitionBuilder, PrismReferenceDefinition.PrismReferenceDefinitionMutator, Revivable, SchemaLookup.Aware, SerializableDefinition, SerializableItemDefinition, SerializableReferenceDefinition, SmartVisitable<Definition>, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

public class PrismReferenceDefinitionImpl
extends ItemDefinitionImpl<PrismReference>
implements PrismReferenceDefinition, PrismReferenceDefinition.PrismReferenceDefinitionBuilder, SerializableReferenceDefinition

Object Reference Schema Definition. 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. This class represents schema definition for object reference. See Definition for more details.

Author:

Radovan Semancik

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

PrismItemAccessDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable

PrismItemBasicDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable

PrismLifecycleDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

PrismPresentationDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismReferenceDefinition

PrismReferenceDefinition.PrismReferenceDefinitionBuilder, PrismReferenceDefinition.PrismReferenceDefinitionMutator

Field Summary

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

heterogeneousListItem, itemName, processing, substitutionHead

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

deprecated, deprecatedSince, displayHint, displayName, displayOrder, documentation, elaborate, emphasized, experimental, help, isAbstract, isRuntimeSchema, plannedRemoval, removed, removedSince, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismReferenceDefinitionImpl(QName elementName, QName typeName)
PrismReferenceDefinitionImpl(QName elementName, QName typeName, QName definedInType)

Method Summary

Modifier and Type	Method	Description
@NotNull PrismReferenceDefinition	clone()
@NotNull PrismReferenceDefinition	cloneWithNewName(@NotNull ItemName itemName)	Returns a clone of this definition, but with name changed to the provided one.
protected void	copyDefinitionDataFrom(PrismReferenceDefinition source)
@NotNull ReferenceDelta	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
protected void	extendToString(StringBuilder sb)
<T extends ItemDefinition<?>> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)	Used to find a matching item definition _within_ this definition.
String	getDebugDumpClassName()	Return a human-readable name of this class suitable for logs.
String	getDocClassName()	Returns human-readable name of this class suitable for documentation.
@Nullable SchemaContextDefinition	getSchemaContextDefinition()
@Nullable PrismObjectDefinition<?>	getTargetObjectDefinition()	Returns a definition applicable to the target of this reference.
QName	getTargetTypeName()	Returns valid XSD object types whose may be the targets of the reference.
Class<ObjectReferenceType>	getTypeClass()	Returns a compile-time class that is used to represent items.
@NotNull PrismReference	instantiate()	Create an item instance.
@NotNull PrismReference	instantiate(QName name)	Create an item instance.
boolean	isComposite()
PrismReferenceDefinition.PrismReferenceDefinitionMutator	mutator()	Returns an interface to mutate this definition.
void	setComposite(boolean isComposite)
void	setTargetObjectDefinition(PrismObjectDefinition<?> targetObjectDefinition)
void	setTargetTypeName(QName targetTypeName)
Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.

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

canAdd, canModify, canRead, copyDefinitionDataFrom, debugDisplayOrder, debugDumpShortToString, debugFlags, debugMultiplicity, deepClone, equals, getItemName, getMaxOccurs, getMergerInstance, getMinOccurs, getObjectBuilt, getProcessing, getSubstitutionHead, getValueEnumerationRef, hashCode, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIndexed, isIndexOnly, isInherited, isOperational, isSearchable, isValidFor, revive, setAlwaysUseForEquals, setCanAdd, setCanModify, setCanRead, setDynamic, setHeterogeneousListItem, setIndexed, setIndexOnly, setInherited, setMaxOccurs, setMinOccurs, setOperational, setProcessing, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef, toString, useSerializationProxy, writeReplace

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

accept, accept, addSchemaMigration, copyDefinitionDataFrom, debugDump, extendDumpHeader, getAnnotation, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMergerIdentifier, getNaturalKeyConstituents, getNaturalKeyInstance, getPlannedRemoval, getRemovedSince, getSchemaMigrations, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema, setAbstract, setAnnotation, setDeprecated, setDeprecatedSince, setDiagrams, setDisplayHint, setDisplayName, setDisplayOrder, setDocumentation, setElaborate, setEmphasized, setExperimental, setHelp, setMergerIdentifier, setNaturalKeyConstituents, setOptionalCleanup, setPlannedRemoval, setRemoved, setRemovedSince, setRuntimeSchema, setSchemaContextDefinition, setSchemaMigrations

Methods inherited from class com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

performFreeze, schemaLookup, setSchemaLookup

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, debugDump, debugDumpLazily, debugDumpLazily

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

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema

Methods inherited from interface com.evolveum.midpoint.prism.Definition.DefinitionMutator

setAnnotation, setMergerIdentifier, setNaturalKeyConstituents, setOptionalCleanup, setRuntimeSchema, setSchemaContextDefinition

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

getObjectBuilt

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

checkImmutable, checkMutable, freeze, isImmutable

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

debugDumpShortToString, deepClone, getProcessing, getSubstitutionHead, getValueEnumerationRef, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionLikeBuilder

getExtraFeaturesToParse

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionMutator

setAlwaysUseForEquals, setDeprecatedSince, setDynamic, setElaborate, setHeterogeneousListItem, setIgnored, setIndexOnly, setInherited, setOperational, setPlannedRemoval, setProcessing, setReadOnly, setSearchable, setSubstitutionHead, setValueEnumerationRef

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

isValidFor

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

canAdd, canModify, canRead, getInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

setCanAdd, setCanModify, setCanRead, setInfo

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

getItemName, getMaxOccurs, getMinOccurs, getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable

setMaxOccurs, setMinOccurs

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

isIndexed, isIndexOnly, isSearchable

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition.Mutable

setIndexed

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

getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemoved

Methods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable

addSchemaMigration, setDeprecated, setExperimental, setRemoved, setRemovedSince, setSchemaMigrations

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

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

Methods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

setDiagrams, setDisplayHint, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setHelp

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

migrateIfNeeded

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

revive

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware

schemaLookup

Methods inherited from interface com.evolveum.midpoint.prism.schema.SerializableDefinition

getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getExtraFeaturesToSerialize, getHelp, isEmphasized

Methods inherited from interface com.evolveum.midpoint.prism.schema.SerializableItemDefinition

getItemName, getMaxOccurs, getMinOccurs, getProcessing, getTypeName, isIndexed, isOperational

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

accept

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

accept

Constructor Details

PrismReferenceDefinitionImpl

public PrismReferenceDefinitionImpl(QName elementName,
 QName typeName)

PrismReferenceDefinitionImpl

public PrismReferenceDefinitionImpl(QName elementName,
 QName typeName,
 QName definedInType)

Method Details

getTargetTypeName

public QName getTargetTypeName()

Returns valid XSD object types whose may be the targets of the reference. Corresponds to "targetType" XSD annotation. Returns empty set if not specified. Must not return null.

Specified by:

getTargetTypeName in interface PrismReferenceDefinition

Specified by:

getTargetTypeName in interface SerializableReferenceDefinition

Returns:

set of target type names

setTargetTypeName

public void setTargetTypeName(QName targetTypeName)

Specified by:

setTargetTypeName in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

getTargetObjectDefinition

@Nullable
public @Nullable PrismObjectDefinition<?> getTargetObjectDefinition()

Description copied from interface: PrismReferenceDefinition

Returns a definition applicable to the target of this reference. Introduced to support shadow association definitions in midPoint: it applies to `ShadowAssociationValueType.shadowRef`.

Specified by:

getTargetObjectDefinition in interface PrismReferenceDefinition

setTargetObjectDefinition

public void setTargetObjectDefinition(PrismObjectDefinition<?> targetObjectDefinition)

Specified by:

setTargetObjectDefinition in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

isComposite

public boolean isComposite()

Specified by:

isComposite in interface PrismReferenceDefinition

Specified by:

isComposite in interface SerializableReferenceDefinition

setComposite

public void setComposite(boolean isComposite)

Specified by:

setComposite in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

findItemDefinition

public <T extends ItemDefinition<?>> T findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<T> clazz)

Description copied from interface: LivePrismItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface LivePrismItemDefinition

Overrides:

findItemDefinition in class ItemDefinitionImpl<PrismReference>

instantiate

@NotNull
public @NotNull PrismReference instantiate()

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismReference>

Specified by:

instantiate in interface PrismReferenceDefinition

instantiate

@NotNull
public @NotNull PrismReference instantiate(QName name)

Description copied from interface: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismReference>

Specified by:

instantiate in interface PrismReferenceDefinition

createEmptyDelta

@NotNull
public @NotNull ReferenceDelta createEmptyDelta(ItemPath path)

Description copied from interface: ItemDefinition

Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.

Specified by:

createEmptyDelta in interface ItemDefinition<PrismReference>

getTypeClass

public Class<ObjectReferenceType> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

mutator

public PrismReferenceDefinition.PrismReferenceDefinitionMutator mutator()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

mutator in interface Definition

Specified by:

mutator in interface ItemDefinition<PrismReference>

Specified by:

mutator in interface PrismReferenceDefinition

clone

@NotNull
public @NotNull PrismReferenceDefinition clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismReference>

Specified by:

clone in interface PrismReferenceDefinition

Specified by:

clone in class ItemDefinitionImpl<PrismReference>

cloneWithNewName

@NotNull
public @NotNull PrismReferenceDefinition cloneWithNewName(@NotNull
 @NotNull ItemName itemName)

Description copied from interface: ItemDefinition

Returns a clone of this definition, but with name changed to the provided one.

Specified by:

cloneWithNewName in interface ItemDefinition<PrismReference>

See Also:

• PrismContainerDefinition.cloneWithNewDefinition(QName, ItemDefinition)

copyDefinitionDataFrom

protected void copyDefinitionDataFrom(PrismReferenceDefinition source)

getDebugDumpClassName

public String getDebugDumpClassName()

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

Specified by:

getDebugDumpClassName in class DefinitionImpl

getDocClassName

public String getDocClassName()

Description copied from class: DefinitionImpl

Returns human-readable name of this class suitable for documentation. (e.g. "property")

Specified by:

getDocClassName in class DefinitionImpl

extendToString

protected void extendToString(StringBuilder sb)

Overrides:

extendToString in class ItemDefinitionImpl<PrismReference>

structuredType

public Optional<ComplexTypeDefinition> structuredType()

Description copied from interface: ItemDefinition

Returns complex type definition of item, if underlying value is possible structured. NOTE: This seems weird, since properties and references are simple values, but actually object reference is serialized as structured value and some of properties are also.

Specified by:

structuredType in interface ItemDefinition<PrismReference>

getSchemaContextDefinition

@Nullable
public @Nullable SchemaContextDefinition getSchemaContextDefinition()

Specified by:

getSchemaContextDefinition in interface Definition

Overrides:

getSchemaContextDefinition in class DefinitionImpl