Package com.evolveum.midpoint.prism.deleg

Interface ComplexTypeDefinitionDelegator

All Superinterfaces:

Cloneable, ComplexTypeDefinition, DebugDumpable, Definition, DefinitionDelegator, Freezable, LocalDefinitionStore, PrismContextSensitive, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, TypeDefinitionDelegator, Visitable<Definition>

All Known Subinterfaces:

ObjectClassTypeDefinitionDelegator

public interface ComplexTypeDefinitionDelegator
extends TypeDefinitionDelegator, ComplexTypeDefinition

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default boolean	containsItemDefinition(QName itemName)
ComplexTypeDefinition	delegate()
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull ItemPath path)
default <C extends Containerable> PrismContainerDefinition<C>	findContainerDefinition(@NotNull String name)
default <ID extends ItemDefinition> ID	findItemDefinition(@NotNull ItemPath path)
default <ID extends ItemDefinition> ID	findItemDefinition(@NotNull ItemPath path, @NotNull Class<ID> clazz)
default <ID extends ItemDefinition> ID	findLocalItemDefinition(@NotNull QName name)
default <ID extends ItemDefinition> ID	findLocalItemDefinition(@NotNull QName name, @NotNull Class<ID> clazz, boolean caseInsensitive)
default <ID extends ItemDefinition> ID	findNamedItemDefinition(@NotNull QName firstName, @NotNull ItemPath rest, @NotNull Class<ID> clazz)
default <T> PrismPropertyDefinition<T>	findPropertyDefinition(@NotNull ItemPath path)
default PrismReferenceDefinition	findReferenceDefinition(@NotNull ItemName name)
default PrismReferenceDefinition	findReferenceDefinition(@NotNull ItemPath path)
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 @Nullable QName	getExtensionForType()	If not null, indicates that this type defines the structure of 'extension' element of a given type.
default @NotNull List<String>	getIgnoredNamespaces()	When resolving unqualified names for items contained in this CTD, what namespace(s) should be ignored.
default boolean	hasSubstitutions()
default boolean	isContainerMarker()	Flag indicating whether this type was marked as "container" in the original schema.
default boolean	isEmpty()	Returns true if there are no item definitions.
default boolean	isListMarker()
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	isShared()	Is this definition shared, i.e.
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, isItemDefinitionRemoved, revive, toMutable

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

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

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

checkImmutable, checkMutable, freeze, isImmutable

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

Method Detail

delegate

ComplexTypeDefinition delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

findLocalItemDefinition

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

Specified by:

findLocalItemDefinition in interface LocalDefinitionStore

findLocalItemDefinition

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

Specified by:

findLocalItemDefinition in interface LocalDefinitionStore

isShared

default boolean isShared()

Description copied from interface: ComplexTypeDefinition

Is this definition shared, i.e. used by more than one prism object? If so, it should not be e.g. trimmed. EXPERIMENTAL

Specified by:

isShared in interface ComplexTypeDefinition

findItemDefinition

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

Specified by:

findItemDefinition in interface LocalDefinitionStore

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

findReferenceDefinition

default PrismReferenceDefinition findReferenceDefinition(@NotNull
                                                         @NotNull ItemName name)

Specified by:

findReferenceDefinition in interface LocalDefinitionStore

findContainerDefinition

default <C extends Containerable> PrismContainerDefinition<C> findContainerDefinition(@NotNull
                                                                                      @NotNull String name)

Specified by:

findContainerDefinition in interface LocalDefinitionStore

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)

Specified by:

findItemDefinition in interface LocalDefinitionStore

findNamedItemDefinition

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

Specified by:

findNamedItemDefinition in interface LocalDefinitionStore

findPropertyDefinition

default <T> PrismPropertyDefinition<T> findPropertyDefinition(@NotNull
                                                              @NotNull ItemPath path)

Specified by:

findPropertyDefinition in interface LocalDefinitionStore

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)

Specified by:

findReferenceDefinition in interface LocalDefinitionStore

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)

Specified by:

findContainerDefinition in interface LocalDefinitionStore

isListMarker

default boolean isListMarker()

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

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

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

containsItemDefinition

default boolean containsItemDefinition(QName itemName)

Specified by:

containsItemDefinition 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. Although returned as a list, the order of definitions is insignificant. (TODO change to set?) The list is unmodifiable.

Specified by:

getDefinitions in interface ComplexTypeDefinition

getDiagrams

default List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface Definition