Package com.evolveum.midpoint.prism.impl
Class ItemDefinitionImpl<I extends Item<?,?>>
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<I>
- All Implemented Interfaces:
Definition,Definition.DefinitionBuilder,Definition.DefinitionMutator,DefinitionFragmentBuilder,Freezable,ItemDefinition<I>,ItemDefinition.ItemDefinitionLikeBuilder,ItemDefinition.ItemDefinitionMutator,LivePrismItemDefinition,PrismItemAccessDefinition,PrismItemAccessDefinition.Mutable,PrismItemBasicDefinition,PrismItemBasicDefinition.Mutable,PrismItemStorageDefinition,PrismItemStorageDefinition.Mutable,PrismLifecycleDefinition,PrismLifecycleDefinition.Mutable,PrismPresentationDefinition,PrismPresentationDefinition.Mutable,Revivable,SchemaLookup.Aware,SerializableDefinition,SerializableItemDefinition,SmartVisitable<Definition>,Visitable<Definition>,DebugDumpable,Serializable,Cloneable
- Direct Known Subclasses:
PrismContainerDefinitionImpl,PrismPropertyDefinitionImpl,PrismReferenceDefinitionImpl
public abstract class ItemDefinitionImpl<I extends Item<?,?>>
extends DefinitionImpl
implements ItemDefinition<I>, ItemDefinition.ItemDefinitionMutator, ItemDefinition.ItemDefinitionLikeBuilder, SerializableItemDefinition
Abstract item definition in the schema.
This is supposed to be a superclass for all item definitions. Items are things
that can appear in property containers, which generally means only a property
and property container itself. Therefore this is in fact superclass for those
two definitions.
The definitions represent data structures of the schema. Therefore instances
of Java objects from this class represent specific definitions from
the schema, not specific properties or objects. E.g the definitions does not
have any value.
To transform definition to a real property or object use the explicit
instantiate() methods provided in the definition classes. E.g. the
instantiate() method will create instance of Property using appropriate
PropertyDefinition.
The convenience methods in Schema are using this abstract class to find
appropriate definitions easily.
- Author:
- Radovan Semancik
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition
Definition.DefinitionBuilder, Definition.DefinitionMutatorNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition
ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutatorNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable
PrismItemAccessDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition
PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable
PrismItemBasicDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition
PrismItemStorageDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition
PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable
PrismLifecycleDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition
PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable
PrismPresentationDefinition.Mutable.Delegable -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanprotected final @NotNull ItemNameFinal because it's sometimes used as a key in maps; moreover, it forms an identity of the definition somehow.protected ItemProcessingprotected QNameFields inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl
deprecated, deprecatedSince, displayHint, displayName, displayOrder, documentation, elaborate, emphasized, experimental, help, isAbstract, isRuntimeSchema, plannedRemoval, removed, removedSince, typeNameFields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING -
Method Summary
Modifier and TypeMethodDescriptionbooleancanAdd()Returns true if the item can be added.booleanReturns true if the item can be modified.booleancanRead()Returns true if the property can be read.abstract @NotNull ItemDefinition<I>clone()protected voidcopyDefinitionDataFrom(ItemDefinition<I> source) voidUsed in debugDumping items.deepClone(@NotNull DeepCloneOperation operation) Make a deep clone, cloning all the sub-items and definitions.booleanprotected void<T extends ItemDefinition<?>>
TfindItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz) Used to find a matching item definition _within_ this definition.@NotNull ItemNameReturns name of the defined entity.intReturns the number of maximal value occurrences.@Nullable ItemMergergetMergerInstance(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker) intReturns the number of minimal value occurrences.Returns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc).Reference to an object that directly or indirectly represents possible values for this item.inthashCode()booleanItem which should always be used for equals even if it is operational and strategy does not consider operational items.booleanReturns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.booleanCan be used in heterogeneous lists as a list item.This is XSD annotation that specifies whether a property should be indexed in the storage.booleanIf true, this item is not stored in XML representation in repo.booleanWhether the item is inherited from a supertype.booleanMarks operational item.booleanReturns true if item definition is searchable.booleanisValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive) Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way.voidrevive(PrismContext prismContext) TODO: Is revive necessary if prism context is static?voidsetAlwaysUseForEquals(boolean alwaysUseForEquals) voidsetCanAdd(boolean add) voidsetCanModify(boolean modify) voidsetCanRead(boolean read) voidsetDynamic(boolean dynamic) voidsetHeterogeneousListItem(boolean heterogeneousListItem) voidsetIndexed(Boolean indexed) voidsetIndexOnly(boolean indexOnly) voidsetInherited(boolean inherited) voidsetMaxOccurs(int maxOccurs) voidsetMinOccurs(int minOccurs) voidsetOperational(boolean operational) voidsetProcessing(ItemProcessing itemProcessing) voidvoidsetSearchable(boolean searchable) voidsetSubstitutionHead(QName substitutionHead) voidsetValueEnumerationRef(PrismReferenceValue valueEnumerationRef) toString()protected static booleanuseSerializationProxy(boolean localEnabled) protected ObjectMethods inherited from class com.evolveum.midpoint.prism.impl.DefinitionImpl
accept, accept, addSchemaMigration, copyDefinitionDataFrom, debugDump, extendDumpHeader, getAnnotation, getAnnotation, getAnnotations, getDebugDumpClassName, getDeprecatedSince, getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocClassName, 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, setSchemaMigrationsMethods inherited from class com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware
performFreeze, schemaLookup, setSchemaLookupMethods inherited from class com.evolveum.midpoint.prism.AbstractFreezable
freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutableMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDump, debugDumpLazily, debugDumpLazilyMethods inherited from interface com.evolveum.midpoint.prism.Definition
checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getSchemaContextDefinition, getTypeClass, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchemaMethods inherited from interface com.evolveum.midpoint.prism.Definition.DefinitionMutator
setAnnotation, setMergerIdentifier, setNaturalKeyConstituents, setOptionalCleanup, setRuntimeSchema, setSchemaContextDefinitionMethods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutableMethods inherited from interface com.evolveum.midpoint.prism.ItemDefinition
cloneWithNewName, createEmptyDelta, instantiate, instantiate, isIgnored, mutator, structuredTypeMethods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionLikeBuilder
getExtraFeaturesToParseMethods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionMutator
setDeprecatedSince, setElaborate, setIgnored, setPlannedRemovalMethods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
getInfoMethods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable
setInfoMethods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition
getTypeName, isMandatory, isMultiValue, isOptional, isSingleValueMethods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition
getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemovedMethods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable
addSchemaMigration, setDeprecated, setExperimental, setRemoved, setRemovedSince, setSchemaMigrationsMethods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition
getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasizedMethods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable
setDiagrams, setDisplayHint, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setHelpMethods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware
schemaLookupMethods inherited from interface com.evolveum.midpoint.prism.schema.SerializableDefinition
getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getExtraFeaturesToSerialize, getHelp, isEmphasizedMethods inherited from interface com.evolveum.midpoint.prism.schema.SerializableItemDefinition
getTypeNameMethods inherited from interface com.evolveum.midpoint.prism.SmartVisitable
accept
-
Field Details
-
itemName
Final because it's sometimes used as a key in maps; moreover, it forms an identity of the definition somehow. -
substitutionHead
-
heterogeneousListItem
protected boolean heterogeneousListItem -
processing
-
-
Method Details
-
useSerializationProxy
protected static boolean useSerializationProxy(boolean localEnabled) -
getItemName
Returns name of the defined entity. The name is a name of the entity instance if it is fixed by the schema. E.g. it may be a name of the property in the container that cannot be changed. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. Name is optional. If name is not set the null value is returned. If name is not set the type is "abstract", does not correspond to the element.- Specified by:
getItemNamein interfacePrismItemBasicDefinition- Specified by:
getItemNamein interfaceSerializableItemDefinition- Returns:
- the name name of the entity or null.
-
getMinOccurs
public int getMinOccurs()Description copied from interface:PrismItemBasicDefinitionReturns the number of minimal value occurrences.- Specified by:
getMinOccursin interfacePrismItemBasicDefinition- Specified by:
getMinOccursin interfaceSerializableItemDefinition
-
setMinOccurs
public void setMinOccurs(int minOccurs) - Specified by:
setMinOccursin interfacePrismItemBasicDefinition.Mutable
-
getMaxOccurs
public int getMaxOccurs()Description copied from interface:PrismItemBasicDefinitionReturns the number of maximal value occurrences. Any negative number means "unbounded".- Specified by:
getMaxOccursin interfacePrismItemBasicDefinition- Specified by:
getMaxOccursin interfaceSerializableItemDefinition
-
setMaxOccurs
public void setMaxOccurs(int maxOccurs) - Specified by:
setMaxOccursin interfacePrismItemBasicDefinition.Mutable
-
isOperational
public boolean isOperational()Description copied from interface:ItemDefinitionMarks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. SeeParameterizedEquivalenceStrategy.- Specified by:
isOperationalin interfaceItemDefinition<I extends Item<?,?>> - Specified by:
isOperationalin interfaceSerializableItemDefinition
-
setOperational
public void setOperational(boolean operational) - Specified by:
setOperationalin interfaceItemDefinition.ItemDefinitionMutator
-
isAlwaysUseForEquals
public boolean isAlwaysUseForEquals()Description copied from interface:ItemDefinitionItem which should always be used for equals even if it is operational and strategy does not consider operational items. EXPERIMENTAL- Specified by:
isAlwaysUseForEqualsin interfaceItemDefinition<I extends Item<?,?>>
-
setAlwaysUseForEquals
public void setAlwaysUseForEquals(boolean alwaysUseForEquals) - Specified by:
setAlwaysUseForEqualsin interfaceItemDefinition.ItemDefinitionMutator
-
isDynamic
public boolean isDynamic()Description copied from interface:ItemDefinitionReturns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).- Specified by:
isDynamicin interfaceItemDefinition<I extends Item<?,?>>
-
setDynamic
public void setDynamic(boolean dynamic) - Specified by:
setDynamicin interfaceItemDefinition.ItemDefinitionMutator
-
canRead
public boolean canRead()Returns true if the property can be read. I.e. if it is returned in objects retrieved from "get", "search" and similar operations.- Specified by:
canReadin interfacePrismItemAccessDefinition
-
canModify
public boolean canModify()Returns true if the item can be modified. I.e. if it can be changed during a modification of existing object.- Specified by:
canModifyin interfacePrismItemAccessDefinition
-
setReadOnly
public void setReadOnly()- Specified by:
setReadOnlyin interfaceItemDefinition.ItemDefinitionMutator
-
setCanRead
public void setCanRead(boolean read) - Specified by:
setCanReadin interfacePrismItemAccessDefinition.Mutable
-
setCanModify
public void setCanModify(boolean modify) - Specified by:
setCanModifyin interfacePrismItemAccessDefinition.Mutable
-
setCanAdd
public void setCanAdd(boolean add) - Specified by:
setCanAddin interfacePrismItemAccessDefinition.Mutable
-
canAdd
public boolean canAdd()Returns true if the item can be added. I.e. if it can be present in the object when a new object is created.- Specified by:
canAddin interfacePrismItemAccessDefinition
-
getSubstitutionHead
Description copied from interface:ItemDefinitionReturns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL- Specified by:
getSubstitutionHeadin interfaceItemDefinition<I extends Item<?,?>>
-
setSubstitutionHead
- Specified by:
setSubstitutionHeadin interfaceItemDefinition.ItemDefinitionMutator
-
isHeterogeneousListItem
public boolean isHeterogeneousListItem()Description copied from interface:ItemDefinitionCan be used in heterogeneous lists as a list item. EXPERIMENTAL.- Specified by:
isHeterogeneousListItemin interfaceItemDefinition<I extends Item<?,?>>
-
setHeterogeneousListItem
public void setHeterogeneousListItem(boolean heterogeneousListItem) - Specified by:
setHeterogeneousListItemin interfaceItemDefinition.ItemDefinitionMutator
-
getValueEnumerationRef
Description copied from interface:ItemDefinitionReference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.- Specified by:
getValueEnumerationRefin interfaceItemDefinition<I extends Item<?,?>>
-
setValueEnumerationRef
- Specified by:
setValueEnumerationRefin interfaceItemDefinition.ItemDefinitionMutator
-
isValidFor
public boolean isValidFor(@NotNull @NotNull QName elementQName, @NotNull @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive) Description copied from interface:LivePrismItemDefinitionReturns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.- Specified by:
isValidForin interfaceLivePrismItemDefinition
-
findItemDefinition
public <T extends ItemDefinition<?>> T findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<T> clazz) Description copied from interface:LivePrismItemDefinitionUsed to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.- Specified by:
findItemDefinitionin interfaceLivePrismItemDefinition
-
clone
- Specified by:
clonein interfaceDefinition- Specified by:
clonein interfaceItemDefinition<I extends Item<?,?>> - Specified by:
clonein classDefinitionImpl
-
copyDefinitionDataFrom
-
deepClone
Make a deep clone, cloning all the sub-items and definitions.- Specified by:
deepClonein interfaceItemDefinition<I extends Item<?,?>>
-
revive
Description copied from interface:RevivableTODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)- Specified by:
revivein interfaceRevivable- Specified by:
revivein classDefinitionImpl
-
equals
- Overrides:
equalsin classDefinitionImpl
-
hashCode
public int hashCode()- Overrides:
hashCodein classDefinitionImpl
-
toString
- Overrides:
toStringin classDefinitionImpl
-
debugDumpShortToString
Used in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.- Specified by:
debugDumpShortToStringin interfaceItemDefinition<I extends Item<?,?>>
-
debugDisplayOrder
-
debugMultiplicity
-
debugFlags
-
extendToString
-
isInherited
public boolean isInherited()Description copied from interface:ItemDefinitionWhether the item is inherited from a supertype.- Specified by:
isInheritedin interfaceItemDefinition<I extends Item<?,?>>
-
setInherited
public void setInherited(boolean inherited) - Specified by:
setInheritedin interfaceItemDefinition.ItemDefinitionMutator
-
isIndexed
Description copied from interface:PrismItemStorageDefinitionThis is XSD annotation that specifies whether a property should be indexed in the storage. It can only apply to properties. It has following meaning: true: the property must be indexed. If the storage is not able to index the value, it should indicate an error. false: the property should not be indexed. null: data store decides whether to index the property or not.- Specified by:
isIndexedin interfacePrismItemStorageDefinition- Specified by:
isIndexedin interfaceSerializableItemDefinition
-
setIndexed
- Specified by:
setIndexedin interfacePrismItemStorageDefinition.Mutable
-
isIndexOnly
public boolean isIndexOnly()Description copied from interface:PrismItemStorageDefinitionIf true, this item is not stored in XML representation in repo. TODO better name- Specified by:
isIndexOnlyin interfacePrismItemStorageDefinition
-
setIndexOnly
public void setIndexOnly(boolean indexOnly) - Specified by:
setIndexOnlyin interfaceItemDefinition.ItemDefinitionMutator- Specified by:
setIndexOnlyin interfacePrismItemStorageDefinition.Mutable
-
isSearchable
public boolean isSearchable()Description copied from interface:PrismItemStorageDefinitionReturns true if item definition is searchable.- Specified by:
isSearchablein interfacePrismItemStorageDefinition
-
setSearchable
public void setSearchable(boolean searchable) - Specified by:
setSearchablein interfaceItemDefinition.ItemDefinitionMutator- Specified by:
setSearchablein interfacePrismItemStorageDefinition.Mutable
-
writeReplace
-
getProcessing
- Specified by:
getProcessingin interfaceItemDefinition<I extends Item<?,?>> - Specified by:
getProcessingin interfaceSerializableItemDefinition
-
setProcessing
- Specified by:
setProcessingin interfaceItemDefinition.ItemDefinitionMutator
-
getObjectBuilt
- Specified by:
getObjectBuiltin interfaceDefinitionFragmentBuilder
-
getMergerInstance
@Nullable public @Nullable ItemMerger getMergerInstance(@NotNull @NotNull MergeStrategy strategy, @Nullable @Nullable OriginMarker originMarker) - Specified by:
getMergerInstancein interfaceDefinition- Overrides:
getMergerInstancein classDefinitionImpl
-