Package com.evolveum.midpoint.prism.impl.schema

Class PrismSchemaImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.schema.PrismSchemaImpl

All Implemented Interfaces:

Freezable, PrismContextSensitive, DefinitionSearchImplementation, DefinitionsStore, GlobalDefinitionsStore, MutablePrismSchema, PrismSchema, DebugDumpable, Cloneable

Direct Known Subclasses:

ConnectorSchemaImpl, ResourceSchemaImpl

public class PrismSchemaImpl
extends AbstractFreezable
implements MutablePrismSchema

Author:

Radovan Semancik

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull Collection<Definition>	definitions
protected final @NotNull String	namespace	Namespace for items defined in this schema.
protected PrismContext	prismContext

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismSchemaImpl(@NotNull String namespace)

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull Definition def)
void	addDelayedItemDefinition(DefinitionSupplier supplier)
void	addSubstitution(QName substitutionHead, ItemDefinition<?> definition)
protected void	assertNoDelayedDefinitionsOnClone()
PrismSchemaImpl	clone()
protected void	copyContent(PrismSchemaImpl target)
ComplexTypeDefinition	createComplexTypeDefinition(QName typeName)
MutablePrismContainerDefinition<?>	createContainerDefinition(String localTypeName)	Creates a new property container definition and adds it to the schema.
MutablePrismContainerDefinition<?>	createContainerDefinition(String localItemName, String localTypeName)
PrismPropertyDefinition<?>	createPropertyDefinition(String localName, QName typeName)	Creates a top-level property definition and adds it to the schema.
PrismPropertyDefinition<?>	createPropertyDefinition(QName name, QName typeName)	Creates a top-level property definition and adds it to the schema.
String	debugDump(int indent)
<C extends Containerable> ComplexTypeDefinition	findComplexTypeDefinitionByCompileTimeClass(@NotNull Class<C> compileTimeClass)
<ID extends ItemDefinition> ID	findItemDefinitionByType(@NotNull QName typeName, @NotNull Class<ID> definitionClass)	Looking up item definition by type name.
<ID extends ItemDefinition> @NotNull List<ID>	findItemDefinitionsByCompileTimeClass(@NotNull Class<?> compileTimeClass, @NotNull Class<ID> definitionClass)	Looking up item definitions by compile-time class.
<ID extends ItemDefinition> @NotNull List<ID>	findItemDefinitionsByElementName(@NotNull QName elementName, @NotNull Class<ID> definitionClass)	Looking up item definitions by element name.
<TD extends TypeDefinition> TD	findTypeDefinitionByCompileTimeClass(@NotNull Class<?> compileTimeClass, @NotNull Class<TD> definitionClass)
<TD extends TypeDefinition> TD	findTypeDefinitionByType(@NotNull QName typeName, @NotNull Class<TD> definitionClass)
<TD extends TypeDefinition> @NotNull Collection<TD>	findTypeDefinitionsByType(@NotNull QName typeName, @NotNull Class<TD> definitionClass)
@NotNull Collection<Definition>	getDefinitions()	Returns set of definitions.
<T extends Definition> @NotNull List<T>	getDefinitions(@NotNull Class<T> type)	Returns set of definitions of a given type.
@NotNull String	getNamespace()	Returns schema namespace.
PrismContext	getPrismContext()
com.google.common.collect.Multimap<QName,ItemDefinition<?>>	getSubstitutions()
boolean	isEmpty()
static PrismSchema	parse(Element element, boolean isRuntime, String shortDescription, PrismContext prismContext)
static PrismSchema	parse(Element element, EntityResolver resolver, boolean isRuntime, String shortDescription, boolean allowDelayedItemDefinitions, PrismContext prismContext)
void	parseThis(Element element, boolean isRuntime, String shortDescription, PrismContext prismContext)
void	performFreeze()
void	registerCompileTimeClass(Class<?> compileTimeClass, TypeDefinition typeDefinition)
@NotNull Document	serializeToXsd()
String	toString()

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

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.schema.GlobalDefinitionsStore

