Package com.evolveum.midpoint.prism.deleg

Interface ComplexTypeDefinitionDelegator

All Superinterfaces:

AbstractTypeDefinition, Cloneable, ComplexTypeDefinition, DebugDumpable, Definition, DefinitionDelegator, Freezable, LocalItemDefinitionStore, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, TypeDefinition, TypeDefinitionDelegator, Visitable<Definition>

public interface ComplexTypeDefinitionDelegator
extends TypeDefinitionDelegator, ComplexTypeDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ComplexTypeDefinition

ComplexTypeDefinition.ComplexTypeDefinitionLikeBuilder, ComplexTypeDefinition.ComplexTypeDefinitionMutator, ComplexTypeDefinition.ValueMigrator

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.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.TypeDefinition

TypeDefinition.TypeDefinitionLikeBuilder, TypeDefinition.TypeDefinitionMutator

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
ComplexTypeDefinition	delegate()
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull ItemPath path)	Returns PrismContainerDefinition corresponding to given path (rooted at this store).
default <ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path)	Returns ItemDefinition corresponding to given path (rooted at this store).
default <ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path, @NotNull Class<ID> clazz)	Returns a definition of given type corresponding to given path (rooted at this store).
default PrismReferenceDefinition	findReferenceDefinition(@NotNull ItemPath path)	Returns PrismReferenceDefinition corresponding to given path (rooted at this store).
default @Nullable String	getDefaultNamespace()	When resolving unqualified names for items contained in this CTD, what should be the default namespace to look into at first.
default @NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns definitions for all inner items.
default List<ItemDiagramSpecification>	getDiagrams()
default String	getDisplayName()	Returns display name.
default Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
default @Nullable QName	getExtensionForType()	If not null, indicates that this type defines the structure of `extension` element of a given type.
default String	getHelp()	Returns help string.
default @NotNull List<String>	getIgnoredNamespaces()	When resolving unqualified names for items contained in this CTD, what namespace(s) should be ignored.
default @Nullable QName	getSuperType()	Name of super type of this complex type definition.
default @NotNull QName	getTypeName()	Returns a name of the type for this definition.
default boolean	hasOperationalOnlyItems()
default boolean	hasSubstitutions()
default boolean	isContainerMarker()	Flag indicating whether this type was marked as "container" in the original schema.
default boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
default boolean	isEmpty()	Returns true if there are no item definitions.
default boolean	isListMarker()	True if the complex type definition is a type dedicated to hold so-called https://docs.evolveum.com/midpoint/devel/design/xml-json-yaml-vs-xnode-vs-internal-data/heterogeneous-lists/[heterogeneous lists].
default boolean	isObjectMarker()	Flag indicating whether this type was marked as "object" in the original schema.
default boolean	isReferenceMarker()	Flag indicating whether this type was marked as "objectReference" in the original schema.
default boolean	isXsdAnyMarker()	True if the complex type definition contains xsd:any (directly or indirectly).
default Optional<ItemDefinition<?>>	itemOrSubstitution(QName name)
default void	merge(ComplexTypeDefinition otherComplexTypeDef)	Copies cloned definitions from the other type definition into this one.
default Optional<ItemDefinition<?>>	substitution(QName name)
default void	trimTo(@NotNull Collection<ItemPath> paths)	Trims the definition (and any definitions it refers to) to contain only items related to given paths.

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

clone, deepClone, getDefaultItemTypeName, getDefaultReferenceTargetTypeName, getPropertyDefinitions, getXmlAttributeDefinitions, hasSubstitutions, isItemDefinitionRemoved, isStrictAnyMarker, migrateIfNeeded, mutator

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

checkMutableOnExposing

Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayHint, getDocumentation, getDocumentationPreview, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getPlannedRemoval, getRemovedSince, getSchemaContextDefinition, getSchemaMigrations, getTypeClass, isAbstract, isDeprecated, isElaborate, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema

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

checkImmutable, checkMutable, freeze, isImmutable

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

containsItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findLocalItemDefinitionByIteration, findPropertyDefinition

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

revive

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware

schemaLookup

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

isAssignableFrom

Methods inherited from interface com.evolveum.midpoint.prism.deleg.TypeDefinitionDelegator

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes

Method Details

delegate

ComplexTypeDefinition delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

getTypeName

@NotNull
default @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 AbstractTypeDefinition

Specified by:

getTypeName in interface Definition

Specified by:

getTypeName in interface DefinitionDelegator

Specified by:

getTypeName in interface TypeDefinitionDelegator

Returns:

the type name

getSuperType

@Nullable
default @Nullable QName getSuperType()

Description copied from interface: TypeDefinition

Name of super type of this complex type definition. For example, `c:ObjectType` is a super type for `c:FocusType` which is a super type for `c:UserType`. Extension types have `c:ExtensionType` as their supertype, if no explicit supertype is specified in XSD.

Specified by:

getSuperType in interface TypeDefinition

Specified by:

getSuperType in interface TypeDefinitionDelegator

getHelp

default String 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 interface DefinitionDelegator

Specified by:

getHelp in interface PrismPresentationDefinition

Specified by:

getHelp in interface TypeDefinitionDelegator

Returns:

help string or catalog key

getDisplayName

default String 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 interface DefinitionDelegator

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

getDisplayOrder

default Integer 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 interface DefinitionDelegator

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

isEmphasized

default 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 interface DefinitionDelegator

Specified by:

isEmphasized in interface PrismPresentationDefinition

getExtensionForType

@Nullable
default @Nullable QName getExtensionForType()

Description copied from interface: ComplexTypeDefinition

