Package com.evolveum.midpoint.model.impl.schema.transform

Class TransformableComplexTypeDefinition

java.lang.Object

com.evolveum.midpoint.model.impl.schema.transform.TransformableDefinition

com.evolveum.midpoint.model.impl.schema.transform.TransformableComplexTypeDefinition

All Implemented Interfaces:

AbstractTypeDefinition, ComplexTypeDefinition, ComplexTypeDefinition.ComplexTypeDefinitionMutator, Definition, Definition.DefinitionMutator, ComplexTypeDefinitionDelegator, DefinitionDelegator, TypeDefinitionDelegator, Freezable, LocalItemDefinitionStore, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, Revivable, SmartVisitable<Definition>, TypeDefinition, TypeDefinition.TypeDefinitionMutator, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

public class TransformableComplexTypeDefinition
extends TransformableDefinition
implements ComplexTypeDefinitionDelegator

See Also:

• Serialized Form

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

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

TypeDefinition.TypeDefinitionLikeBuilder, TypeDefinition.TypeDefinitionMutator

Field Summary

Fields

Modifier and Type	Field	Description
protected DelegatedItem<ComplexTypeDefinition>	delegate

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
TransformableComplexTypeDefinition(ComplexTypeDefinition delegate)

Method Summary

Modifier and Type	Method	Description
default void	add(ItemDefinition<?> definition)
default void	addSchemaMigration(SchemaMigration schemaMigration)
default void	addSubstitution(ItemDefinition<?> itemDef, ItemDefinition<?> maybeSubst)
@NotNull ComplexTypeDefinition	clone()	Does a shallow clone of this definition (i.e.
TransformableComplexTypeDefinition	copy()
default PrismPropertyDefinition.PrismPropertyDefinitionMutator<?>	createPropertyDefinition(String name, QName typeName)
default PrismPropertyDefinition.PrismPropertyDefinitionMutator<?>	createPropertyDefinition(QName name, QName typeName)
@NotNull ComplexTypeDefinition	deepClone(@NotNull DeepCloneOperation operation)	Does a deep clone of this definition.
ComplexTypeDefinition	delegate()
void	delete(QName itemName)
<ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path)	Returns ItemDefinition corresponding to given path (rooted at this store).
<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).
<ID extends ItemDefinition<?>> ID	findLocalItemDefinition(@NotNull QName name)	Returns the local ItemDefinition corresponding to given item name (in case-sensitive manner).
<ID extends ItemDefinition<?>> ID	findLocalItemDefinition(@NotNull QName name, @NotNull Class<ID> clazz, boolean caseInsensitive)	Returns the local item definition corresponding to given item name (optionally case-insensitive) and definition class.
<ID extends ItemDefinition> ID	findNamedItemDefinition(@NotNull QName firstName, @NotNull ItemPath rest, @NotNull Class<ID> clazz)
void	freeze()
static TransformableComplexTypeDefinition	from(ComplexTypeDefinition complexTypeDefinition)
@Nullable QName	getDefaultItemTypeName()	Type name for items that are not explicitly defined in this CTD.
@NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns definitions for all inner items.
boolean	isEmpty()	Returns true if there are no item definitions.
boolean	isImmutable()
boolean	isItemDefinitionRemoved(QName itemName)	This allows to distinguish between missing and explicitly removed definitions.
Optional<ItemDefinition<?>>	itemOrSubstitution(QName name)
ComplexTypeDefinition.ComplexTypeDefinitionMutator	mutator()	Returns an interface to mutate this definition.
void	replaceDefinition(@NotNull QName name, ItemDefinition definition)	Currently used only to replace Refined* with LayerRefined*
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
default void	setAbstract(boolean value)
default void	setCompileTimeClass(Class<?> compileTimeClass)
default void	setContainerMarker(boolean value)
void	setDefaultItemTypeName(QName value)
default void	setDefaultNamespace(String namespace)
default void	setDeprecated(boolean deprecated)
default void	setDeprecatedSince(String deprecatedSince)
default void	setDiagrams(List<ItemDiagramSpecification> value)
default void	setDisplayHint(DisplayHint displayHint)
default void	setDisplayName(String displayName)
default void	setDisplayOrder(Integer displayOrder)
default void	setDocumentation(String value)
default void	setEmphasized(boolean emphasized)
default void	setExperimental(boolean experimental)
default void	setExtensionForType(QName type)
default void	setHelp(String help)
default void	setIgnoredNamespaces(@NotNull List<String> ignoredNamespaces)
default void	setInstantiationOrder(Integer order)
default void	setListMarker(boolean value)
default void	setMergerIdentifier(String mergerIdentifier)
default void	setNaturalKeyConstituents(List<QName> naturalKeyConstituents)
default void	setObjectMarker(boolean value)
default void	setOptionalCleanup(boolean optionalCleanup)
default void	setPlannedRemoval(String plannedRemoval)
default void	setReferenceMarker(boolean value)
default void	setRemoved(boolean removed)
default void	setRemovedSince(String removedSince)
default void	setRuntimeSchema(boolean value)
default void	setSchemaMigrations(List<SchemaMigration> value)
default void	setSuperType(QName superType)
default void	setXsdAnyMarker(boolean value)
Optional<ItemDefinition<?>>	substitution(QName name)
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 class com.evolveum.midpoint.model.impl.schema.transform.TransformableDefinition

