Package com.evolveum.midpoint.prism.impl
Class DefinitionImpl
java.lang.Object
com.evolveum.midpoint.prism.AbstractFreezable
com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware
com.evolveum.midpoint.prism.impl.DefinitionImpl
- All Implemented Interfaces:
Definition
,Definition.DefinitionMutator
,Freezable
,PrismLifecycleDefinition
,PrismLifecycleDefinition.Mutable
,PrismPresentationDefinition
,PrismPresentationDefinition.Mutable
,Revivable
,SchemaLookup.Aware
,SmartVisitable<Definition>
,Visitable<Definition>
,DebugDumpable
,Serializable
,Cloneable
- Direct Known Subclasses:
ItemDefinitionImpl
,TypeDefinitionImpl
public abstract class DefinitionImpl
extends SchemaRegistryStateAware
implements Definition, Definition.DefinitionMutator
Abstract definition in the schema.
This is supposed to be a superclass for all definitions. It defines common
properties for all 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.DefinitionMutator
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
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected String
protected DisplayHint
protected String
protected Integer
protected String
protected boolean
protected boolean
Set true for definitions that are more important than others and that should be emphasized during presentation.protected boolean
protected String
protected boolean
protected boolean
This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.protected String
protected boolean
protected String
protected final @NotNull QName
Final because it's sometimes used as a key in maps; moreover, it forms an identity of the definition somehow.Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(Visitor<Definition> visitor) boolean
accept
(Visitor<Definition> visitor, SmartVisitation<Definition> visitation) void
addSchemaMigration
(SchemaMigration schemaMigration) abstract @NotNull Definition
clone()
protected void
copyDefinitionDataFrom
(Definition source) debugDump
(int indent) boolean
protected void
<A> A
getAnnotation
(QName qname) Returns generic definition annotation.<A> A
getAnnotation
(QName qname, A defaultValue) Returns all annotations, as unmodifiable map.protected abstract String
Return a human readable name of this class suitable for logs.Enumeration annotation that specifies how/whether the item should be displayed.Returns display name.Specifies an order in which the item should be displayed relative to other items at the same level.abstract String
Returns human-readable name of this class suitable for documentation.Must containstag because of html tags used in text. Returns only a first sentence of documentation.getHelp()
Returns help string.@Nullable String
@Nullable ItemMerger
getMergerInstance
(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker) @Nullable NaturalKeyDefinition
Version of data model in which the item is likely to be removed.@Nullable SchemaContextDefinition
@NotNull QName
Returns a name of the type for this definition.int
hashCode()
boolean
For types: is the type abstract so that it should not be instantiated directly?boolean
boolean
Elaborate items are complicated data structure that may deviate from normal principles of the system.boolean
True for definitions that are more important than others and that should be emphasized during presentation.boolean
Experimental functionality is not stable and it may be changed in any future release without any warning.boolean
Marks item that could be ignored by SCM tools (e.g.boolean
boolean
This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.abstract void
revive
(PrismContext prismContext) TODO: Is revive necessary if prism context is static?void
setAbstract
(boolean isAbstract) <A> void
setAnnotation
(QName qname, A value) void
setDeprecated
(boolean deprecated) void
setDeprecatedSince
(String deprecatedSince) void
setDiagrams
(List<ItemDiagramSpecification> value) void
setDisplayHint
(DisplayHint displayHint) void
setDisplayName
(String displayName) void
setDisplayOrder
(Integer displayOrder) void
setDocumentation
(String documentation) void
setElaborate
(boolean elaborate) void
setEmphasized
(boolean emphasized) void
setExperimental
(boolean experimental) void
void
setMergerIdentifier
(String mergerIdentifier) void
setNaturalKeyConstituents
(List<QName> naturalKeyConstituents) void
setOptionalCleanup
(boolean optionalCleanup) void
setPlannedRemoval
(String plannedRemoval) void
setRemoved
(boolean removed) void
setRemovedSince
(String removedSince) void
setRuntimeSchema
(boolean isRuntimeSchema) void
setSchemaContextDefinition
(SchemaContextDefinition schemaContextDefinition) void
setSchemaMigrations
(List<SchemaMigration> value) toString()
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, debugDumpLazily, debugDumpLazily
Methods inherited from interface com.evolveum.midpoint.prism.Definition
checkMutableOnExposing, debugDump, getMutabilityFlag, getTypeClass, mutator
Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable
-
Field Details
-
typeName
Final because it's sometimes used as a key in maps; moreover, it forms an identity of the definition somehow. -
isAbstract
protected boolean isAbstract -
displayHint
-
displayName
-
displayOrder
-
help
-
documentation
-
deprecated
protected boolean deprecated -
deprecatedSince
-
removed
protected boolean removed -
removedSince
-
plannedRemoval
-
experimental
protected boolean experimental -
elaborate
protected boolean elaborate -
isRuntimeSchema
protected boolean isRuntimeSchemaThis means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically. -
emphasized
protected boolean emphasizedSet true for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc.
-
-
Method Details
-
getTypeName
Description copied from interface:Definition
Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)- Specified by:
getTypeName
in interfaceDefinition
- Returns:
- the type name
-
getMergerIdentifier
- Specified by:
getMergerIdentifier
in interfaceDefinition
-
getMergerInstance
@Nullable public @Nullable ItemMerger getMergerInstance(@NotNull @NotNull MergeStrategy strategy, @Nullable @Nullable OriginMarker originMarker) - Specified by:
getMergerInstance
in interfaceDefinition
-
getNaturalKeyConstituents
- Specified by:
getNaturalKeyConstituents
in interfaceDefinition
-
getNaturalKeyInstance
- Specified by:
getNaturalKeyInstance
in interfaceDefinition
-
setMergerIdentifier
- Specified by:
setMergerIdentifier
in interfaceDefinition.DefinitionMutator
-
setNaturalKeyConstituents
- Specified by:
setNaturalKeyConstituents
in interfaceDefinition.DefinitionMutator
-
isAbstract
public boolean isAbstract()Description copied from interface:Definition
For types: is the type abstract so that it should not be instantiated directly? For items: TODO- Specified by:
isAbstract
in interfaceDefinition
-
setAbstract
public void setAbstract(boolean isAbstract) -
isDeprecated
public boolean isDeprecated()- Specified by:
isDeprecated
in interfacePrismLifecycleDefinition
-
setDeprecated
public void setDeprecated(boolean deprecated) - Specified by:
setDeprecated
in interfacePrismLifecycleDefinition.Mutable
-
getDeprecatedSince
- Specified by:
getDeprecatedSince
in interfacePrismLifecycleDefinition
-
setDeprecatedSince
- Specified by:
setDeprecatedSince
in interfacePrismLifecycleDefinition.Mutable
-
isRemoved
public boolean isRemoved()- Specified by:
isRemoved
in interfacePrismLifecycleDefinition
-
setRemoved
public void setRemoved(boolean removed) - Specified by:
setRemoved
in interfacePrismLifecycleDefinition.Mutable
-
isOptionalCleanup
public boolean isOptionalCleanup()Description copied from interface:Definition
Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.- Specified by:
isOptionalCleanup
in interfaceDefinition
-
setOptionalCleanup
public void setOptionalCleanup(boolean optionalCleanup) - Specified by:
setOptionalCleanup
in interfaceDefinition.DefinitionMutator
-
getRemovedSince
- Specified by:
getRemovedSince
in interfacePrismLifecycleDefinition
-
setRemovedSince
- Specified by:
setRemovedSince
in interfacePrismLifecycleDefinition.Mutable
-
isExperimental
public boolean isExperimental()Description copied from interface:PrismLifecycleDefinition
Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.- Specified by:
isExperimental
in interfacePrismLifecycleDefinition
-
setExperimental
public void setExperimental(boolean experimental) - Specified by:
setExperimental
in interfacePrismLifecycleDefinition.Mutable
-
getPlannedRemoval
Description copied from interface:PrismLifecycleDefinition
Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.- Specified by:
getPlannedRemoval
in interfacePrismLifecycleDefinition
-
setPlannedRemoval
- Specified by:
setPlannedRemoval
in interfacePrismLifecycleDefinition.Mutable
-
isElaborate
public boolean isElaborate()Description copied from interface:Definition
Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.- Specified by:
isElaborate
in interfaceDefinition
-
setElaborate
public void setElaborate(boolean elaborate) -
getDisplayHint
Description copied from interface:PrismPresentationDefinition
Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.- Specified by:
getDisplayHint
in interfacePrismPresentationDefinition
-
setDisplayHint
- Specified by:
setDisplayHint
in interfacePrismPresentationDefinition.Mutable
-
isEmphasized
public boolean isEmphasized()Description copied from interface:PrismPresentationDefinition
True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?- Specified by:
isEmphasized
in interfacePrismPresentationDefinition
-
setEmphasized
public void setEmphasized(boolean emphasized) - Specified by:
setEmphasized
in interfacePrismPresentationDefinition.Mutable
-
getDisplayName
Description copied from interface:PrismPresentationDefinition
Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.- Specified by:
getDisplayName
in interfacePrismPresentationDefinition
- Returns:
- display name string or catalog key
-
setDisplayName
- Specified by:
setDisplayName
in interfacePrismPresentationDefinition.Mutable
-
getDisplayOrder
Description copied from interface:PrismPresentationDefinition
Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.- Specified by:
getDisplayOrder
in interfacePrismPresentationDefinition
-
setDisplayOrder
- Specified by:
setDisplayOrder
in interfacePrismPresentationDefinition.Mutable
-
getHelp
Description copied from interface:PrismPresentationDefinition
Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.- Specified by:
getHelp
in interfacePrismPresentationDefinition
- Returns:
- help string or catalog key
-
setHelp
- Specified by:
setHelp
in interfacePrismPresentationDefinition.Mutable
-
getDocumentation
Description copied from interface:PrismPresentationDefinition
Must containstag because of html tags used in text. - Specified by:
getDocumentation
in interfacePrismPresentationDefinition
-
setDocumentation
- Specified by:
setDocumentation
in interfacePrismPresentationDefinition.Mutable
-
getDocumentationPreview
Description copied from interface:PrismPresentationDefinition
Returns only a first sentence of documentation.- Specified by:
getDocumentationPreview
in interfacePrismPresentationDefinition
-
isRuntimeSchema
public boolean isRuntimeSchema()Description copied from interface:Definition
This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.- Specified by:
isRuntimeSchema
in interfaceDefinition
-
setRuntimeSchema
public void setRuntimeSchema(boolean isRuntimeSchema) - Specified by:
setRuntimeSchema
in interfaceDefinition.DefinitionMutator
-
getAnnotation
-
getAnnotation
Description copied from interface:Definition
Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).- Specified by:
getAnnotation
in interfaceDefinition
-
getAnnotations
Description copied from interface:Definition
Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.- Specified by:
getAnnotations
in interfaceDefinition
-
setAnnotation
- Specified by:
setAnnotation
in interfaceDefinition.DefinitionMutator
-
getSchemaMigrations
- Specified by:
getSchemaMigrations
in interfacePrismLifecycleDefinition
-
addSchemaMigration
- Specified by:
addSchemaMigration
in interfacePrismLifecycleDefinition.Mutable
-
setSchemaMigrations
- Specified by:
setSchemaMigrations
in interfacePrismLifecycleDefinition.Mutable
-
getDiagrams
- Specified by:
getDiagrams
in interfacePrismPresentationDefinition
-
setDiagrams
- Specified by:
setDiagrams
in interfacePrismPresentationDefinition.Mutable
-
getSchemaContextDefinition
- Specified by:
getSchemaContextDefinition
in interfaceDefinition
-
setSchemaContextDefinition
- Specified by:
setSchemaContextDefinition
in interfaceDefinition.DefinitionMutator
-
revive
Description copied from interface:Revivable
TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary) -
copyDefinitionDataFrom
-
hashCode
public int hashCode() -
equals
-
toString
-
debugDump
- Specified by:
debugDump
in interfaceDebugDumpable
-
extendDumpHeader
-
getDebugDumpClassName
Return a human readable name of this class suitable for logs. (e.g. "PPD") -
getDocClassName
Returns human-readable name of this class suitable for documentation. (e.g. "property") -
clone
- Specified by:
clone
in interfaceDefinition
- Overrides:
clone
in classObject
-
accept
- Specified by:
accept
in interfaceVisitable<Definition>
-
accept
- Specified by:
accept
in interfaceSmartVisitable<Definition>
- Returns:
- false if we already was here
-