Class TransformableContainerDefinition<C extends Containerable>
java.lang.Object
com.evolveum.midpoint.model.impl.schema.transform.TransformableDefinition
com.evolveum.midpoint.model.impl.schema.transform.TransformableItemDefinition<PrismContainer<C>,PrismContainerDefinition<C>>
com.evolveum.midpoint.model.impl.schema.transform.TransformableContainerDefinition<C>
- All Implemented Interfaces:
PartiallyMutableItemDefinition<PrismContainer<C>>,PartiallyMutableItemDefinition.Container<C>,Definition,Definition.DefinitionMutator,ContainerDefinitionDelegator<C>,DefinitionDelegator,ItemDefinitionDelegator<PrismContainer<C>>,Freezable,ItemDefinition<PrismContainer<C>>,ItemDefinition.ItemDefinitionMutator,LivePrismItemDefinition,LocalItemDefinitionStore,PrismContainerDefinition<C>,PrismContainerDefinition.PrismContainerDefinitionMutator<C>,PrismItemAccessDefinition,PrismItemAccessDefinition.Mutable,PrismItemBasicDefinition,PrismItemBasicDefinition.Mutable,PrismItemStorageDefinition,PrismItemStorageDefinition.Mutable,PrismLifecycleDefinition,PrismLifecycleDefinition.Mutable,PrismPresentationDefinition,PrismPresentationDefinition.Mutable,Revivable,SchemaLookup.Aware,SmartVisitable<Definition>,Visitable<Definition>,DebugDumpable,Serializable,Cloneable
- Direct Known Subclasses:
TransformableObjectDefinition
public class TransformableContainerDefinition<C extends Containerable>
extends TransformableItemDefinition<PrismContainer<C>,PrismContainerDefinition<C>>
implements ContainerDefinitionDelegator<C>, PartiallyMutableItemDefinition.Container<C>
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition
Definition.DefinitionBuilder, Definition.DefinitionMutatorNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition
ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutatorNested classes/interfaces inherited from interface com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableItemDefinition
PartiallyMutableItemDefinition.Attribute<T>, PartiallyMutableItemDefinition.Container<C extends Containerable>, PartiallyMutableItemDefinition.Property<T>, PartiallyMutableItemDefinition.ReferenceNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition
PrismContainerDefinition.PrismContainerDefinitionMutator<C extends Containerable>Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable
PrismItemAccessDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition
PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable
PrismItemBasicDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition
PrismItemStorageDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition
PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable
PrismLifecycleDefinition.Mutable.DelegableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition
PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.MutableNested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable
PrismPresentationDefinition.Mutable.Delegable -
Field Summary
FieldsFields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTransformableContainerDefinition(PrismContainerDefinition<C> delegate, ComplexTypeDefinition typeDef) -
Method Summary
Modifier and TypeMethodDescription@NotNull PrismContainerDefinition<C>clone()cloneWithNewDefinition(QName newItemName, ItemDefinition<?> newDefinition) TODO@NotNull ItemDefinition<PrismContainer<C>>cloneWithNewName(@NotNull ItemName itemName) Returns a clone of this definition, but with name changed to the provided one.@NotNull PrismContainerDefinition<?>cloneWithNewType(@NotNull QName newTypeName, @NotNull ComplexTypeDefinition newCtd) Changes the type name and definition for this PCD.protected TransformableContainerDefinition<C>copy()protected TransformableContainerDefinition<C>@NotNull ContainerDelta<C>createEmptyDelta(ItemPath path) Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.deepClone(@NotNull DeepCloneOperation operation) TODO documentstatic voidensureMutableType(PrismContainerValue<?> pcv) <C2 extends Containerable>
PrismContainerDefinition<C2>findContainerDefinition(@NotNull ItemPath path) ReturnsPrismContainerDefinitioncorresponding to given path (rooted at this store).<T extends ItemDefinition<?>>
TfindItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz) Used to find a matching item definition _within_ this definition.<ID extends ItemDefinition<?>>
IDfindLocalItemDefinition(@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.voidfreeze()Should be no-op (or very quick) if the object is already immutable.Static (compile-time) class holding the container values.Definition of the container values.@NotNull List<? extends ItemDefinition<?>>Returns a list of item definitions in this container.Returns set of property definitions.@Nullable SchemaContextDefinitionReturns a compile-time class that is used to represent items.@NotNull QNameReturns a name of the type for this definition.@NotNull PrismContainer<C>Create an item instance.@NotNull PrismContainer<C>instantiate(QName elementName) Create an item instance.booleanisEmpty()TODObooleanmutator()Returns an interface to mutate this definition.static <C extends Containerable>
TransformableContainerDefinition<C>of(PrismContainerDefinition<C> originalItem) protected PrismContainerDefinition<C>voidreplaceDefinition(QName itemName, ItemDefinition<?> newDefinition) TODOstatic <C extends Containerable>
TransformableContainerDefinition<C>require(PrismContainerDefinition<C> assocContainer) voidsetSchemaContextDefinition(SchemaContextDefinition schemaContextDefinition) Methods inherited from class com.evolveum.midpoint.model.impl.schema.transform.TransformableItemDefinition
access, applyTemplate, canAdd, canModify, canRead, delegate, delegatedItem, from, getDisplayHint, getDisplayName, getDisplayOrder, getHelp, getMaxOccurs, getMergerIdentifier, getMergerInstance, getMinOccurs, getNaturalKeyConstituents, getNaturalKeyInstance, getProcessing, getValueEnumerationRef, isAlwaysUseForEquals, isDeprecated, isEmphasized, isExperimental, publicFrom, revive, setAlwaysUseForEquals, setCanAdd, setCanModify, setCanRead, setDeprecated, setDisplayHint, setDisplayName, setDisplayOrder, setEmphasized, setExperimental, setHelp, setMaxOccurs, setMergerIdentifier, setMinOccurs, setNaturalKeyConstituents, setProcessing, setValueEnumerationRef, toStringMethods inherited from class com.evolveum.midpoint.model.impl.schema.transform.TransformableDefinition
annotationsOverrides, getAnnotation, setAnnotationMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.evolveum.midpoint.prism.deleg.ContainerDefinitionDelegator
canRepresent, createValue, delegate, getDisplayName, getDisplayOrder, getItemNames, isEmphasized, structuredTypeMethods inherited from interface com.evolveum.midpoint.prism.Definition
checkMutableOnExposingMethods inherited from interface com.evolveum.midpoint.prism.Definition.DefinitionMutator
setAnnotation, setMergerIdentifier, setNaturalKeyConstituentsMethods 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, isAbstract, isDeprecated, isElaborate, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchemaMethods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutableMethods inherited from interface com.evolveum.midpoint.prism.ItemDefinition
getProcessing, isAlwaysUseForEquals, isIgnoredMethods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionMutator
setAlwaysUseForEquals, setIgnoredMethods inherited from interface com.evolveum.midpoint.prism.deleg.ItemDefinitionDelegator
canAdd, canModify, canRead, debugDumpShortToString, getDiagrams, getHelp, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexed, isIndexOnly, isInherited, isOperational, isSearchable, isValidForMethods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore
containsItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinitionByIteration, findPropertyDefinition, findReferenceDefinitionMethods inherited from interface com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableItemDefinition
addSchemaMigration, setCanAdd, setCanModify, setCanRead, setDeprecated, setDeprecatedSince, setDiagrams, setDisplayName, setDisplayOrder, setDocumentation, setDynamic, setElaborate, setEmphasized, setExperimental, setHelp, setHeterogeneousListItem, setIndexed, setIndexOnly, setInherited, setMaxOccurs, setMinOccurs, setOperational, setOptionalCleanup, setPlannedRemoval, setProcessing, setReadOnly, setRemoved, setRemovedSince, setRuntimeSchema, setSchemaMigrations, setSearchable, setSubstitutionHead, setValueEnumerationRefMethods inherited from interface com.evolveum.midpoint.model.impl.schema.transform.PartiallyMutableItemDefinition.Container
createContainerDefinition, createContainerDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, setCompileTimeClass, setComplexTypeDefinitionMethods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition
getAlwaysUseForEquals, isAlwaysUseForEquals, isCompletelyDefined, schemaLookupMethods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition.PrismContainerDefinitionMutator
setAlwaysUseForEqualsMethods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
getInfoMethods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable
setInfoMethods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition
isMandatory, isMultiValue, isOptional, isSingleValueMethods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable
setDisplayHint
-
Field Details
-
complexTypeDefinition
-
-
Constructor Details
-
TransformableContainerDefinition
-
TransformableContainerDefinition
public TransformableContainerDefinition(PrismContainerDefinition<C> delegate, ComplexTypeDefinition typeDef)
-
-
Method Details
-
of
public static <C extends Containerable> TransformableContainerDefinition<C> of(PrismContainerDefinition<C> originalItem) -
getTypeName
Description copied from interface:DefinitionReturns 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:
getTypeNamein interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getTypeNamein interfaceDefinition- Specified by:
getTypeNamein interfaceDefinitionDelegator- Specified by:
getTypeNamein interfaceItemDefinitionDelegator<C extends Containerable>- Specified by:
getTypeNamein interfacePrismItemBasicDefinition- Returns:
- the type name
-
getTypeClass
Description copied from interface:DefinitionReturns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.- Specified by:
getTypeClassin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getTypeClassin interfaceDefinition- Specified by:
getTypeClassin interfaceDefinitionDelegator- Specified by:
getTypeClassin interfacePrismContainerDefinition<C extends Containerable>
-
getSchemaContextDefinition
- Specified by:
getSchemaContextDefinitionin interfaceDefinition- Specified by:
getSchemaContextDefinitionin interfaceDefinitionDelegator
-
findItemDefinition
public <T extends ItemDefinition<?>> T findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<T> clazz) Description copied from interface:LivePrismItemDefinitionUsed to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.- Specified by:
findItemDefinitionin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
findItemDefinitionin interfaceItemDefinitionDelegator<C extends Containerable>- Specified by:
findItemDefinitionin interfaceLivePrismItemDefinition- Specified by:
findItemDefinitionin interfaceLocalItemDefinitionStore
-
findContainerDefinition
public <C2 extends Containerable> PrismContainerDefinition<C2> findContainerDefinition(@NotNull @NotNull ItemPath path) Description copied from interface:LocalItemDefinitionStoreReturnsPrismContainerDefinitioncorresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.- Specified by:
findContainerDefinitionin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
findContainerDefinitionin interfaceLocalItemDefinitionStore
-
getCompileTimeClass
Description copied from interface:PrismContainerDefinitionStatic (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.)- Specified by:
getCompileTimeClassin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getCompileTimeClassin interfacePrismContainerDefinition<C extends Containerable>
-
getComplexTypeDefinition
Description copied from interface:PrismContainerDefinitionDefinition of the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) Note that individual values can hold their own (more specific) complex type definitions.- Specified by:
getComplexTypeDefinitionin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getComplexTypeDefinitionin interfacePrismContainerDefinition<C extends Containerable>
-
isEmpty
public boolean isEmpty()Description copied from interface:PrismContainerDefinitionTODO- Specified by:
isEmptyin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
isEmptyin interfacePrismContainerDefinition<C extends Containerable>
-
getDefinitions
Description copied from interface:PrismContainerDefinitionReturns a list of item definitions in this container. It is intentionally aListbecause it is ordered. (To provide standard format for serialization.) Usually obtained fromComplexTypeDefinition. So please do not modify the content of the list!- Specified by:
getDefinitionsin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getDefinitionsin interfaceLocalItemDefinitionStore- Specified by:
getDefinitionsin interfacePrismContainerDefinition<C extends Containerable>
-
findLocalItemDefinition
public <ID extends ItemDefinition<?>> ID findLocalItemDefinition(@NotNull @NotNull QName name, @NotNull @NotNull Class<ID> clazz, boolean caseInsensitive) Description copied from interface:LocalItemDefinitionStoreReturns 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:
findLocalItemDefinitionin interfaceLocalItemDefinitionStore
-
getPropertyDefinitions
Description copied from interface:PrismContainerDefinitionReturns set of property definitions. The set contains all property definitions of all types that were parsed. Order of definitions is insignificant. The returned collection is immutable or detached from the source. Don't try to modify it. It may fail or the changes may be lost.- Specified by:
getPropertyDefinitionsin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
getPropertyDefinitionsin interfacePrismContainerDefinition<C extends Containerable>
-
createEmptyDelta
Description copied from interface:ItemDefinitionCreates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.- Specified by:
createEmptyDeltain interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
createEmptyDeltain interfaceItemDefinition<C extends Containerable>- Specified by:
createEmptyDeltain interfaceItemDefinitionDelegator<C extends Containerable>- Specified by:
createEmptyDeltain interfacePrismContainerDefinition<C extends Containerable>
-
clone
- Specified by:
clonein interfaceDefinition- Specified by:
clonein interfaceItemDefinition<C extends Containerable>- Specified by:
clonein interfacePrismContainerDefinition<C extends Containerable>- Overrides:
clonein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
cloneWithNewType
@NotNull public @NotNull PrismContainerDefinition<?> cloneWithNewType(@NotNull @NotNull QName newTypeName, @NotNull @NotNull ComplexTypeDefinition newCtd) Description copied from interface:PrismContainerDefinitionChanges the type name and definition for this PCD. Use only in special cases.- Specified by:
cloneWithNewTypein interfacePrismContainerDefinition<C extends Containerable>
-
cloneWithNewName
@NotNull public @NotNull ItemDefinition<PrismContainer<C>> cloneWithNewName(@NotNull @NotNull ItemName itemName) Description copied from interface:ItemDefinitionReturns a clone of this definition, but with name changed to the provided one.- Specified by:
cloneWithNewNamein interfaceItemDefinition<C extends Containerable>- Overrides:
cloneWithNewNamein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>> - See Also:
-
deepClone
Description copied from interface:ItemDefinitionTODO document- Specified by:
deepClonein interfaceItemDefinition<C extends Containerable>- Specified by:
deepClonein interfaceItemDefinitionDelegator<C extends Containerable>- Overrides:
deepClonein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
copy
-
cloneWithNewDefinition
public PrismContainerDefinition<C> cloneWithNewDefinition(QName newItemName, ItemDefinition<?> newDefinition) Description copied from interface:PrismContainerDefinitionTODO- Specified by:
cloneWithNewDefinitionin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
cloneWithNewDefinitionin interfacePrismContainerDefinition<C extends Containerable>
-
replaceDefinition
Description copied from interface:PrismContainerDefinitionTODO- Specified by:
replaceDefinitionin interfaceContainerDefinitionDelegator<C extends Containerable>- Specified by:
replaceDefinitionin interfacePrismContainerDefinition<C extends Containerable>
-
mutator
Description copied from interface:DefinitionReturns an interface to mutate this definition.- Specified by:
mutatorin interfaceDefinition- Specified by:
mutatorin interfaceItemDefinition<C extends Containerable>- Specified by:
mutatorin interfacePrismContainerDefinition<C extends Containerable>- Overrides:
mutatorin classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
isImmutable
public boolean isImmutable()- Specified by:
isImmutablein interfaceFreezable- Overrides:
isImmutablein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
freeze
public void freeze()Description copied from interface:FreezableShould be no-op (or very quick) if the object is already immutable.- Specified by:
freezein interfaceFreezable- Overrides:
freezein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
instantiate
Description copied from interface:ItemDefinitionCreate an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.- Specified by:
instantiatein interfaceItemDefinition<C extends Containerable>- Specified by:
instantiatein interfaceItemDefinitionDelegator<C extends Containerable>- Throws:
SchemaException
-
instantiate
Description copied from interface:ItemDefinitionCreate an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.- Specified by:
instantiatein interfaceItemDefinition<C extends Containerable>- Specified by:
instantiatein interfaceItemDefinitionDelegator<C extends Containerable>- Overrides:
instantiatein classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>> - Throws:
SchemaException
-
publicView
- Specified by:
publicViewin classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
ensureMutableType
-
require
public static <C extends Containerable> TransformableContainerDefinition<C> require(PrismContainerDefinition<C> assocContainer) -
copy
- Specified by:
copyin classTransformableItemDefinition<PrismContainer<C extends Containerable>,PrismContainerDefinition<C extends Containerable>>
-
setSchemaContextDefinition
- Specified by:
setSchemaContextDefinitionin interfaceDefinition.DefinitionMutator
-