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.DefinitionMutatorNested 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 Stringprotected DisplayHintprotected Stringprotected Integerprotected Stringprotected booleanprotected booleanSet true for definitions that are more important than others and that should be emphasized during presentation.protected booleanprotected Stringprotected booleanprotected booleanThis means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.protected Stringprotected booleanprotected Stringprotected final @NotNull QNameFinal 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 TypeMethodDescriptionvoidaccept(Visitor<Definition> visitor) booleanaccept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation) voidaddSchemaMigration(SchemaMigration schemaMigration) abstract @NotNull Definitionclone()protected voidcopyDefinitionDataFrom(Definition source) debugDump(int indent) booleanprotected void<A> AgetAnnotation(QName qname) Returns generic definition annotation.<A> AgetAnnotation(QName qname, A defaultValue) Returns all annotations, as unmodifiable map.protected abstract StringReturn 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 StringReturns 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 ItemMergergetMergerInstance(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker) @Nullable NaturalKeyDefinitionVersion of data model in which the item is likely to be removed.@Nullable SchemaContextDefinition@NotNull QNameReturns a name of the type for this definition.inthashCode()booleanFor types: is the type abstract so that it should not be instantiated directly?booleanbooleanElaborate items are complicated data structure that may deviate from normal principles of the system.booleanTrue for definitions that are more important than others and that should be emphasized during presentation.booleanExperimental functionality is not stable and it may be changed in any future release without any warning.booleanMarks item that could be ignored by SCM tools (e.g.booleanbooleanThis means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.abstract voidrevive(PrismContext prismContext) TODO: Is revive necessary if prism context is static?voidsetAbstract(boolean isAbstract) <A> voidsetAnnotation(QName qname, A value) voidsetDeprecated(boolean deprecated) voidsetDeprecatedSince(String deprecatedSince) voidsetDiagrams(List<ItemDiagramSpecification> value) voidsetDisplayHint(DisplayHint displayHint) voidsetDisplayName(String displayName) voidsetDisplayOrder(Integer displayOrder) voidsetDocumentation(String documentation) voidsetElaborate(boolean elaborate) voidsetEmphasized(boolean emphasized) voidsetExperimental(boolean experimental) voidvoidsetMergerIdentifier(String mergerIdentifier) voidsetNaturalKeyConstituents(List<QName> naturalKeyConstituents) voidsetOptionalCleanup(boolean optionalCleanup) voidsetPlannedRemoval(String plannedRemoval) voidsetRemoved(boolean removed) voidsetRemovedSince(String removedSince) voidsetRuntimeSchema(boolean isRuntimeSchema) voidsetSchemaContextDefinition(SchemaContextDefinition schemaContextDefinition) voidsetSchemaMigrations(List<SchemaMigration> value) toString()Methods 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, debugDumpLazily, debugDumpLazilyMethods inherited from interface com.evolveum.midpoint.prism.Definition
checkMutableOnExposing, debugDump, getMutabilityFlag, getTypeClass, mutatorMethods 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:DefinitionReturns 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:
getTypeNamein interfaceDefinition- Returns:
- the type name
-
getMergerIdentifier
- Specified by:
getMergerIdentifierin interfaceDefinition
-
getMergerInstance
@Nullable public @Nullable ItemMerger getMergerInstance(@NotNull @NotNull MergeStrategy strategy, @Nullable @Nullable OriginMarker originMarker) - Specified by:
getMergerInstancein interfaceDefinition
-
getNaturalKeyConstituents
- Specified by:
getNaturalKeyConstituentsin interfaceDefinition
-
getNaturalKeyInstance
- Specified by:
getNaturalKeyInstancein interfaceDefinition
-
setMergerIdentifier
- Specified by:
setMergerIdentifierin interfaceDefinition.DefinitionMutator
-
setNaturalKeyConstituents
- Specified by:
setNaturalKeyConstituentsin interfaceDefinition.DefinitionMutator
-
isAbstract
public boolean isAbstract()Description copied from interface:DefinitionFor types: is the type abstract so that it should not be instantiated directly? For items: TODO- Specified by:
isAbstractin interfaceDefinition
-
setAbstract
public void setAbstract(boolean isAbstract) -
isDeprecated
public boolean isDeprecated()- Specified by:
isDeprecatedin interfacePrismLifecycleDefinition
-
setDeprecated
public void setDeprecated(boolean deprecated) - Specified by:
setDeprecatedin interfacePrismLifecycleDefinition.Mutable
-
getDeprecatedSince
- Specified by:
getDeprecatedSincein interfacePrismLifecycleDefinition
-
setDeprecatedSince
- Specified by:
setDeprecatedSincein interfacePrismLifecycleDefinition.Mutable
-
isRemoved
public boolean isRemoved()- Specified by:
isRemovedin interfacePrismLifecycleDefinition
-
setRemoved
public void setRemoved(boolean removed) - Specified by:
setRemovedin interfacePrismLifecycleDefinition.Mutable
-
isOptionalCleanup
public boolean isOptionalCleanup()Description copied from interface:DefinitionMarks item that could be ignored by SCM tools (e.g. Git), or removed before commit.- Specified by:
isOptionalCleanupin interfaceDefinition
-
setOptionalCleanup
public void setOptionalCleanup(boolean optionalCleanup) - Specified by:
setOptionalCleanupin interfaceDefinition.DefinitionMutator
-
getRemovedSince
- Specified by:
getRemovedSincein interfacePrismLifecycleDefinition
-
setRemovedSince
- Specified by:
setRemovedSincein interfacePrismLifecycleDefinition.Mutable
-
isExperimental
public boolean isExperimental()Description copied from interface:PrismLifecycleDefinitionExperimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.- Specified by:
isExperimentalin interfacePrismLifecycleDefinition
-
setExperimental
public void setExperimental(boolean experimental) - Specified by:
setExperimentalin interfacePrismLifecycleDefinition.Mutable
-
getPlannedRemoval
Description copied from interface:PrismLifecycleDefinitionVersion 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:
getPlannedRemovalin interfacePrismLifecycleDefinition
-
setPlannedRemoval
- Specified by:
setPlannedRemovalin interfacePrismLifecycleDefinition.Mutable
-
isElaborate
public boolean isElaborate()Description copied from interface:DefinitionElaborate 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:
isElaboratein interfaceDefinition
-
setElaborate
public void setElaborate(boolean elaborate) -
getDisplayHint
Description copied from interface:PrismPresentationDefinitionEnumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.- Specified by:
getDisplayHintin interfacePrismPresentationDefinition
-
setDisplayHint
- Specified by:
setDisplayHintin interfacePrismPresentationDefinition.Mutable
-
isEmphasized
public boolean isEmphasized()Description copied from interface:PrismPresentationDefinitionTrue 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:
isEmphasizedin interfacePrismPresentationDefinition
-
setEmphasized
public void setEmphasized(boolean emphasized) - Specified by:
setEmphasizedin interfacePrismPresentationDefinition.Mutable
-
getDisplayName
Description copied from interface:PrismPresentationDefinitionReturns 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:
getDisplayNamein interfacePrismPresentationDefinition- Returns:
- display name string or catalog key
-
setDisplayName
- Specified by:
setDisplayNamein interfacePrismPresentationDefinition.Mutable
-
getDisplayOrder
Description copied from interface:PrismPresentationDefinitionSpecifies 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:
getDisplayOrderin interfacePrismPresentationDefinition
-
setDisplayOrder
- Specified by:
setDisplayOrderin interfacePrismPresentationDefinition.Mutable
-
getHelp
Description copied from interface:PrismPresentationDefinitionReturns 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:
getHelpin interfacePrismPresentationDefinition- Returns:
- help string or catalog key
-
setHelp
- Specified by:
setHelpin interfacePrismPresentationDefinition.Mutable
-
getDocumentation
Description copied from interface:PrismPresentationDefinitionMust containstag because of html tags used in text. - Specified by:
getDocumentationin interfacePrismPresentationDefinition
-
setDocumentation
- Specified by:
setDocumentationin interfacePrismPresentationDefinition.Mutable
-
getDocumentationPreview
Description copied from interface:PrismPresentationDefinitionReturns only a first sentence of documentation.- Specified by:
getDocumentationPreviewin interfacePrismPresentationDefinition
-
isRuntimeSchema
public boolean isRuntimeSchema()Description copied from interface:DefinitionThis 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:
isRuntimeSchemain interfaceDefinition
-
setRuntimeSchema
public void setRuntimeSchema(boolean isRuntimeSchema) - Specified by:
setRuntimeSchemain interfaceDefinition.DefinitionMutator
-
getAnnotation
-
getAnnotation
Description copied from interface:DefinitionReturns 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:
getAnnotationin interfaceDefinition
-
getAnnotations
Description copied from interface:DefinitionReturns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.- Specified by:
getAnnotationsin interfaceDefinition
-
setAnnotation
- Specified by:
setAnnotationin interfaceDefinition.DefinitionMutator
-
getSchemaMigrations
- Specified by:
getSchemaMigrationsin interfacePrismLifecycleDefinition
-
addSchemaMigration
- Specified by:
addSchemaMigrationin interfacePrismLifecycleDefinition.Mutable
-
setSchemaMigrations
- Specified by:
setSchemaMigrationsin interfacePrismLifecycleDefinition.Mutable
-
getDiagrams
- Specified by:
getDiagramsin interfacePrismPresentationDefinition
-
setDiagrams
- Specified by:
setDiagramsin interfacePrismPresentationDefinition.Mutable
-
getSchemaContextDefinition
- Specified by:
getSchemaContextDefinitionin interfaceDefinition
-
setSchemaContextDefinition
- Specified by:
setSchemaContextDefinitionin interfaceDefinition.DefinitionMutator
-
revive
Description copied from interface:RevivableTODO: 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:
debugDumpin 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:
clonein interfaceDefinition- Overrides:
clonein classObject
-
accept
- Specified by:
acceptin interfaceVisitable<Definition>
-
accept
- Specified by:
acceptin interfaceSmartVisitable<Definition>- Returns:
- false if we already was here
-