annotationsOverrides, getAnnotation, setAnnotation

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getPropertyDefinitions, getXmlAttributeDefinitions, hasSubstitutions, isStrictAnyMarker, migrateIfNeeded

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

setValueMigrator

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

findContainerDefinition, findReferenceDefinition, getDefaultNamespace, getDiagrams, getDisplayName, getDisplayOrder, getExtensionForType, getHelp, getIgnoredNamespaces, getSuperType, getTypeName, hasOperationalOnlyItems, hasSubstitutions, isContainerMarker, isEmphasized, isListMarker, isObjectMarker, isReferenceMarker, isXsdAnyMarker, merge

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

checkMutableOnExposing

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

setAnnotation

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, getSchemaMigrations, getTypeClass, isAbstract, isDeprecated, isElaborate, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema

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

checkImmutable, checkMutable

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

containsItemDefinition, findPropertyDefinition

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

isAssignableFrom

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes

Field Details

delegate

protected DelegatedItem<ComplexTypeDefinition> delegate

Constructor Details

TransformableComplexTypeDefinition

public TransformableComplexTypeDefinition(ComplexTypeDefinition delegate)

Method Details

delegate

public ComplexTypeDefinition delegate()

Specified by:

delegate in interface ComplexTypeDefinitionDelegator

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

from

public static TransformableComplexTypeDefinition from(ComplexTypeDefinition complexTypeDefinition)

findLocalItemDefinition

public <ID extends ItemDefinition<?>> ID findLocalItemDefinition(@NotNull
 @NotNull QName name)

Description copied from interface: LocalItemDefinitionStore

Returns the local ItemDefinition corresponding to given item name (in case-sensitive manner). Does not try to resolve items globally (in the case of "any" content). Note: some implementors provide optimized implementations of this method.

Specified by:

findLocalItemDefinition in interface LocalItemDefinitionStore

findLocalItemDefinition

public <ID extends ItemDefinition<?>> ID findLocalItemDefinition(@NotNull
 @NotNull QName name,
 @NotNull
 @NotNull Class<ID> clazz,
 boolean caseInsensitive)

Description copied from interface: LocalItemDefinitionStore

Returns the local item definition corresponding to given item name (optionally case-insensitive) and definition class. Does not try to resolve items globally (in the case of "any" content). BEWARE: In the case of ambiguities, returns any suitable definition. (This may change.)

Specified by:

findLocalItemDefinition in interface LocalItemDefinitionStore

findItemDefinition

public <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 ComplexTypeDefinitionDelegator

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

findItemDefinition

public <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 ComplexTypeDefinitionDelegator

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

findNamedItemDefinition

public <ID extends ItemDefinition> ID findNamedItemDefinition(@NotNull
 @NotNull QName firstName,
 @NotNull
 @NotNull ItemPath rest,
 @NotNull
 @NotNull Class<ID> clazz)

getDefinitions

@NotNull
public @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 ComplexTypeDefinitionDelegator

Specified by:

getDefinitions in interface LocalItemDefinitionStore

getDefaultItemTypeName

@Nullable
public @Nullable QName getDefaultItemTypeName()

Description copied from interface: ComplexTypeDefinition

Type name for items that are not explicitly defined in this CTD.

Specified by:

getDefaultItemTypeName in interface ComplexTypeDefinition

isEmpty

public boolean isEmpty()

Description copied from interface: ComplexTypeDefinition

Returns true if there are no item definitions.

Specified by:

isEmpty in interface ComplexTypeDefinition

Specified by:

isEmpty in interface ComplexTypeDefinitionDelegator

substitution

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

Specified by:

substitution in interface ComplexTypeDefinition

Specified by:

substitution in interface ComplexTypeDefinitionDelegator

itemOrSubstitution

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

Specified by:

itemOrSubstitution in interface ComplexTypeDefinition

Specified by:

itemOrSubstitution in interface ComplexTypeDefinitionDelegator

revive

public 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

clone

@NotNull
public @NotNull ComplexTypeDefinition clone()

Description copied from interface: ComplexTypeDefinition

Does a shallow clone of this definition (i.e. item definitions themselves are NOT cloned).

Specified by:

clone in interface ComplexTypeDefinition

Specified by:

clone in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

Specified by:

clone in interface Definition

Overrides:

clone in class TransformableDefinition

setDefaultItemTypeName

public void setDefaultItemTypeName(QName value)

isImmutable

public boolean isImmutable()

Specified by:

isImmutable in interface Freezable

freeze

public void freeze()

Specified by:

freeze in interface Freezable

deepClone

@NotNull
public @NotNull ComplexTypeDefinition deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ComplexTypeDefinition

Does a deep clone of this definition.

Specified by:

deepClone in interface ComplexTypeDefinition

mutator

public ComplexTypeDefinition.ComplexTypeDefinitionMutator mutator()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

mutator in interface ComplexTypeDefinition

Specified by:

mutator in interface Definition