If not null, indicates that this type defines the structure of `extension` element of a given type. E.g. `getExtensionForType()` == `c:UserType` means that this complex type defines structure of `extension` elements of `UserType` objects.

Specified by:

getExtensionForType in interface ComplexTypeDefinition

isReferenceMarker

default boolean isReferenceMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "objectReference" in the original schema.

Specified by:

isReferenceMarker in interface ComplexTypeDefinition

isContainerMarker

default boolean isContainerMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "container" in the original schema. Does not provide any information to schema processing logic, just conveys the marker from original schema so we can serialize and deserialize the schema without loss of information.

Specified by:

isContainerMarker in interface ComplexTypeDefinition

findItemDefinition

default <ID extends ItemDefinition<?>> ID findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<ID> clazz)

Description copied from interface: LocalItemDefinitionStore

Returns a definition of given type corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

findItemDefinition

default <ID extends ItemDefinition<?>> ID findItemDefinition(@NotNull
 @NotNull ItemPath path)

Description copied from interface: LocalItemDefinitionStore

Returns ItemDefinition corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

isObjectMarker

default boolean isObjectMarker()

Description copied from interface: ComplexTypeDefinition

Flag indicating whether this type was marked as "object" in the original schema. Does not provide any information to schema processing logic, just conveys the marker from original schema so we can serialized and deserialize the schema without loss of information.

Specified by:

isObjectMarker in interface ComplexTypeDefinition

findReferenceDefinition

default PrismReferenceDefinition findReferenceDefinition(@NotNull
 @NotNull ItemPath path)

Description copied from interface: LocalItemDefinitionStore

Returns PrismReferenceDefinition corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findReferenceDefinition in interface LocalItemDefinitionStore

isXsdAnyMarker

default boolean isXsdAnyMarker()

Description copied from interface: ComplexTypeDefinition

True if the complex type definition contains xsd:any (directly or indirectly).

Specified by:

isXsdAnyMarker in interface ComplexTypeDefinition

findContainerDefinition

default <C extends Containerable>
PrismContainerDefinition<C> findContainerDefinition(@NotNull
 @NotNull ItemPath path)

Description copied from interface: LocalItemDefinitionStore

Returns PrismContainerDefinition corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findContainerDefinition in interface LocalItemDefinitionStore

isListMarker

default boolean isListMarker()

Description copied from interface: ComplexTypeDefinition

True if the complex type definition is a type dedicated to hold so-called https://docs.evolveum.com/midpoint/devel/design/xml-json-yaml-vs-xnode-vs-internal-data/heterogeneous-lists/[heterogeneous lists]. See also DOMUtil.IS_LIST_ATTRIBUTE_NAME and ItemDefinition.isHeterogeneousListItem().

Specified by:

isListMarker in interface ComplexTypeDefinition

getDefaultNamespace

@Nullable
default @Nullable String getDefaultNamespace()

Description copied from interface: ComplexTypeDefinition

When resolving unqualified names for items contained in this CTD, what should be the default namespace to look into at first. Currently does NOT apply recursively (to inner CTDs). Set by parsing `defaultNamespace` XSD annotation.

Specified by:

getDefaultNamespace in interface ComplexTypeDefinition

getIgnoredNamespaces

@NotNull
default @NotNull List<String> getIgnoredNamespaces()

Description copied from interface: ComplexTypeDefinition

When resolving unqualified names for items contained in this CTD, what namespace(s) should be ignored. Names in this list are interpreted as a namespace prefixes. Currently does NOT apply recursively (to inner CTDs). Set by parsing `ignoredNamespace` XSD annotations.

Specified by:

getIgnoredNamespaces in interface ComplexTypeDefinition

merge

default void merge(ComplexTypeDefinition otherComplexTypeDef)

Description copied from interface: ComplexTypeDefinition

Copies cloned definitions from the other type definition into this one. (TODO remove from the interface?)

Specified by:

merge in interface ComplexTypeDefinition

isEmpty

default boolean isEmpty()

Description copied from interface: ComplexTypeDefinition

Returns true if there are no item definitions.

Specified by:

isEmpty in interface ComplexTypeDefinition

trimTo

default void trimTo(@NotNull
 @NotNull Collection<ItemPath> paths)

Description copied from interface: ComplexTypeDefinition

Trims the definition (and any definitions it refers to) to contain only items related to given paths. USE WITH CARE. Be sure no shared definitions would be affected by this operation!

Specified by:

trimTo in interface ComplexTypeDefinition

hasSubstitutions

default boolean hasSubstitutions()

Specified by:

hasSubstitutions in interface ComplexTypeDefinition

substitution

default Optional<ItemDefinition<?>> substitution(QName name)

Specified by:

substitution in interface ComplexTypeDefinition

itemOrSubstitution

default Optional<ItemDefinition<?>> itemOrSubstitution(QName name)

Specified by:

itemOrSubstitution in interface ComplexTypeDefinition

getDefinitions

@NotNull
default @NotNull List<? extends ItemDefinition<?>> getDefinitions()

Description copied from interface: ComplexTypeDefinition

Returns definitions for all inner items. These are of type ItemDefinition. However, very often subtypes of this type are used, e.g. ResourceAttributeDefinition, RefinedAttributeDefinition, LayerRefinedAttributeDefinition, and so on. The returned structure is a List because the ordering is significant, e.g. for serialization purposes. The list is unmodifiable.

Specified by:

getDefinitions in interface ComplexTypeDefinition

Specified by:

getDefinitions in interface LocalItemDefinitionStore

getDiagrams

default List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface PrismPresentationDefinition

hasOperationalOnlyItems

default boolean hasOperationalOnlyItems()

Specified by:

hasOperationalOnlyItems in interface ComplexTypeDefinition