Class ValueMetadataWrapperImpl
- java.lang.Object
-
- com.evolveum.midpoint.gui.impl.prism.wrapper.ValueMetadataWrapperImpl
-
- All Implemented Interfaces:
ItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>,PrismContainerWrapper<ValueMetadataType>,Definition,Freezable,ItemDefinition<PrismContainer<ValueMetadataType>>,LocalItemDefinitionStore,PrismContainerDefinition<ValueMetadataType>,PrismContextSensitive,PrismItemAccessDefinition,Revivable,SmartVisitable<Definition>,Visitable<Definition>,DebugDumpable,Serializable,Cloneable
public class ValueMetadataWrapperImpl extends Object implements PrismContainerWrapper<ValueMetadataType>
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
PrismItemAccessDefinition.Mutable
-
-
Field Summary
-
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
-
-
Constructor Summary
Constructors Constructor Description ValueMetadataWrapperImpl(PrismContainerWrapper<ValueMetadataType> metadataValueWrapper)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(Visitor<Definition> visitor)booleanaccept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)<PV extends PrismValue>
voidadd(PV newValueWrapper, ModelServiceLocator locator)voidadoptElementDefinitionFrom(ItemDefinition<?> otherDef)Transfers selected parts of the definition (currently item name, min/max occurs) from another definition.booleancanAdd()Returns true if this item can be added: it can be part of an object that is created.booleancanBeDefinitionOf(PrismContainer<ValueMetadataType> item)TODO documentbooleancanBeDefinitionOf(PrismValue pvalue)TODO documentbooleancanModify()Returns true if this item can be modified (updated).booleancanRead()Returns true if this item can be read (displayed).booleancanRepresent(@NotNull QName type)TODObooleancheckRequired()@NotNull PrismContainerDefinition<ValueMetadataType>clone()PrismContainerDefinition<ValueMetadataType>cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition)TODO@NotNull ContainerDelta<ValueMetadataType>createEmptyDelta(ItemPath path)Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.PrismContainerValue<ValueMetadataType>createValue()TODOStringdebugDump(int indent)voiddebugDumpShortToString(StringBuilder sb)Used in debugDumping items.ItemDefinition<PrismContainer<ValueMetadataType>>deepClone(@NotNull DeepCloneOperation operation)TODO document<T extends Containerable>
PrismContainerWrapper<T>findContainer(ItemPath path)<T extends Containerable>
PrismContainerWrapper<T>findContainer(String identifier)<T extends Containerable>
PrismContainerValueWrapper<T>findContainerValue(ItemPath path)<IW extends ItemWrapper>
IWfindItem(ItemPath path, Class<IW> type)<T extends ItemDefinition<?>>
TfindItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)Used to find a matching item definition _within_ this definition.ItemStatusfindObjectStatus()<OW extends PrismObjectWrapper<O>,O extends ObjectType>
OWfindObjectWrapper()<X> PrismPropertyWrapper<X>findProperty(ItemPath propertyPath)<R extends Referencable>
PrismReferenceWrapper<R>findReference(ItemPath path)voidfreeze()<A> AgetAnnotation(QName qname)Returns generic definition annotation.@Nullable Map<QName,Object>getAnnotations()Returns all annotations, as unmodifiable map.List<PrismContainerDefinition<? extends Containerable>>getChildContainers()List<? extends ItemDefinition>getChildNonContainers()Class<ValueMetadataType>getCompileTimeClass()Static (compile-time) class holding the container values.ComplexTypeDefinitiongetComplexTypeDefinition()Definition of the container values.@NotNull List<? extends ItemDefinition<?>>getDefinitions()Returns a list of item definitions in this container.<D extends ItemDelta<? extends PrismValue,? extends ItemDefinition>>
Collection<D>getDelta()StringgetDeprecatedSince()List<ItemDiagramSpecification>getDiagrams()StringgetDisplayName()Returns display name.IntegergetDisplayOrder()Specifies an order in which the item should be displayed relative to other items at the same level.StringgetDocumentation()StringgetDocumentationPreview()Returns only a first sentence of documentation.ExpressionTypegetFormComponentValidator()StringgetHelp()Returns help string.StringgetIdentifier()PrismContainer<ValueMetadataType>getItem()@NotNull ItemNamegetItemName()Gets the "canonical" name of the item for the definition.intgetMaxOccurs()Return the number of maximal value occurrences.intgetMinOccurs()Return the number of minimal value occurrences.PrismContainerValueWrapper<?>getParent()<C extends Containerable>
PrismContainerValueWrapper<C>getParentContainerValue(Class<? extends C> parentClass)ItemPathgetPath()StringgetPlannedRemoval()Version of data model in which the item is likely to be removed.PrismContextgetPrismContext()ItemProcessinggetProcessing()Level of processing (ignore, minimal, auto, full) for this item/type.List<PrismPropertyDefinition<?>>getPropertyDefinitions()Returns set of property definitions.List<SchemaMigration>getSchemaMigrations()PrismContainerWrapper<? extends Containerable>getSelectedChild()ItemStatusgetStatus()QNamegetSubstitutionHead()Returns the name of an element this one can be substituted for (e.g.Class<ValueMetadataType>getTypeClass()Returns a compile-time class that is used to represent items.@NotNull QNamegetTypeName()Returns a name of the type for this definition.PrismContainerValueWrapper<ValueMetadataType>getValue()PrismReferenceValuegetValueEnumerationRef()Reference to an object that directly or indirectly represents possible values for this item.List<PrismContainerValueWrapper<ValueMetadataType>>getValues()UserInterfaceElementVisibilityTypegetVisibleOverwrite()@NotNull PrismContainer<ValueMetadataType>instantiate()Create an item instance.@NotNull PrismContainer<ValueMetadataType>instantiate(QName name)Create an item instance.booleanisAbstract()For types: is the type abstract so that it should not be instantiated directly? For items: TODObooleanisColumn()booleanisDeprecated()booleanisDynamic()Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.booleanisElaborate()Elaborate items are complicated data structure that may deviate from normal principles of the system.booleanisEmphasized()True for definitions that are more important than others and that should be emphasized during presentation.booleanisEmpty()TODObooleanisExpanded()booleanisExperimental()Experimental functionality is not stable and it may be changed in any future release without any warning.booleanisHeterogeneousListItem()Can be used in heterogeneous lists as a list item.booleanisIgnored()Item definition that has this flag set should be ignored by any processing.booleanisImmutable()booleanisIndexOnly()If true, this item is not stored in XML representation in repo.booleanisInherited()Whether the item is inherited from a supertype.booleanisMetadata()booleanisOperational()Marks operational item.booleanisProcessProvenanceMetadata()booleanisReadOnly()booleanisRuntimeSchema()This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.booleanisShowEmpty()booleanisShowInVirtualContainer()booleanisShowMetadataDetails()booleanisValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way.booleanisVirtual()booleanisVisible(PrismContainerValueWrapper<?> parentContainer, ItemVisibilityHandler visibilityHandler)voidremove(PrismContainerValueWrapper<ValueMetadataType> valueWrapper, ModelServiceLocator locator)voidremoveAll(ModelServiceLocator locator)voidreplaceDefinition(QName itemName, ItemDefinition<?> newDefinition)TODOvoidrevive(PrismContext prismContext)TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)<A> voidsetAnnotation(QName qname, A value)voidsetColumn(boolean column)voidsetExpanded(boolean expanded)voidsetIdentifier(String identifier)voidsetMetadata(boolean metadata)voidsetProcessProvenanceMetadata(boolean processProvenanceMetadata)voidsetReadOnly(boolean readOnly)voidsetShowEmpty(boolean isShowEmpty, boolean recursive)voidsetShowInVirtualContainer(boolean showInVirtualContainer)voidsetShowMetadataDetails(boolean showMetadataDetails)voidsetVirtual(boolean virtual)voidsetVisibleOverwrite(UserInterfaceElementVisibilityType visible)MutablePrismContainerDefinition<ValueMetadataType>toMutable()Returns an interface to mutate this definition.voidunselect()-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDumpLazily, debugDumpLazily
-
Methods inherited from interface com.evolveum.midpoint.prism.Definition
debugDump, getMutabilityFlag, getSchemaRegistry
-
Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable
-
Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition
isMandatory, isMultiValue, isOptional, isSingleValue
-
Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore
containsItemDefinition, findContainerDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition
-
Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition
getAlwaysUseForEquals, getItemNames, isAlwaysUseForEquals, isCompletelyDefined, structuredType
-
Methods inherited from interface com.evolveum.midpoint.gui.api.prism.wrapper.PrismContainerWrapper
cloneVirtualContainerWithNewValue
-
-
-
-
Constructor Detail
-
ValueMetadataWrapperImpl
public ValueMetadataWrapperImpl(PrismContainerWrapper<ValueMetadataType> metadataValueWrapper)
-
-
Method Detail
-
getTypeName
@NotNull public @NotNull QName 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 interfaceDefinition- Returns:
- the type name
-
isRuntimeSchema
public boolean isRuntimeSchema()
Description copied from interface:DefinitionThis means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.- Specified by:
isRuntimeSchemain interfaceDefinition
-
isIgnored
public boolean isIgnored()
Description copied from interface:DefinitionItem definition that has this flag set should be ignored by any processing. The ignored item is still part of the schema. Item instances may appear in the serialized data formats (e.g. XML) or data store and the parser should not raise an error if it encounters them. But any high-level processing code should ignore presence of this item. E.g. it should not be displayed to the user, should not be present in transformed data structures, etc. Note that the same item can be ignored at higher layer (e.g. presentation) but not ignored at lower layer (e.g. model). This works by presenting different item definitions for these layers (see LayerRefinedAttributeDefinition). Semantics of this flag for complex type definitions is to be defined yet.- Specified by:
isIgnoredin interfaceDefinition
-
getProcessing
public ItemProcessing getProcessing()
Description copied from interface:DefinitionLevel of processing (ignore, minimal, auto, full) for this item/type.- Specified by:
getProcessingin interfaceDefinition
-
isAbstract
public boolean isAbstract()
Description copied from interface:DefinitionFor types: is the type abstract so that it should not be instantiated directly? For items: TODO- Specified by:
isAbstractin interfaceDefinition
-
isDeprecated
public boolean isDeprecated()
- Specified by:
isDeprecatedin interfaceDefinition
-
isExperimental
public boolean isExperimental()
Description copied from interface:DefinitionExperimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.- Specified by:
isExperimentalin interfaceDefinition
-
getPlannedRemoval
public String getPlannedRemoval()
Description copied from interface:DefinitionVersion of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.- Specified by:
getPlannedRemovalin interfaceDefinition
-
isElaborate
public boolean isElaborate()
Description copied from interface:DefinitionElaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.- Specified by:
isElaboratein interfaceDefinition
-
getDeprecatedSince
public String getDeprecatedSince()
- Specified by:
getDeprecatedSincein interfaceDefinition
-
isEmphasized
public boolean isEmphasized()
Description copied from interface:DefinitionTrue 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.- Specified by:
isEmphasizedin interfaceDefinition
-
getDisplayName
public String getDisplayName()
Description copied from interface:DefinitionReturns 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:
getDisplayNamein interfaceDefinition- Returns:
- display name string or catalog key
-
getDisplayOrder
public Integer getDisplayOrder()
Description copied from interface:DefinitionSpecifies 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:
getDisplayOrderin interfaceDefinition
-
getHelp
public String getHelp()
Description copied from interface:DefinitionReturns 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:
getHelpin interfaceDefinition- Returns:
- help string or catalog key
-
getDocumentation
public String getDocumentation()
- Specified by:
getDocumentationin interfaceDefinition
-
getDocumentationPreview
public String getDocumentationPreview()
Description copied from interface:DefinitionReturns only a first sentence of documentation.- Specified by:
getDocumentationPreviewin interfaceDefinition
-
isExpanded
public boolean isExpanded()
- Specified by:
isExpandedin interfacePrismContainerWrapper<ValueMetadataType>
-
getStatus
public ItemStatus getStatus()
- Specified by:
getStatusin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Specified by:
getStatusin interfacePrismContainerWrapper<ValueMetadataType>
-
getCompileTimeClass
public Class<ValueMetadataType> 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 interfacePrismContainerDefinition<ValueMetadataType>
-
getComplexTypeDefinition
public ComplexTypeDefinition 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 interfacePrismContainerDefinition<ValueMetadataType>
-
getDefinitions
@NotNull public @NotNull List<? extends ItemDefinition<?>> 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 interfaceLocalItemDefinitionStore- Specified by:
getDefinitionsin interfacePrismContainerDefinition<ValueMetadataType>
-
getPropertyDefinitions
public List<PrismPropertyDefinition<?>> 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 set is immutable! All changes may be lost.- Specified by:
getPropertyDefinitionsin interfacePrismContainerDefinition<ValueMetadataType>- Returns:
- set of definitions
-
getItemName
@NotNull public @NotNull ItemName getItemName()
Description copied from interface:ItemDefinitionGets the "canonical" name of the item for the definition. Should be qualified, if at all possible.- Specified by:
getItemNamein interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
getMinOccurs
public int getMinOccurs()
Description copied from interface:ItemDefinitionReturn the number of minimal value occurrences.- Specified by:
getMinOccursin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
getMaxOccurs
public int getMaxOccurs()
Description copied from interface:ItemDefinitionReturn the number of maximal value occurrences. Any negative number means "unbounded".- Specified by:
getMaxOccursin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isOperational
public boolean isOperational()
Description copied from interface:ItemDefinitionMarks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. SeeParameterizedEquivalenceStrategy.- Specified by:
isOperationalin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isIndexOnly
public boolean isIndexOnly()
Description copied from interface:ItemDefinitionIf true, this item is not stored in XML representation in repo. TODO better name- Specified by:
isIndexOnlyin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isInherited
public boolean isInherited()
Description copied from interface:ItemDefinitionWhether the item is inherited from a supertype.- Specified by:
isInheritedin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isDynamic
public boolean isDynamic()
Description copied from interface:ItemDefinitionReturns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).- Specified by:
isDynamicin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
canRead
public boolean canRead()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.
- Specified by:
canReadin interfacePrismItemAccessDefinition
-
canModify
public boolean canModify()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.- Specified by:
canModifyin interfacePrismItemAccessDefinition
-
canAdd
public boolean canAdd()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.- Specified by:
canAddin interfacePrismItemAccessDefinition
-
getSubstitutionHead
public QName getSubstitutionHead()
Description copied from interface:ItemDefinitionReturns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL- Specified by:
getSubstitutionHeadin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isHeterogeneousListItem
public boolean isHeterogeneousListItem()
Description copied from interface:ItemDefinitionCan be used in heterogeneous lists as a list item. EXPERIMENTAL.- Specified by:
isHeterogeneousListItemin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
getValueEnumerationRef
public PrismReferenceValue getValueEnumerationRef()
Description copied from interface:ItemDefinitionReference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.- Specified by:
getValueEnumerationRefin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
isValidFor
public boolean isValidFor(@NotNull @NotNull QName elementQName, @NotNull @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)Description copied from interface:ItemDefinitionReturns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.- Specified by:
isValidForin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
adoptElementDefinitionFrom
public void adoptElementDefinitionFrom(ItemDefinition<?> otherDef)
Description copied from interface:ItemDefinitionTransfers selected parts of the definition (currently item name, min/max occurs) from another definition. TODO used only on few places, consider removing- Specified by:
adoptElementDefinitionFromin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
instantiate
@NotNull public @NotNull PrismContainer<ValueMetadataType> instantiate() throws SchemaException
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<PrismContainer<ValueMetadataType>>- Throws:
SchemaException
-
instantiate
@NotNull public @NotNull PrismContainer<ValueMetadataType> instantiate(QName name) throws SchemaException
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<PrismContainer<ValueMetadataType>>- Throws:
SchemaException
-
findItemDefinition
public <T extends ItemDefinition<?>> T findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<T> clazz)
Description copied from interface:ItemDefinitionUsed to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.- Specified by:
findItemDefinitionin interfaceItemDefinition<PrismContainer<ValueMetadataType>>- Specified by:
findItemDefinitionin interfaceLocalItemDefinitionStore
-
createEmptyDelta
@NotNull public @NotNull ContainerDelta<ValueMetadataType> createEmptyDelta(ItemPath path)
Description copied from interface:ItemDefinitionCreates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.- Specified by:
createEmptyDeltain interfaceItemDefinition<PrismContainer<ValueMetadataType>>- Specified by:
createEmptyDeltain interfacePrismContainerDefinition<ValueMetadataType>
-
clone
@NotNull public @NotNull PrismContainerDefinition<ValueMetadataType> clone()
- Specified by:
clonein interfaceDefinition- Specified by:
clonein interfaceItemDefinition<PrismContainer<ValueMetadataType>>- Specified by:
clonein interfacePrismContainerDefinition<ValueMetadataType>- Overrides:
clonein classObject
-
deepClone
public ItemDefinition<PrismContainer<ValueMetadataType>> deepClone(@NotNull @NotNull DeepCloneOperation operation)
Description copied from interface:ItemDefinitionTODO document- Specified by:
deepClonein interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
revive
public void revive(PrismContext prismContext)
Description copied from interface:RevivableTODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
-
debugDumpShortToString
public void debugDumpShortToString(StringBuilder sb)
Description copied from interface:ItemDefinitionUsed in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.- Specified by:
debugDumpShortToStringin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
canBeDefinitionOf
public boolean canBeDefinitionOf(PrismContainer<ValueMetadataType> item)
Description copied from interface:ItemDefinitionTODO document- Specified by:
canBeDefinitionOfin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
canBeDefinitionOf
public boolean canBeDefinitionOf(PrismValue pvalue)
Description copied from interface:ItemDefinitionTODO document- Specified by:
canBeDefinitionOfin interfaceItemDefinition<PrismContainer<ValueMetadataType>>
-
cloneWithReplacedDefinition
public PrismContainerDefinition<ValueMetadataType> cloneWithReplacedDefinition(QName itemName, ItemDefinition<?> newDefinition)
Description copied from interface:PrismContainerDefinitionTODO- Specified by:
cloneWithReplacedDefinitionin interfacePrismContainerDefinition<ValueMetadataType>
-
replaceDefinition
public void replaceDefinition(QName itemName, ItemDefinition<?> newDefinition)
Description copied from interface:PrismContainerDefinitionTODO- Specified by:
replaceDefinitionin interfacePrismContainerDefinition<ValueMetadataType>
-
createValue
public PrismContainerValue<ValueMetadataType> createValue()
Description copied from interface:PrismContainerDefinitionTODO- Specified by:
createValuein interfacePrismContainerDefinition<ValueMetadataType>
-
isEmpty
public boolean isEmpty()
Description copied from interface:PrismContainerDefinitionTODO- Specified by:
isEmptyin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Specified by:
isEmptyin interfacePrismContainerDefinition<ValueMetadataType>
-
canRepresent
public boolean canRepresent(@NotNull @NotNull QName type)Description copied from interface:PrismContainerDefinitionTODO- Specified by:
canRepresentin interfacePrismContainerDefinition<ValueMetadataType>
-
toMutable
public MutablePrismContainerDefinition<ValueMetadataType> toMutable()
Description copied from interface:DefinitionReturns an interface to mutate this definition.- Specified by:
toMutablein interfaceDefinition- Specified by:
toMutablein interfaceItemDefinition<PrismContainer<ValueMetadataType>>- Specified by:
toMutablein interfacePrismContainerDefinition<ValueMetadataType>
-
getTypeClass
public Class<ValueMetadataType> 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 interfaceDefinition- Specified by:
getTypeClassin interfacePrismContainerDefinition<ValueMetadataType>
-
getAnnotation
public <A> A getAnnotation(QName qname)
Description copied from interface:DefinitionReturns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).- Specified by:
getAnnotationin interfaceDefinition
-
setAnnotation
public <A> void setAnnotation(QName qname, A value)
- Specified by:
setAnnotationin interfaceDefinition
-
getAnnotations
@Nullable public @Nullable Map<QName,Object> getAnnotations()
Description copied from interface:DefinitionReturns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.- Specified by:
getAnnotationsin interfaceDefinition
-
getSchemaMigrations
public List<SchemaMigration> getSchemaMigrations()
- Specified by:
getSchemaMigrationsin interfaceDefinition
-
getDiagrams
public List<ItemDiagramSpecification> getDiagrams()
- Specified by:
getDiagramsin interfaceDefinition
-
remove
public void remove(PrismContainerValueWrapper<ValueMetadataType> valueWrapper, ModelServiceLocator locator) throws SchemaException
- Specified by:
removein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Throws:
SchemaException
-
removeAll
public void removeAll(ModelServiceLocator locator) throws SchemaException
- Specified by:
removeAllin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Throws:
SchemaException
-
add
public <PV extends PrismValue> void add(PV newValueWrapper, ModelServiceLocator locator) throws SchemaException
- Specified by:
addin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Throws:
SchemaException
-
setVirtual
public void setVirtual(boolean virtual)
- Specified by:
setVirtualin interfacePrismContainerWrapper<ValueMetadataType>
-
setExpanded
public void setExpanded(boolean expanded)
- Specified by:
setExpandedin interfacePrismContainerWrapper<ValueMetadataType>
-
findContainer
public <T extends Containerable> PrismContainerWrapper<T> findContainer(ItemPath path) throws SchemaException
- Specified by:
findContainerin interfacePrismContainerWrapper<ValueMetadataType>- Throws:
SchemaException
-
findContainer
public <T extends Containerable> PrismContainerWrapper<T> findContainer(String identifier)
- Specified by:
findContainerin interfacePrismContainerWrapper<ValueMetadataType>
-
findProperty
public <X> PrismPropertyWrapper<X> findProperty(ItemPath propertyPath) throws SchemaException
- Specified by:
findPropertyin interfacePrismContainerWrapper<ValueMetadataType>- Throws:
SchemaException
-
findReference
public <R extends Referencable> PrismReferenceWrapper<R> findReference(ItemPath path) throws SchemaException
- Specified by:
findReferencein interfacePrismContainerWrapper<ValueMetadataType>- Throws:
SchemaException
-
findContainerValue
public <T extends Containerable> PrismContainerValueWrapper<T> findContainerValue(ItemPath path) throws SchemaException
- Specified by:
findContainerValuein interfacePrismContainerWrapper<ValueMetadataType>- Throws:
SchemaException
-
findItem
public <IW extends ItemWrapper> IW findItem(ItemPath path, Class<IW> type) throws SchemaException
- Specified by:
findItemin interfacePrismContainerWrapper<ValueMetadataType>- Throws:
SchemaException
-
getSelectedChild
public PrismContainerWrapper<? extends Containerable> getSelectedChild()
- Specified by:
getSelectedChildin interfacePrismContainerWrapper<ValueMetadataType>
-
setIdentifier
public void setIdentifier(String identifier)
- Specified by:
setIdentifierin interfacePrismContainerWrapper<ValueMetadataType>
-
getIdentifier
public String getIdentifier()
- Specified by:
getIdentifierin interfacePrismContainerWrapper<ValueMetadataType>
-
getPath
public ItemPath getPath()
- Specified by:
getPathin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isReadOnly
public boolean isReadOnly()
- Specified by:
isReadOnlyin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setReadOnly
public void setReadOnly(boolean readOnly)
- Specified by:
setReadOnlyin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getFormComponentValidator
public ExpressionType getFormComponentValidator()
- Specified by:
getFormComponentValidatorin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getValues
public List<PrismContainerValueWrapper<ValueMetadataType>> getValues()
- Specified by:
getValuesin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getValue
public PrismContainerValueWrapper<ValueMetadataType> getValue() throws SchemaException
- Specified by:
getValuein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Throws:
SchemaException
-
getItem
public PrismContainer<ValueMetadataType> getItem()
- Specified by:
getItemin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isColumn
public boolean isColumn()
- Specified by:
isColumnin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setColumn
public void setColumn(boolean column)
- Specified by:
setColumnin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getDelta
public <D extends ItemDelta<? extends PrismValue,? extends ItemDefinition>> Collection<D> getDelta() throws SchemaException
- Specified by:
getDeltain interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>- Throws:
SchemaException
-
findObjectStatus
public ItemStatus findObjectStatus()
- Specified by:
findObjectStatusin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
findObjectWrapper
public <OW extends PrismObjectWrapper<O>,O extends ObjectType> OW findObjectWrapper()
- Specified by:
findObjectWrapperin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isShowEmpty
public boolean isShowEmpty()
- Specified by:
isShowEmptyin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setShowEmpty
public void setShowEmpty(boolean isShowEmpty, boolean recursive)- Specified by:
setShowEmptyin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isShowInVirtualContainer
public boolean isShowInVirtualContainer()
- Specified by:
isShowInVirtualContainerin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setShowInVirtualContainer
public void setShowInVirtualContainer(boolean showInVirtualContainer)
- Specified by:
setShowInVirtualContainerin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isVirtual
public boolean isVirtual()
- Specified by:
isVirtualin interfacePrismContainerWrapper<ValueMetadataType>
-
isMetadata
public boolean isMetadata()
- Specified by:
isMetadatain interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setMetadata
public void setMetadata(boolean metadata)
- Specified by:
setMetadatain interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setShowMetadataDetails
public void setShowMetadataDetails(boolean showMetadataDetails)
- Specified by:
setShowMetadataDetailsin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isShowMetadataDetails
public boolean isShowMetadataDetails()
- Specified by:
isShowMetadataDetailsin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isProcessProvenanceMetadata
public boolean isProcessProvenanceMetadata()
- Specified by:
isProcessProvenanceMetadatain interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setProcessProvenanceMetadata
public void setProcessProvenanceMetadata(boolean processProvenanceMetadata)
- Specified by:
setProcessProvenanceMetadatain interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getParentContainerValue
public <C extends Containerable> PrismContainerValueWrapper<C> getParentContainerValue(Class<? extends C> parentClass)
- Specified by:
getParentContainerValuein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
debugDump
public String debugDump(int indent)
- Specified by:
debugDumpin interfaceDebugDumpable- Specified by:
debugDumpin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
setVisibleOverwrite
public void setVisibleOverwrite(UserInterfaceElementVisibilityType visible)
- Specified by:
setVisibleOverwritein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getVisibleOverwrite
public UserInterfaceElementVisibilityType getVisibleOverwrite()
- Specified by:
getVisibleOverwritein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isVisible
public boolean isVisible(PrismContainerValueWrapper<?> parentContainer, ItemVisibilityHandler visibilityHandler)
- Specified by:
isVisiblein interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
checkRequired
public boolean checkRequired()
- Specified by:
checkRequiredin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
getParent
public PrismContainerValueWrapper<?> getParent()
- Specified by:
getParentin interfaceItemWrapper<PrismContainer<ValueMetadataType>,PrismContainerValueWrapper<ValueMetadataType>>
-
isImmutable
public boolean isImmutable()
- Specified by:
isImmutablein interfaceFreezable
-
getPrismContext
public PrismContext getPrismContext()
- Specified by:
getPrismContextin interfacePrismContextSensitive
-
accept
public boolean accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
- Specified by:
acceptin interfaceSmartVisitable<Definition>- Returns:
- false if we already was here
-
accept
public void accept(Visitor<Definition> visitor)
- Specified by:
acceptin interfaceVisitable<Definition>
-
getChildContainers
public List<PrismContainerDefinition<? extends Containerable>> getChildContainers() throws SchemaException
- Throws:
SchemaException
-
getChildNonContainers
public List<? extends ItemDefinition> getChildNonContainers()
-
unselect
public void unselect()
-
-