Package com.evolveum.midpoint.prism.impl

Class PrismPropertyDefinitionImpl<T>

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<PrismProperty<T>>

com.evolveum.midpoint.prism.impl.PrismPropertyDefinitionImpl<T>

All Implemented Interfaces:

Definition, Definition.DefinitionBuilder, Definition.DefinitionMutator, DefinitionFragmentBuilder, Freezable, ItemDefinition<PrismProperty<T>>, ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemAccessDefinition.Mutable, PrismItemBasicDefinition, PrismItemBasicDefinition.Mutable, PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>, PrismItemMatchingDefinition<T>, PrismItemMatchingDefinition.Delegable<T>, PrismItemMatchingDefinition.Mutator, PrismItemMatchingDefinition.Mutator.Delegable, PrismItemStorageDefinition, PrismItemStorageDefinition.Mutable, PrismItemValuesDefinition<T>, PrismItemValuesDefinition.Delegable<T>, PrismItemValuesDefinition.Mutator<T>, PrismItemValuesDefinition.Mutator.Delegable<T>, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, PrismPropertyDefinition<T>, PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>, PrismPropertyDefinition.PrismPropertyLikeDefinitionBuilder<T>, Revivable, SchemaLookup.Aware, SerializableDefinition, SerializableItemDefinition, SerializablePropertyDefinition, SmartVisitable<Definition>, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

public class PrismPropertyDefinitionImpl<T>
extends ItemDefinitionImpl<PrismProperty<T>>
implements PrismPropertyDefinition<T>, PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>, PrismItemValuesDefinition.Delegable<T>, PrismItemValuesDefinition.Mutator.Delegable<T>, PrismItemMatchingDefinition.Delegable<T>, PrismItemMatchingDefinition.Mutator.Delegable, PrismPropertyDefinition.PrismPropertyLikeDefinitionBuilder<T>, SerializablePropertyDefinition

Property Definition.

Property is a basic unit of information in midPoint. This class provides definition of property type, multiplicity and so on.

Property is a specific characteristic of an object. It may be considered object "attribute" or "field". For example User has fullName property that contains string value of user's full name.

Properties may be single-valued or multi-valued

Properties may contain primitive types or complex types (defined by XSD schema)

Property values are unordered, implementation may change the order of values

Duplicate values of properties should be silently removed by implementations, but clients must be able tolerate presence of duplicate values.

Operations that modify the objects work with the granularity of properties. They add/remove/replace the values of properties, but do not "see" inside the property.

This class represents schema definition for property. 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.PrismItemMatchingDefinition

PrismItemMatchingDefinition.Data<T>, PrismItemMatchingDefinition.Delegable<T>, PrismItemMatchingDefinition.Mutator

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

PrismItemMatchingDefinition.Mutator.Delegable

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

PrismItemStorageDefinition.Mutable

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

PrismItemValuesDefinition.Data<T>, PrismItemValuesDefinition.Delegable<T>, PrismItemValuesDefinition.Mutator<T>

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

PrismItemValuesDefinition.Mutator.Delegable<T>

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.PrismPropertyDefinition

PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>, PrismPropertyDefinition.PrismPropertyLikeDefinitionBuilder<T>

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
PrismPropertyDefinitionImpl(QName elementName, QName typeName)
PrismPropertyDefinitionImpl(QName elementName, QName typeName, QName definedInType)
PrismPropertyDefinitionImpl(QName elementName, QName typeName, T defaultValue)
PrismPropertyDefinitionImpl(QName elementName, QName typeName, T defaultValue, QName definedInType)

Method Summary

Modifier and Type	Method	Description
@NotNull PrismPropertyDefinitionImpl<T>	clone()
@NotNull PrismPropertyDefinitionImpl<T>	cloneWithNewName(@NotNull ItemName itemName)	Returns a clone of this definition, but with name changed to the provided one.
protected void	copyDefinitionDataFrom(PrismPropertyDefinition<T> source)
@NotNull PropertyDelta<T>	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
boolean	equals(Object o)
protected void	extendToString(StringBuilder sb)
protected 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.
QName	getMatchingRuleQName()	Returns matching rule name.
int	hashCode()
@NotNull PrismProperty<T>	instantiate()	Create an item instance.
@NotNull PrismProperty<T>	instantiate(QName name)	Create an item instance.
PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>	mutator()	Returns an interface to mutate this definition.
PrismItemMatchingDefinition.Data<T>	prismItemMatchingDefinition()
PrismItemValuesDefinition.Data<T>	prismItemValuesDefinition()
void	setAllowedValues(Collection<? extends DisplayableValue<T>> displayableValues)	Not sure why the default method is not inherited here - from PrismItemValuesDefinition.Mutator.Delegable.setAllowedValues(Collection).
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, findItemDefinition, getItemName, getMaxOccurs, getMergerInstance, getMinOccurs, getObjectBuilt, getProcessing, getSubstitutionHead, getValueEnumerationRef, 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, getSchemaContextDefinition, 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, getSchemaContextDefinition, 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

