java.lang.Object
- com.evolveum.midpoint.prism.AbstractFreezable
- - com.evolveum.midpoint.prism.impl.DefinitionImpl

All Implemented Interfaces:

Definition, Freezable, MutableDefinition, PrismContextSensitive, Revivable, SmartVisitable<Definition>, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

Direct Known Subclasses:

ItemDefinitionImpl, TypeDefinitionImpl
```
public abstract class DefinitionImpl
extends AbstractFreezable
implements MutableDefinition
```
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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`deprecated`
`protected String`	`deprecatedSince`
`protected String`	`displayName`
`protected Integer`	`displayOrder`
`protected String`	`documentation`
`protected boolean`	`elaborate`
`protected boolean`	`emphasized`	Set true for definitions that are more important than others and that should be emphasized during presentation.
`protected boolean`	`experimental`
`protected String`	`help`
`protected boolean`	`isAbstract`
`protected boolean`	`isRuntimeSchema`	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
`protected String`	`plannedRemoval`
`protected ItemProcessing`	`processing`
`protected @NotNull QName`	`typeName`

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(Visitor<Definition> visitor)`
`boolean`	`accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)`
`void`	`addDiagram(ItemDiagramSpecification diagram)`
`void`	`addSchemaMigration(SchemaMigration schemaMigration)`
`protected void`	`checkMutableOnExposing()`
`abstract @NotNull Definition`	`clone()`
`protected void`	`copyDefinitionDataFrom(Definition source)`
`String`	`debugDump(int indent)`
`boolean`	`equals(Object obj)`
`protected void`	`extendDumpHeader(StringBuilder sb)`
`<A> A`	`getAnnotation(QName qname)`	Returns generic definition annotation.
`Map<QName,Object>`	`getAnnotations()`	Returns all annotations, as unmodifiable map.
`protected abstract String`	`getDebugDumpClassName()`	Return a human readable name of this class suitable for logs.
`String`	`getDeprecatedSince()`
`List<ItemDiagramSpecification>`	`getDiagrams()`
`String`	`getDisplayName()`	Returns display name.
`Integer`	`getDisplayOrder()`	Specifies an order in which the item should be displayed relative to other items at the same level.
`abstract String`	`getDocClassName()`	Returns human-readable name of this class suitable for documentation.
`String`	`getDocumentation()`
`String`	`getDocumentationPreview()`	Returns only a first sentence of documentation.
`String`	`getHelp()`	Returns help string.
`String`	`getPlannedRemoval()`	Version of data model in which the item is likely to be removed.
`PrismContext`	`getPrismContext()`
`ItemProcessing`	`getProcessing()`	Level of processing (ignore, minimal, auto, full) for this item/type.
`List<SchemaMigration>`	`getSchemaMigrations()`
`Class`	`getTypeClass()`	Returns a compile-time class that is used to represent items.
`@NotNull QName`	`getTypeName()`	Returns a name of the type for this definition.
`int`	`hashCode()`
`boolean`	`isAbstract()`	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
`boolean`	`isDeprecated()`
`boolean`	`isElaborate()`	Elaborate items are complicated data structure that may deviate from normal principles of the system.
`boolean`	`isEmphasized()`	True for definitions that are more important than others and that should be emphasized during presentation.
`boolean`	`isExperimental()`	Experimental functionality is not stable and it may be changed in any future release without any warning.
`boolean`	`isIgnored()`	Item definition that has this flag set should be ignored by any processing.
`boolean`	`isRuntimeSchema()`	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? TODO document (if it's found to be necessary)
`void`	`setAbstract(boolean isAbstract)`
`<A> void`	`setAnnotation(QName qname, A value)`
`void`	`setDeprecated(boolean deprecated)`
`void`	`setDeprecatedSince(String deprecatedSince)`
`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`	`setHelp(String help)`
`void`	`setPlannedRemoval(String plannedRemoval)`
`void`	`setProcessing(ItemProcessing processing)`
`void`	`setRuntimeSchema(boolean isRuntimeSchema)`
`void`	`setTypeName(@NotNull QName typeName)`
`String`	`toString()`

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable
freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze

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
debugDump, getMutabilityFlag, getSchemaRegistry, toMutable

Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable

- Field Detail
  - typeName
```
@NotNull
protected @NotNull QName typeName
```
  - processing
```
protected ItemProcessing processing
```
  - isAbstract
```
protected boolean isAbstract
```
  - displayName
```
protected String displayName
```
  - displayOrder
```
protected Integer displayOrder
```
  - help
```
protected String help
```
  - documentation
```
protected String documentation
```
  - deprecated
```
protected boolean deprecated
```
  - deprecatedSince
```
protected String deprecatedSince
```
  - plannedRemoval
```
protected String plannedRemoval
```
  - experimental
```
protected boolean experimental
```
  - elaborate
```
protected boolean elaborate
```
  - isRuntimeSchema
```
protected boolean isRuntimeSchema
```
    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.
  - emphasized
```
protected boolean emphasized
```
    Set 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 Detail
  - getTypeName
```
@NotNull
public @NotNull QName 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 interface Definition
    
    Returns:
    
    the type name
  - setTypeName
