com.evolveum.midpoint.prism

Class PrismContainerDefinition<C extends Containerable>

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ItemDefinition<PrismContainer<C>>

com.evolveum.midpoint.prism.PrismContainerDefinition<C>

All Implemented Interfaces:

Revivable, DebugDumpable, Serializable

Direct Known Subclasses:

PrismObjectDefinition, ResourceAttributeContainerDefinition

public class PrismContainerDefinition<C extends Containerable>
extends ItemDefinition<PrismContainer<C>>

Definition of a property container.

Property container groups properties into logical blocks. The reason for grouping may be as simple as better understandability of data structure. But the group usually means different meaning, source or structure of the data. For example, the property container is frequently used to hold properties that are dynamic, not fixed by a static schema. Such grouping also naturally translates to XML and helps to "quarantine" such properties to avoid Unique Particle Attribute problems.

Property Container contains a set of (potentially multi-valued) properties. The order of properties is not significant, regardless of the fact that it may be fixed in the XML representation. In the XML representation, each element inside Property Container must be either Property or a Property Container.

This class represents schema definition for property container. See Definition for more details.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<C>	compileTimeClass
protected ComplexTypeDefinition	complexTypeDefinition

Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition

name

Fields inherited from class com.evolveum.midpoint.prism.Definition

deprecated, displayName, displayOrder, documentation, emphasized, help, ignored, inherited, isAbstract, isRuntimeSchema, prismContext, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
PrismContainerDefinition(QName name, ComplexTypeDefinition complexTypeDefinition, PrismContext prismContext) The constructors should be used only occasionally (if used at all).
PrismContainerDefinition(QName name, ComplexTypeDefinition complexTypeDefinition, PrismContext prismContext, Class<C> compileTimeClass)

Method Summary

Methods

Modifier and Type	Method and Description
PrismContainerDefinition<C>	clone() Shallow clone
PrismContainerDefinition<C>	cloneWithReplacedDefinition(QName itemName, ItemDefinition newDefinition)
protected void	copyDefinitionData(PrismContainerDefinition<C> clone)
PrismContainerDefinition<C>	createContainerDefinition(QName name, ComplexTypeDefinition complexTypeDefinition, int minOccurs, int maxOccurs)
PrismContainerDefinition	createContainerDefinition(QName name, QName typeName)
PrismContainerDefinition	createContainerDefinition(QName name, QName typeName, int minOccurs, int maxOccurs)
ContainerDelta<C>	createEmptyDelta(ItemPath path)
PrismPropertyDefinition	createPropertyDefinition(QName name)
PrismPropertyDefinition	createPropertyDefinition(QName name, QName typeName) Creates new instance of property definition and adds it to the container.
PrismPropertyDefinition	createPropertyDefinition(QName name, QName typeName, int minOccurs, int maxOccurs) Creates new instance of property definition and adds it to the container.
PrismPropertyDefinition	createPropertyDefinition(String localName, QName typeName) Creates new instance of property definition and adds it to the container.
PrismPropertyDefinition	createPropertyDefinition(String localName, String localTypeName) Creates new instance of property definition and adds it to the container.
PrismPropertyDefinition	createPropertyDefinition(String localName, String localTypeName, int minOccurs, int maxOccurs) Creates new instance of property definition and adds it to the container.
PrismContainerValue<C>	createValue()
String	debugDump(int indent)
PrismContainerDefinition	findContainerDefinition(ItemPath path) Finds an inner PropertyContainerDefinition by following the property container path.
<X extends Containerable> PrismContainerDefinition<X>	findContainerDefinition(QName name) Finds an inner PropertyContainerDefinition by looking at the property container name.
<X extends Containerable> PrismContainerDefinition<X>	findContainerDefinition(String name)
<ID extends ItemDefinition> ID	findItemDefinition(ItemPath path)
<ID extends ItemDefinition> ID	findItemDefinition(ItemPath path, Class<ID> clazz)
<ID extends ItemDefinition> ID	findItemDefinition(QName name)
<D extends ItemDefinition> D	findItemDefinition(QName name, Class<D> clazz)
<D extends ItemDefinition> D	findItemDefinition(QName name, Class<D> clazz, boolean caseInsensitive)
<ID extends ItemDefinition> ID	findNamedItemDefinition(QName firstName, ItemPath rest, Class<ID> clazz)
<T> PrismPropertyDefinition<T>	findPropertyDefinition(ItemPath path)
<T> PrismPropertyDefinition<T>	findPropertyDefinition(QName name) Finds a PropertyDefinition by looking at the property name.
PrismReferenceDefinition	findReferenceDefinition(ItemPath path)
PrismReferenceDefinition	findReferenceDefinition(QName name)
Class<C>	getCompileTimeClass()
ComplexTypeDefinition	getComplexTypeDefinition()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
List<? extends ItemDefinition>	getDefinitions() Returns set of property definitions.
String	getDocClassName() Returns human-readable name of this class suitable for documentation.
List<PrismPropertyDefinition>	getPropertyDefinitions() Returns set of property definitions.
protected String	getSchemaNamespace()
PrismContainer<C>	instantiate() Create property container instance with a default name.
PrismContainer<C>	instantiate(QName elementName) Create property container instance with a specified name and element.
boolean	isAbstract()
boolean	isEmpty()
boolean	isWildcard() Returns true if the definition does not define specific items but it is just a "wildcard" for any kind of item (usually represented as xsd:any type).
void	revive(PrismContext prismContext)
void	setCompileTimeClass(Class<C> compileTimeClass)
void	setComplexTypeDefinition(ComplexTypeDefinition complexTypeDefinition)