findComplexTypeDefinitionByType, findContainerDefinitionByCompileTimeClass, findContainerDefinitionByElementName, findContainerDefinitionByType, findItemDefinitionByCompileTimeClass, findItemDefinitionByElementName, findItemDefinitionByElementName, findItemDefinitionByType, findItemDefinitionsByElementName, findObjectDefinitionByCompileTimeClass, findObjectDefinitionByElementName, findObjectDefinitionByType, findPropertyDefinitionByElementName, findReferenceDefinitionByElementName, findSimpleTypeDefinitionByType, findTypeDefinitionByType, findTypeDefinitionsByType

Methods inherited from interface com.evolveum.midpoint.prism.schema.PrismSchema

getComplexTypeDefinitions, getObjectDefinitions

Field Details

definitions

@NotNull
protected final @NotNull Collection<Definition> definitions

namespace

@NotNull
protected final @NotNull String namespace

Namespace for items defined in this schema.

prismContext

protected PrismContext prismContext

Constructor Details

PrismSchemaImpl

public PrismSchemaImpl(@NotNull
 @NotNull String namespace)

Method Details

getNamespace

@NotNull
public @NotNull String getNamespace()

Description copied from interface: PrismSchema

Returns schema namespace. All schema definitions are placed in the returned namespace.

Specified by:

getNamespace in interface PrismSchema

Returns:

schema namespace

getDefinitions

@NotNull
public @NotNull Collection<Definition> getDefinitions()

Description copied from interface: PrismSchema

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

Specified by:

getDefinitions in interface PrismSchema

Returns:

set of definitions

getDefinitions

@NotNull
public <T extends Definition> @NotNull List<T> getDefinitions(@NotNull
 @NotNull Class<T> type)

Description copied from interface: PrismSchema

Returns set of definitions of a given type. The set contains all definitions of the given type that were parsed. Order of definitions is insignificant.

Specified by:

getDefinitions in interface PrismSchema

Returns:

set of definitions

addDelayedItemDefinition

public void addDelayedItemDefinition(DefinitionSupplier supplier)

Specified by:

addDelayedItemDefinition in interface MutablePrismSchema

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface PrismSchema

add

public void add(@NotNull
 @NotNull Definition def)

Specified by:

add in interface MutablePrismSchema

registerCompileTimeClass

public void registerCompileTimeClass(Class<?> compileTimeClass,
 TypeDefinition typeDefinition)

Specified by:

registerCompileTimeClass in interface MutablePrismSchema

addSubstitution

public void addSubstitution(QName substitutionHead,
 ItemDefinition<?> definition)

Specified by:

addSubstitution in interface MutablePrismSchema

getSubstitutions

public com.google.common.collect.Multimap<QName,ItemDefinition<?>> getSubstitutions()

Specified by:

getSubstitutions in interface PrismSchema

getPrismContext

public PrismContext getPrismContext()

Specified by:

getPrismContext in interface PrismContextSensitive

parse

public static PrismSchema parse(Element element,
 boolean isRuntime,
 String shortDescription,
 PrismContext prismContext)
                         throws SchemaException

Throws:

SchemaException

parse

public static PrismSchema parse(Element element,
 EntityResolver resolver,
 boolean isRuntime,
 String shortDescription,
 boolean allowDelayedItemDefinitions,
 PrismContext prismContext)
                         throws SchemaException

Throws:

SchemaException

parseThis

public void parseThis(Element element,
 boolean isRuntime,
 String shortDescription,
 PrismContext prismContext)
               throws SchemaException

Specified by:

parseThis in interface MutablePrismSchema

Throws:

SchemaException

serializeToXsd

@NotNull
public @NotNull Document serializeToXsd()
                                 throws SchemaException

Specified by:

serializeToXsd in interface PrismSchema

Throws:

SchemaException

createContainerDefinition

public MutablePrismContainerDefinition<?> createContainerDefinition(String localTypeName)

