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:

ComplexTypeDefinition, Definition, ComplexTypeDefinitionDelegator, DefinitionDelegator, TypeDefinitionDelegator, Freezable, LocalItemDefinitionStore, MutableComplexTypeDefinition, MutableDefinition, MutableTypeDefinition, PrismContextSensitive, Revivable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>, DebugDumpable, Serializable, Cloneable

Direct Known Subclasses:

TransformableComplexTypeDefinition.TrResourceObjectDefinition

public class TransformableComplexTypeDefinition
extends TransformableDefinition
implements ComplexTypeDefinitionDelegator

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransformableComplexTypeDefinition.TrCompositeObjectDefinition
static class	TransformableComplexTypeDefinition.TrResourceObjectClassDefinition
static class	TransformableComplexTypeDefinition.TrResourceObjectDefinition
static class	TransformableComplexTypeDefinition.TrResourceObjectTypeDefinition

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	addDiagram(ItemDiagramSpecification diagram)
default void	addSchemaMigration(SchemaMigration schemaMigration)
default void	addSubstitution(ItemDefinition<?> itemDef, ItemDefinition<?> maybeSubst)
@NotNull ComplexTypeDefinition	clone()	Does a shallow clone of this definition (i.e. item definitions themselves are NOT cloned).
TransformableComplexTypeDefinition	copy()
default MutablePrismPropertyDefinition<?>	createPropertyDefinition(String name, QName typeName)
default MutablePrismPropertyDefinition<?>	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)
@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)
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?
default void	setAbstract(boolean value)
default void	setCompileTimeClass(Class<?> compileTimeClass)
default void	setContainerMarker(boolean value)
default void	setDefaultNamespace(String namespace)
default void	setDeprecated(boolean deprecated)
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	setObjectMarker(boolean value)
default void	setProcessing(ItemProcessing processing)
default void	setReferenceMarker(boolean value)
default void	setRemoved(boolean removed)
default void	setRemovedSince(String removedSince)
default void	setRuntimeSchema(boolean value)
default void	setSuperType(QName superType)
default void	setTypeName(QName typeName)
default void	setXsdAnyMarker(boolean value)
Optional<ItemDefinition<?>>	substitution(QName name)
MutableComplexTypeDefinition	toMutable()	Returns an interface to mutate this definition.
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

getXmlAttributeDefinitions, hasSubstitutions, isStrictAnyMarker

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

findContainerDefinition, findReferenceDefinition, getDefaultNamespace, getDiagrams, getExtensionForType, getIgnoredNamespaces, hasOperationalOnlyItems, hasSubstitutions, isContainerMarker, isListMarker, isObjectMarker, isReferenceMarker, isXsdAnyMarker, merge

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

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getRemovedSince, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRemoved, isRuntimeSchema, setAnnotation

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

setAttributeDefinitions, setStrictAnyMarker

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

isAssignableFrom

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType

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

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 Definition

Specified by:

clone in interface MutableComplexTypeDefinition

Overrides:

clone in class TransformableDefinition

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

toMutable

public MutableComplexTypeDefinition toMutable()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

toMutable in interface ComplexTypeDefinition

Specified by:

toMutable 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 MutableComplexTypeDefinition

delete

public void delete(QName itemName)

Specified by:

delete in interface MutableComplexTypeDefinition

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

setInstantiationOrder

default void setInstantiationOrder(Integer order)

Specified by:

setInstantiationOrder in interface MutableTypeDefinition

setProcessing

default void setProcessing(ItemProcessing processing)

Specified by:

setProcessing in interface MutableDefinition

setDeprecated

default void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface MutableDefinition

setRemoved

default void setRemoved(boolean removed)

Specified by:

setRemoved in interface MutableDefinition

setRemovedSince

default void setRemovedSince(String removedSince)

Specified by:

setRemovedSince in interface MutableDefinition

setExperimental

default void setExperimental(boolean experimental)

Specified by:

setExperimental in interface MutableDefinition

setEmphasized

default void setEmphasized(boolean emphasized)

Specified by:

setEmphasized in interface MutableDefinition

setDisplayName

default void setDisplayName(String displayName)

Specified by:

setDisplayName in interface MutableDefinition

setDisplayOrder

default void setDisplayOrder(Integer displayOrder)

Specified by:

setDisplayOrder in interface MutableDefinition

setHelp

default void setHelp(String help)

Specified by:

setHelp in interface MutableDefinition

setRuntimeSchema

default void setRuntimeSchema(boolean value)

Specified by:

setRuntimeSchema in interface MutableDefinition

setTypeName

default void setTypeName(QName typeName)

Specified by:

setTypeName in interface MutableDefinition

setDocumentation

default void setDocumentation(String value)

Specified by:

setDocumentation in interface MutableDefinition

addSchemaMigration

default void addSchemaMigration(SchemaMigration schemaMigration)

Specified by:

addSchemaMigration in interface MutableDefinition

add

default void add(ItemDefinition<?> definition)

Specified by:

add in interface MutableComplexTypeDefinition

createPropertyDefinition

default MutablePrismPropertyDefinition<?> createPropertyDefinition(QName name,
 QName typeName)

Specified by:

createPropertyDefinition in interface MutableComplexTypeDefinition

createPropertyDefinition

default MutablePrismPropertyDefinition<?> createPropertyDefinition(String name,
 QName typeName)

Specified by:

createPropertyDefinition in interface MutableComplexTypeDefinition

setExtensionForType

default void setExtensionForType(QName type)

Specified by:

setExtensionForType in interface MutableComplexTypeDefinition

setAbstract

default void setAbstract(boolean value)

Specified by:

setAbstract in interface MutableComplexTypeDefinition

setSuperType

default void setSuperType(QName superType)

Specified by:

setSuperType in interface MutableComplexTypeDefinition

setObjectMarker

default void setObjectMarker(boolean value)

Specified by:

setObjectMarker in interface MutableComplexTypeDefinition

setContainerMarker

default void setContainerMarker(boolean value)

Specified by:

setContainerMarker in interface MutableComplexTypeDefinition

setReferenceMarker

default void setReferenceMarker(boolean value)

Specified by:

setReferenceMarker in interface MutableComplexTypeDefinition

setDefaultNamespace

default void setDefaultNamespace(String namespace)

Specified by:

setDefaultNamespace in interface MutableComplexTypeDefinition

setIgnoredNamespaces

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

Specified by:

setIgnoredNamespaces in interface MutableComplexTypeDefinition

setXsdAnyMarker

default void setXsdAnyMarker(boolean value)

Specified by:

setXsdAnyMarker in interface MutableComplexTypeDefinition

setListMarker

default void setListMarker(boolean value)

Specified by:

setListMarker in interface MutableComplexTypeDefinition

setCompileTimeClass

default void setCompileTimeClass(Class<?> compileTimeClass)

Specified by:

setCompileTimeClass in interface MutableComplexTypeDefinition

addSubstitution

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

Specified by:

addSubstitution in interface MutableComplexTypeDefinition

addDiagram

default void addDiagram(ItemDiagramSpecification diagram)

Specified by:

addDiagram in interface MutableDefinition