```
public void setTypeName(@NotNull
                        @NotNull QName typeName)
```
    Specified by:
    
    setTypeName in interface MutableDefinition
  - isIgnored
```
public boolean isIgnored()
```
    Description copied from interface: Definition
    
    Item definition that has this flag set should be ignored by any processing. The ignored item is still part of the schema. Item instances may appear in the serialized data formats (e.g. XML) or data store and the parser should not raise an error if it encounters them. But any high-level processing code should ignore presence of this item. E.g. it should not be displayed to the user, should not be present in transformed data structures, etc. Note that the same item can be ignored at higher layer (e.g. presentation) but not ignored at lower layer (e.g. model). This works by presenting different item definitions for these layers (see LayerRefinedAttributeDefinition). Semantics of this flag for complex type definitions is to be defined yet.
    
    Specified by:
    
    isIgnored in interface Definition
  - getProcessing
```
public ItemProcessing getProcessing()
```
    Description copied from interface: Definition
    
    Level of processing (ignore, minimal, auto, full) for this item/type.
    
    Specified by:
    
    getProcessing in interface Definition
  - setProcessing
```
public void setProcessing(ItemProcessing processing)
```
    Specified by:
    
    setProcessing in interface MutableDefinition
  - 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 interface Definition
  - setAbstract
```
public void setAbstract(boolean isAbstract)
```
  - isDeprecated
```
public boolean isDeprecated()
```
    Specified by:
    
    isDeprecated in interface Definition
  - setDeprecated
```
public void setDeprecated(boolean deprecated)
```
    Specified by:
    
    setDeprecated in interface MutableDefinition
  - getDeprecatedSince
```
public String getDeprecatedSince()
```
    Specified by:
    
    getDeprecatedSince in interface Definition
  - setDeprecatedSince
```
public void setDeprecatedSince(String deprecatedSince)
```
  - isExperimental
```
public boolean isExperimental()
```
    Description copied from interface: Definition
    
    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 interface Definition
  - setExperimental
```
public void setExperimental(boolean experimental)
```
    Specified by:
    
    setExperimental in interface MutableDefinition
  - getPlannedRemoval
```
public String getPlannedRemoval()
```
    Description copied from interface: Definition
    
    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 interface Definition
  - setPlannedRemoval
```
public void setPlannedRemoval(String plannedRemoval)
```
  - 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 interface Definition
  - setElaborate
```
public void setElaborate(boolean elaborate)
```
  - isEmphasized
```
public boolean isEmphasized()
```
    Description copied from interface: Definition
    
    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.
    
    Specified by:
    
    isEmphasized in interface Definition
  - setEmphasized
```
public void setEmphasized(boolean emphasized)
```
    Specified by:
    
    setEmphasized in interface MutableDefinition
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: Definition
    
    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 interface Definition
    
    Returns:
    
    display name string or catalog key
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Specified by:
    
    setDisplayName in interface MutableDefinition
  - getDisplayOrder
```
public Integer getDisplayOrder()
```
    Description copied from interface: Definition
    
    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 interface Definition
  - setDisplayOrder
```
public void setDisplayOrder(Integer displayOrder)
```
    Specified by:
    
    setDisplayOrder in interface MutableDefinition
  - getHelp
```
public String getHelp()
```
    Description copied from interface: Definition
    
    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 interface Definition
    
    Returns:
    
    help string or catalog key
  - setHelp
```
public void setHelp(String help)
```
    Specified by:
    
    setHelp in interface MutableDefinition
  - getDocumentation
```
public String getDocumentation()
```
    Specified by:
    
    getDocumentation in interface Definition
  - setDocumentation