isItemDefinitionRemoved

public boolean isItemDefinitionRemoved(QName itemName)

Description copied from interface: ComplexTypeDefinition

This allows to distinguish between missing and explicitly removed definitions.

Specified by:

isItemDefinitionRemoved in interface ComplexTypeDefinition

replaceDefinition

public void replaceDefinition(@NotNull
 @NotNull QName name,
 ItemDefinition definition)

Currently used only to replace Refined* with LayerRefined*

Specified by:

replaceDefinition in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

delete

public void delete(QName itemName)

Specified by:

delete in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

copy

public TransformableComplexTypeDefinition copy()

trimTo

public 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

Specified by:

trimTo in interface ComplexTypeDefinitionDelegator

setOptionalCleanup

default void setOptionalCleanup(boolean optionalCleanup)

Specified by:

setOptionalCleanup in interface Definition.DefinitionMutator

setInstantiationOrder

default void setInstantiationOrder(Integer order)

setDeprecated

default void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface PrismLifecycleDefinition.Mutable

setRemoved

default void setRemoved(boolean removed)

Specified by:

setRemoved in interface PrismLifecycleDefinition.Mutable

setRemovedSince

default void setRemovedSince(String removedSince)

Specified by:

setRemovedSince in interface PrismLifecycleDefinition.Mutable

setPlannedRemoval

default void setPlannedRemoval(String plannedRemoval)

Specified by:

setPlannedRemoval in interface PrismLifecycleDefinition.Mutable

setDeprecatedSince

default void setDeprecatedSince(String deprecatedSince)

Specified by:

setDeprecatedSince in interface PrismLifecycleDefinition.Mutable

setExperimental

default void setExperimental(boolean experimental)

Specified by:

setExperimental in interface PrismLifecycleDefinition.Mutable

setDisplayHint

default void setDisplayHint(DisplayHint displayHint)

Specified by:

setDisplayHint in interface PrismPresentationDefinition.Mutable

setMergerIdentifier

default void setMergerIdentifier(String mergerIdentifier)

Specified by:

setMergerIdentifier in interface Definition.DefinitionMutator

setNaturalKeyConstituents

default void setNaturalKeyConstituents(List<QName> naturalKeyConstituents)

Specified by:

setNaturalKeyConstituents in interface Definition.DefinitionMutator

setEmphasized

default void setEmphasized(boolean emphasized)

Specified by:

setEmphasized in interface PrismPresentationDefinition.Mutable

setDisplayName

default void setDisplayName(String displayName)

Specified by:

setDisplayName in interface PrismPresentationDefinition.Mutable

setDisplayOrder

default void setDisplayOrder(Integer displayOrder)

Specified by:

setDisplayOrder in interface PrismPresentationDefinition.Mutable

setHelp

default void setHelp(String help)

Specified by:

setHelp in interface PrismPresentationDefinition.Mutable

setRuntimeSchema

default void setRuntimeSchema(boolean value)

Specified by:

setRuntimeSchema in interface Definition.DefinitionMutator

setDocumentation

default void setDocumentation(String value)

Specified by:

setDocumentation in interface PrismPresentationDefinition.Mutable

addSchemaMigration

default void addSchemaMigration(SchemaMigration schemaMigration)

Specified by:

addSchemaMigration in interface PrismLifecycleDefinition.Mutable

setSchemaMigrations

default void setSchemaMigrations(List<SchemaMigration> value)

Specified by:

setSchemaMigrations in interface PrismLifecycleDefinition.Mutable

add

default void add(ItemDefinition<?> definition)

Specified by:

add in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

createPropertyDefinition

default PrismPropertyDefinition.PrismPropertyDefinitionMutator<?> createPropertyDefinition(QName name,
 QName typeName)

Specified by:

createPropertyDefinition in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

createPropertyDefinition

default PrismPropertyDefinition.PrismPropertyDefinitionMutator<?> createPropertyDefinition(String name,
 QName typeName)

Specified by:

createPropertyDefinition in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

setExtensionForType

default void setExtensionForType(QName type)

setAbstract

default void setAbstract(boolean value)

setSuperType

default void setSuperType(QName superType)

setObjectMarker

default void setObjectMarker(boolean value)

setContainerMarker

default void setContainerMarker(boolean value)

setReferenceMarker

default void setReferenceMarker(boolean value)

setDefaultNamespace

default void setDefaultNamespace(String namespace)

setIgnoredNamespaces

default void setIgnoredNamespaces(@NotNull
 @NotNull List<String> ignoredNamespaces)

setXsdAnyMarker

default void setXsdAnyMarker(boolean value)

setListMarker

default void setListMarker(boolean value)

setCompileTimeClass

default void setCompileTimeClass(Class<?> compileTimeClass)

addSubstitution

default void addSubstitution(ItemDefinition<?> itemDef,
 ItemDefinition<?> maybeSubst)

Specified by:

addSubstitution in interface ComplexTypeDefinition.ComplexTypeDefinitionMutator

setDiagrams

default void setDiagrams(List<ItemDiagramSpecification> value)

Specified by:

setDiagrams in interface PrismPresentationDefinition.Mutable