DefinitionImpl (midPoint API Distribution 3.7 API)

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

All Implemented Interfaces:

Definition, Revivable, DebugDumpable, Serializable

Direct Known Subclasses:

ItemDefinitionImpl, TypeDefinitionImpl
```
public abstract class DefinitionImpl
extends Object
implements Definition
```
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 and Description
`protected boolean`	`deprecated`
`protected String`	`deprecatedSince`
`protected String`	`displayName`
`protected Integer`	`displayOrder`
`protected String`	`documentation`
`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`	`ignored`
`protected boolean`	`inherited` whether an item is inherited from a supertype (experimental feature)
`protected boolean`	`isAbstract`
`protected boolean`	`isRuntimeSchema` This means that the item container is not defined by fixed (compile-time) schema.
`protected PrismContext`	`prismContext`
`protected 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 and Description
`abstract Definition`	`clone()`
`protected void`	`copyDefinitionData(DefinitionImpl clone)`
`String`	`debugDump()` Show the content of the object intended for diagnostics by system administrator.
`String`	`debugDump(int indent)`
`boolean`	`equals(Object obj)`
`protected abstract String`	`getDebugDumpClassName()` Return a human readable name of this class suitable for logs.
`String`	`getDeprecatedSince()`
`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.
`PrismContext`	`getPrismContext()`
`Class`	`getTypeClass()`
`Class`	`getTypeClassIfKnown()`
`QName`	`getTypeName()` Returns a name of the type for this definition.
`int`	`hashCode()`
`boolean`	`isAbstract()`
`boolean`	`isDeprecated()`
`boolean`	`isEmphasized()` True for definitions that are more important than others and that should be emphasized during presentation.
`boolean`	`isExperimental()`
`boolean`	`isIgnored()` Item definition that has this flag set should be ignored by any processing.
`boolean`	`isRuntimeSchema()` This means that the entities described by this schema (items, complex types) or their content is not defined by fixed (compile-time) schema.
`abstract void`	`revive(PrismContext prismContext)`
`void`	`setAbstract(boolean isAbstract)`
`void`	`setDeprecated(boolean deprecated)`
`void`	`setDeprecatedSince(String deprecatedSince)`
`void`	`setDisplayName(String displayName)`
`void`	`setDisplayOrder(Integer displayOrder)`
`void`	`setDocumentation(String documentation)`
`void`	`setEmphasized(boolean emphasized)`
`void`	`setExperimental(boolean experimental)`
`void`	`setHelp(String help)`
`void`	`setIgnored(boolean ignored)`
`void`	`setInherited(boolean inherited)`
`void`	`setRuntimeSchema(boolean isRuntimeSchema)`
`void`	`setTypeName(QName typeName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.prism.Definition
debugDump, getSchemaRegistry

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

- Field Detail
  - typeName
```
@NotNull
protected QName typeName
```
  - ignored
```
protected boolean ignored
```
  - 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
```
  - experimental
```
protected boolean experimental
```
  - inherited
```
protected boolean inherited
```
    whether an item is inherited from a supertype (experimental feature)
  - isRuntimeSchema
```
protected boolean isRuntimeSchema
```
    This means that the item container is not defined by fixed (compile-time) schema. This in fact means that we need to use getAny in a JAXB types. It does not influence the processing of DOM that much, as that does not really depend on compile-time/run-time distinction.
  - 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.
  - prismContext
```
protected transient PrismContext prismContext
```
- Method Detail
  - getTypeName
```
@NotNull
public 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
                        QName typeName)
```
  - 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
  - setIgnored
```
public void setIgnored(boolean ignored)
```
  - isAbstract
```
public boolean isAbstract()
```
    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)
```
  - getDeprecatedSince
```
public String getDeprecatedSince()
```
    Specified by:
    
    getDeprecatedSince in interface Definition
  - setDeprecatedSince
```
public void setDeprecatedSince(String deprecatedSince)
```
  - isExperimental
```
public boolean isExperimental()
```
    Specified by:
    
    isExperimental in interface Definition
  - setExperimental
```
public void setExperimental(boolean experimental)
```
  - setInherited
```
public void setInherited(boolean inherited)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - getDocumentation
```
public String getDocumentation()
```
    Specified by:
    
    getDocumentation in interface Definition
  - setDocumentation
```
public void setDocumentation(String documentation)
```
  - 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 the entities described by this schema (items, complex types) or their content is not defined by fixed (compile-time) schema. I.e. it is known only at run time. Some examples for "false" value: - c:user, c:UserType - statically defined type with statically defined content. Some examples for "true" value: - c:extension, c:ExtensionType - although the entity itself (item, type) are defined in the static schema, their content is not known at compile time; - c:attributes, c:ShadowAttributeType - the same as extension/ExtensionType; - ext:weapon (of type xsd:string) - even if the content is statically defined, the definition of the item itself is not known at compile time; - ri:inetOrgPerson, ext:LocationsType, ext:locations - both the entity and their content are known at run time only. TODO clarify the third point; provide some tests for the 3rd and 4th point
    
    Specified by:
    
    isRuntimeSchema in interface Definition
  - setRuntimeSchema
```
public void setRuntimeSchema(boolean isRuntimeSchema)
```
  - getPrismContext
```
public PrismContext getPrismContext()
```
    Specified by:
    
    getPrismContext in interface Definition
  - getTypeClassIfKnown
```
public Class getTypeClassIfKnown()
```
    Specified by:
    
    getTypeClassIfKnown in interface Definition
  - getTypeClass
```
public Class getTypeClass()
```
    Specified by:
    
    getTypeClass in interface Definition
  - revive
```
public abstract void revive(PrismContext prismContext)
```
    Specified by:
    
    revive in interface Revivable
  - copyDefinitionData
```
protected void copyDefinitionData(DefinitionImpl clone)
```
  - 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()
```
    Description copied from interface: DebugDumpable
    
    Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.
    
    Specified by:
    
    debugDump in interface DebugDumpable
    
    Returns:
    
    content of the object intended for diagnostics by system administrator.
  - debugDump
```
public String debugDump(int indent)
```
    Specified by:
    
    debugDump in interface DebugDumpable
  - 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 Definition clone()
```
    Specified by:
    
    clone in interface Definition
    
    Overrides:
    
    clone in class Object

Class DefinitionImpl

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

typeName

ignored

isAbstract

displayName

displayOrder

help

documentation

deprecated

deprecatedSince

experimental

inherited

isRuntimeSchema

emphasized

prismContext

Method Detail

getTypeName

setTypeName

isIgnored

setIgnored

isAbstract

setAbstract

isDeprecated

setDeprecated

getDeprecatedSince

setDeprecatedSince

isExperimental

setExperimental

setInherited

isEmphasized

setEmphasized

getDisplayName

setDisplayName

getDisplayOrder

setDisplayOrder

getHelp

setHelp

getDocumentation

setDocumentation

getDocumentationPreview

isRuntimeSchema

setRuntimeSchema

getPrismContext

getTypeClassIfKnown

getTypeClass

revive

copyDefinitionData

hashCode

equals

toString

debugDump

debugDump

getDebugDumpClassName

getDocClassName

clone