findItemDefinition, 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.PrismItemMatchingDefinition

getMatchingRule, getNormalizer, getStringNormalizerForPolyStringProperty, getStringNormalizerIfApplicable, getTypeClass, getTypeName, isCustomPolyString

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemMatchingDefinition.Mutator.Delegable

setMatchingRuleQName

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.PrismItemValuesDefinition.Delegable

defaultValue, getAllowedValues, getSuggestedValues, getValueEnumerationRef

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemValuesDefinition.Mutator.Delegable

setDefaultValue, setSuggestedValues, setValueEnumerationRef

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.PrismPropertyDefinition

convertStringValueToPolyString, getTypeClass, getTypeClassLegacy, isAnyType

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.schema.SerializablePropertyDefinition

getValueEnumerationRef

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

accept

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

accept

Constructor Details

PrismPropertyDefinitionImpl

public PrismPropertyDefinitionImpl(QName elementName,
 QName typeName)

PrismPropertyDefinitionImpl

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

PrismPropertyDefinitionImpl

public PrismPropertyDefinitionImpl(QName elementName,
 QName typeName,
 T defaultValue)

PrismPropertyDefinitionImpl

public PrismPropertyDefinitionImpl(QName elementName,
 QName typeName,
 T defaultValue,
 QName definedInType)

Method Details

prismItemValuesDefinition

public PrismItemValuesDefinition.Data<T> prismItemValuesDefinition()

Specified by:

prismItemValuesDefinition in interface PrismItemValuesDefinition.Delegable<T>

Specified by:

prismItemValuesDefinition in interface PrismItemValuesDefinition.Mutator.Delegable<T>

prismItemMatchingDefinition

public PrismItemMatchingDefinition.Data<T> prismItemMatchingDefinition()

Specified by:

prismItemMatchingDefinition in interface PrismItemMatchingDefinition.Delegable<T>

Specified by:

prismItemMatchingDefinition in interface PrismItemMatchingDefinition.Mutator.Delegable

getMatchingRuleQName

public QName getMatchingRuleQName()

Description copied from interface: PrismItemMatchingDefinition

Returns matching rule name. Matching rules are algorithms that specify how to compare, normalize and/or order the values. E.g. there are matching rules for case insensitive string comparison, for LDAP DNs, etc. TODO describe the semantics where special normalizations are to be used Use with care until this description is complete.

Specified by:

getMatchingRuleQName in interface PrismItemMatchingDefinition<T>

Specified by:

getMatchingRuleQName in interface PrismItemMatchingDefinition.Delegable<T>

Specified by:

getMatchingRuleQName in interface SerializablePropertyDefinition

Returns:

matching rule name

instantiate

@NotNull
public @NotNull PrismProperty<T> 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<T>

Specified by:

instantiate in interface PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

instantiate

@NotNull
public @NotNull PrismProperty<T> 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<T>

Specified by:

instantiate in interface PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

createEmptyDelta

@NotNull
public @NotNull PropertyDelta<T> 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<T>

Specified by:

createEmptyDelta in interface PrismItemInstantiableDefinition<T,PrismPropertyValue<T>,PrismProperty<T>,PrismPropertyDefinition<T>,PropertyDelta<T>>

clone

@NotNull
public @NotNull PrismPropertyDefinitionImpl<T> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<T>

Specified by:

clone in interface PrismPropertyDefinition<T>

Specified by:

clone in interface PrismPropertyDefinition.PrismPropertyDefinitionMutator<T>

Specified by:

clone in class ItemDefinitionImpl<PrismProperty<T>>

cloneWithNewName

@NotNull
public @NotNull PrismPropertyDefinitionImpl<T> 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<T>

See Also:

• PrismContainerDefinition.cloneWithNewDefinition(QName, ItemDefinition)

copyDefinitionDataFrom

protected void copyDefinitionDataFrom(PrismPropertyDefinition<T> source)

extendToString

protected void extendToString(StringBuilder sb)

Overrides:

extendToString in class ItemDefinitionImpl<PrismProperty<T>>

equals

public boolean equals(Object o)

Overrides:

equals in class ItemDefinitionImpl<PrismProperty<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class ItemDefinitionImpl<PrismProperty<T>>

getDebugDumpClassName

protected 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

mutator

public PrismPropertyDefinition.PrismPropertyDefinitionMutator<T> 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<T>

Specified by:

mutator in interface PrismPropertyDefinition<T>

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<T>

setAllowedValues

public void setAllowedValues(Collection<? extends DisplayableValue<T>> displayableValues)

Not sure why the default method is not inherited here - from PrismItemValuesDefinition.Mutator.Delegable.setAllowedValues(Collection).

Specified by:

setAllowedValues in interface PrismItemValuesDefinition.Mutator<T>

Specified by:

setAllowedValues in interface PrismItemValuesDefinition.Mutator.Delegable<T>

Specified by:

setAllowedValues in interface PrismPropertyDefinition.PrismPropertyLikeDefinitionBuilder<T>