```
public void setDocumentation(String documentation)
```
    Specified by:
    
    setDocumentation in interface MutableDefinition
  - getDocumentationPreview
```
public String getDocumentationPreview()
```
    Description copied from interface: Definition
    
    Returns only a first sentence of documentation.
    
    Specified by:
    
    getDocumentationPreview in interface Definition
  - 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 interface Definition
  - setRuntimeSchema
```
public void setRuntimeSchema(boolean isRuntimeSchema)
```
    Specified by:
    
    setRuntimeSchema in interface MutableDefinition
  - getPrismContext
```
public PrismContext getPrismContext()
```
    Specified by:
    
    getPrismContext in interface PrismContextSensitive
  - getTypeClass
```
public Class 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
  - getAnnotation
```
public <A> A getAnnotation(QName qname)
```
    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 interface Definition
  - getAnnotations
```
public Map<QName,Object> 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 interface Definition
  - setAnnotation
```
public <A> void setAnnotation(QName qname,
                              A value)
```
    Specified by:
    
    setAnnotation in interface Definition
  - getSchemaMigrations
```
public List<SchemaMigration> getSchemaMigrations()
```
    Specified by:
    
    getSchemaMigrations in interface Definition
  - addSchemaMigration
```
public void addSchemaMigration(SchemaMigration schemaMigration)
```
    Specified by:
    
    addSchemaMigration in interface MutableDefinition
  - getDiagrams
```
public List<ItemDiagramSpecification> getDiagrams()
```
    Specified by:
    
    getDiagrams in interface Definition
  - addDiagram
```
public void addDiagram(ItemDiagramSpecification diagram)
```
    Specified by:
    
    addDiagram in interface MutableDefinition
  - revive
```
public abstract void revive(PrismContext prismContext)
```
    Description copied from interface: Revivable
    
    TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
    
    Specified by:
    
    revive in interface Revivable
  - copyDefinitionDataFrom
```
protected void copyDefinitionDataFrom(Definition source)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - debugDump
```
public String debugDump(int indent)
```
    Specified by:
    
    debugDump in interface DebugDumpable
  - extendDumpHeader
```
protected void extendDumpHeader(StringBuilder sb)
```
  - getDebugDumpClassName
```
protected abstract String getDebugDumpClassName()
```
    Return a human readable name of this class suitable for logs. (e.g. "PPD")
  - getDocClassName
```
public abstract String getDocClassName()
```
    Returns human-readable name of this class suitable for documentation. (e.g. "property")
  - clone
```
@NotNull
public abstract @NotNull Definition clone()
```
    Specified by:
    
    clone in interface Definition
    
    Overrides:
    
    clone in class Object
  - checkMutableOnExposing
```
protected void checkMutableOnExposing()
```
  - accept
```
public void accept(Visitor<Definition> visitor)
```
    Specified by:
    
    accept in interface Visitable<Definition>
  - accept
```
public boolean accept(Visitor<Definition> visitor,
                      SmartVisitation<Definition> visitation)
```
    Specified by:
    
    accept in interface SmartVisitable<Definition>
    
    Returns:
    
    false if we already was here

Class DefinitionImpl

Field Summary

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

Method Summary

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

Methods inherited from class java.lang.Object

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

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

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

Field Detail

typeName

processing

isAbstract

displayName

displayOrder

help

documentation

deprecated

deprecatedSince

plannedRemoval

experimental

elaborate

isRuntimeSchema

emphasized

Method Detail

getTypeName

setTypeName

isIgnored

getProcessing

setProcessing

isAbstract

setAbstract

isDeprecated

setDeprecated

getDeprecatedSince

setDeprecatedSince

isExperimental

setExperimental

getPlannedRemoval

setPlannedRemoval

isElaborate

setElaborate

isEmphasized

setEmphasized

getDisplayName

setDisplayName

getDisplayOrder

setDisplayOrder

getHelp

setHelp

getDocumentation

setDocumentation

getDocumentationPreview

isRuntimeSchema

setRuntimeSchema

getPrismContext

getTypeClass

getAnnotation

getAnnotations

setAnnotation

getSchemaMigrations

addSchemaMigration

getDiagrams

addDiagram

revive

copyDefinitionDataFrom

hashCode

equals

toString

debugDump

extendDumpHeader

getDebugDumpClassName

getDocClassName

clone

checkMutableOnExposing

accept

accept