Creates a new property container definition and adds it to the schema. This is a preferred way how to create definition in the schema.

Specified by:

createContainerDefinition in interface MutablePrismSchema

Parameters:

localTypeName - type name "relative" to schema namespace

Returns:

new property container definition

createContainerDefinition

public MutablePrismContainerDefinition<?> createContainerDefinition(String localItemName,
 String localTypeName)

Specified by:

createContainerDefinition in interface MutablePrismSchema

createComplexTypeDefinition

public ComplexTypeDefinition createComplexTypeDefinition(QName typeName)

Specified by:

createComplexTypeDefinition in interface MutablePrismSchema

createPropertyDefinition

public PrismPropertyDefinition<?> createPropertyDefinition(String localName,
 QName typeName)

Creates a top-level property definition and adds it to the schema. This is a preferred way how to create definition in the schema.

Specified by:

createPropertyDefinition in interface MutablePrismSchema

Parameters:

localName - element name "relative" to schema namespace

typeName - XSD type name of the element

Returns:

new property definition

createPropertyDefinition

public PrismPropertyDefinition<?> createPropertyDefinition(QName name,
 QName typeName)

Creates a top-level property definition and adds it to the schema. This is a preferred way how to create definition in the schema.

Specified by:

createPropertyDefinition in interface MutablePrismSchema

Parameters:

name - element name

typeName - XSD type name of the element

Returns:

new property definition

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

toString

public String toString()

Overrides:

toString in class Object

findItemDefinitionsByCompileTimeClass

@NotNull
public <ID extends ItemDefinition>
@NotNull List<ID> findItemDefinitionsByCompileTimeClass(@NotNull
 @NotNull Class<?> compileTimeClass,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definitions by compile-time class. So, for example having AssignmentType.class we try to find a definition of "assignment" item. BEWARE. This method is unsound. There might be many items of AssignmentType.class.

Specified by:

findItemDefinitionsByCompileTimeClass in interface GlobalDefinitionsStore

findItemDefinitionByType

public <ID extends ItemDefinition> ID findItemDefinitionByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definition by type name. So, for example having c:AssignmentType we try to find a definition of "assignment" item. BEWARE. This method is unsound. There might be many items with c:AssignmentType type.

Specified by:

findItemDefinitionByType in interface GlobalDefinitionsStore

findItemDefinitionsByElementName

@NotNull
public <ID extends ItemDefinition>
@NotNull List<ID> findItemDefinitionsByElementName(@NotNull
 @NotNull QName elementName,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definitions by element name. The name can be qualified or unqualified. In the latter case there can be more than one definition returned.

Specified by:

findItemDefinitionsByElementName in interface GlobalDefinitionsStore

findComplexTypeDefinitionByCompileTimeClass

public <C extends Containerable>
ComplexTypeDefinition findComplexTypeDefinitionByCompileTimeClass(@NotNull
 @NotNull Class<C> compileTimeClass)

Specified by:

findComplexTypeDefinitionByCompileTimeClass in interface GlobalDefinitionsStore

findTypeDefinitionByType

@Nullable
public <TD extends TypeDefinition> TD findTypeDefinitionByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionByType in interface GlobalDefinitionsStore

findTypeDefinitionsByType

@NotNull
public <TD extends TypeDefinition>
@NotNull Collection<TD> findTypeDefinitionsByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionsByType in interface GlobalDefinitionsStore

findTypeDefinitionByCompileTimeClass

@Nullable
public <TD extends TypeDefinition> TD findTypeDefinitionByCompileTimeClass(@NotNull
 @NotNull Class<?> compileTimeClass,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionByCompileTimeClass in interface GlobalDefinitionsStore

performFreeze

public void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

clone

public PrismSchemaImpl clone()

Overrides:

clone in class Object

copyContent

protected void copyContent(PrismSchemaImpl target)

assertNoDelayedDefinitionsOnClone

protected void assertNoDelayedDefinitionsOnClone()