Methods inherited from class com.evolveum.midpoint.prism.ItemDefinition

addNamespaceIfApplicable, adoptElementDefinitionFrom, canAdd, canModify, canRead, copyDefinitionData, debugFlags, debugMultiplicity, deepClone, equals, extendToString, getMaxOccurs, getMinOccurs, getName, getNamespace, getValueEnumerationRef, hashCode, isDynamic, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, setCanAdd, setCanModify, setCanRead, setDynamic, setMaxOccurs, setMinOccurs, setName, setOperational, setReadOnly, setValueEnumerationRef, toString

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

copyDefinitionData, debugDump, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPrismContext, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isDeprecated, isEmphasized, isIgnored, isInherited, isRuntimeSchema, setAbstract, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setEmphasized, setHelp, setIgnored, setInherited, setRuntimeSchema, setTypeName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

complexTypeDefinition

protected ComplexTypeDefinition complexTypeDefinition

compileTimeClass

protected Class<C extends Containerable> compileTimeClass

Constructor Detail

PrismContainerDefinition

public PrismContainerDefinition(QName name,
                        ComplexTypeDefinition complexTypeDefinition,
                        PrismContext prismContext)

The constructors should be used only occasionally (if used at all). Use the factory methods in the ResourceObjectDefintion instead.

PrismContainerDefinition

public PrismContainerDefinition(QName name,
                        ComplexTypeDefinition complexTypeDefinition,
                        PrismContext prismContext,
                        Class<C> compileTimeClass)

Method Detail

getCompileTimeClass

public Class<C> getCompileTimeClass()

setCompileTimeClass

public void setCompileTimeClass(Class<C> compileTimeClass)

getSchemaNamespace

protected String getSchemaNamespace()

getComplexTypeDefinition

public ComplexTypeDefinition getComplexTypeDefinition()

setComplexTypeDefinition

public void setComplexTypeDefinition(ComplexTypeDefinition complexTypeDefinition)

isAbstract

public boolean isAbstract()

Overrides:

isAbstract in class Definition

isWildcard

public boolean isWildcard()

Returns true if the definition does not define specific items but it is just a "wildcard" for any kind of item (usually represented as xsd:any type).

revive

public void revive(PrismContext prismContext)

Specified by:

revive in interface Revivable

Overrides:

revive in class ItemDefinition<PrismContainer<C extends Containerable>>

findItemDefinition

public <D extends ItemDefinition> D findItemDefinition(QName name,
                                              Class<D> clazz)

findItemDefinition

public <D extends ItemDefinition> D findItemDefinition(QName name,
                                              Class<D> clazz,
                                              boolean caseInsensitive)

findItemDefinition

public <ID extends ItemDefinition> ID findItemDefinition(ItemPath path,
                                                Class<ID> clazz)

findNamedItemDefinition

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

findItemDefinition

public <ID extends ItemDefinition> ID findItemDefinition(QName name)

findItemDefinition

public <ID extends ItemDefinition> ID findItemDefinition(ItemPath path)

findPropertyDefinition

public <T> PrismPropertyDefinition<T> findPropertyDefinition(QName name)

Finds a PropertyDefinition by looking at the property name.

Returns null if nothing is found.

Parameters:

name - property definition name

Returns:

found property definition or null

findPropertyDefinition

public <T> PrismPropertyDefinition<T> findPropertyDefinition(ItemPath path)

findReferenceDefinition

public PrismReferenceDefinition findReferenceDefinition(QName name)

findReferenceDefinition

public PrismReferenceDefinition findReferenceDefinition(ItemPath path)

findContainerDefinition

public <X extends Containerable> PrismContainerDefinition<X> findContainerDefinition(QName name)

Finds an inner PropertyContainerDefinition by looking at the property container name.

Returns null if nothing is found.

Parameters:

name - property container definition name

Returns:

found property container definition or null

findContainerDefinition

public <X extends Containerable> PrismContainerDefinition<X> findContainerDefinition(String name)

findContainerDefinition

public PrismContainerDefinition findContainerDefinition(ItemPath path)

Finds an inner PropertyContainerDefinition by following the property container path.

Returns null if nothing is found.

Parameters:

path - property container path

Returns:

found property container definition or null

getDefinitions

public List<? extends ItemDefinition> getDefinitions()

Returns set of property definitions.

WARNING: This may return definitions from the associated complex type. Therefore changing the returned set may influence also the complex type definition.

The set contains all property definitions of all types that were parsed. Order of definitions is insignificant.

Returns:

set of definitions

getPropertyDefinitions

public List<PrismPropertyDefinition> getPropertyDefinitions()

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

Returns:

set of definitions

instantiate

public PrismContainer<C> instantiate()
                                                    throws SchemaException

Create property container instance with a default name.

This is a preferred way how to create property container.

Specified by:

instantiate in class ItemDefinition<PrismContainer<C extends Containerable>>

Returns:

created item instance

Throws:

SchemaException

instantiate

public PrismContainer<C> instantiate(QName elementName)
                                                    throws SchemaException

Create property container instance with a specified name and element.

This is a preferred way how to create property container.

Specified by:

instantiate in class ItemDefinition<PrismContainer<C extends Containerable>>

Returns:

created item instance

Throws:

SchemaException

createEmptyDelta

public ContainerDelta<C> createEmptyDelta(ItemPath path)

Specified by:

createEmptyDelta in class ItemDefinition<PrismContainer<C extends Containerable>>

clone

public PrismContainerDefinition<C> clone()

Shallow clone

Specified by:

clone in class ItemDefinition<PrismContainer<C extends Containerable>>

copyDefinitionData

protected void copyDefinitionData(PrismContainerDefinition<C> clone)

cloneWithReplacedDefinition

public PrismContainerDefinition<C> cloneWithReplacedDefinition(QName itemName,
                                                      ItemDefinition newDefinition)

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(QName name,
                                               QName typeName)

Creates new instance of property definition and adds it to the container.

This is the preferred method of creating a new definition.

Parameters:

name - name of the property (element name)

typeName - XSD type of the property

Returns:

created property definition

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(QName name,
                                               QName typeName,
                                               int minOccurs,
                                               int maxOccurs)

Creates new instance of property definition and adds it to the container.

This is the preferred method of creating a new definition.

Parameters:

name - name of the property (element name)

typeName - XSD type of the property

minOccurs - minimal number of occurrences

maxOccurs - maximal number of occurrences (-1 means unbounded)

Returns:

created property definition

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(QName name)

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(String localName,
                                               QName typeName)

Creates new instance of property definition and adds it to the container.

This is the preferred method of creating a new definition.

Parameters:

localName - name of the property (element name) relative to the schema namespace

typeName - XSD type of the property

Returns:

created property definition

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(String localName,
                                               String localTypeName)

Creates new instance of property definition and adds it to the container.

This is the preferred method of creating a new definition.

Parameters:

localName - name of the property (element name) relative to the schema namespace

localTypeName - XSD type of the property

Returns:

created property definition

createPropertyDefinition

public PrismPropertyDefinition createPropertyDefinition(String localName,
                                               String localTypeName,
                                               int minOccurs,
                                               int maxOccurs)

Creates new instance of property definition and adds it to the container.

This is the preferred method of creating a new definition.

Parameters:

localName - name of the property (element name) relative to the schema namespace

localTypeName - XSD type of the property

minOccurs - minimal number of occurrences

maxOccurs - maximal number of occurrences (-1 means unbounded)

Returns:

created property definition

createContainerDefinition

public PrismContainerDefinition createContainerDefinition(QName name,
                                                 QName typeName)

createContainerDefinition

public PrismContainerDefinition createContainerDefinition(QName name,
                                                 QName typeName,
                                                 int minOccurs,
                                                 int maxOccurs)

createContainerDefinition

public PrismContainerDefinition<C> createContainerDefinition(QName name,
                                                    ComplexTypeDefinition complexTypeDefinition,
                                                    int minOccurs,
                                                    int maxOccurs)

createValue

public PrismContainerValue<C> createValue()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class Definition

isEmpty

public boolean isEmpty()

getDebugDumpClassName

protected String getDebugDumpClassName()

Return a human readable name of this class suitable for logs.

Specified by:

getDebugDumpClassName in class Definition

getDocClassName

public String getDocClassName()

Description copied from class: Definition

Returns human-readable name of this class suitable for documentation. (e.g. "property")

Specified by:

getDocClassName in class Definition