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

Class PrismSchemaImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

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

All Implemented Interfaces:

Freezable, DefinitionSearchImplementation, DefinitionsStore, GlobalDefinitionsStore, PrismSchema, PrismSchema.PrismSchemaMutator, SchemaBuilder, SchemaLookup.Aware, SerializableSchema, DebugDumpable, Cloneable

Direct Known Subclasses:

ConnectorSchemaImpl, ResourceSchemaImpl

public class PrismSchemaImpl
extends SchemaRegistryStateAware
implements PrismSchema, PrismSchema.PrismSchemaMutator, SchemaBuilder, SerializableSchema

Author:

Radovan Semancik

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.schema.PrismSchema

PrismSchema.PrismSchemaMutator

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 final @NotNull PrismContextImpl	prismContext

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
PrismSchemaImpl(@NotNull String namespace)
PrismSchemaImpl(@NotNull String namespace, @Nullable Package compileTimePackage)

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull Definition def)	Adds any definition (item or type).
void	add(@NotNull Definition.DefinitionBuilder builder)	Adds the definition corresponding to provided builder - potentially incomplete - to the schema.
void	addDelayedItemDefinition(ItemDefinitionSupplier supplier)	Some containers cannot be added to the schema immediately, because their CTD is not yet parsed.
protected void	assertNoDelayedDefinitionsOnClone()
SchemaBuilder	builder()
PrismSchemaImpl	clone()
protected void	copyContent(PrismSchemaImpl target)
String	debugDump(int indent)
protected void	extendDebugDump(StringBuilder sb, 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)
TypeDefinition	findTypeDefinitionByType(@NotNull QName typeName)	Returns existing type definition (if there's one) in the schema being built.
<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)
Package	getCompileTimePackage()
@NotNull Collection<Definition>	getDefinitions()	Returns all definitions: both types and items.
<T extends Definition> @NotNull List<T>	getDefinitions(@NotNull Class<T> type)	Returns a collection of definitions of a given type.
@NotNull Collection<? extends SerializableDefinition>	getDefinitionsToSerialize()
@NotNull String	getNamespace()	All top-level definitions (types, items) are in this namespace.
String	getSourceDescription()
com.google.common.collect.Multimap<QName,ItemDefinition<?>>	getSubstitutions()
boolean	isRuntime()
PrismSchema.PrismSchemaMutator	mutator()
@NotNull ComplexTypeDefinition.ComplexTypeDefinitionLikeBuilder	newComplexTypeDefinitionLikeBuilder(String localTypeName)	Returns the builder for complex type definition; does not add anything to the schema (yet).
void	performFreeze()
protected @NotNull QName	qualify(@NotNull String localTypeName)
SchemaRegistryStateImpl	schemaLookup()	Return schemaRegistryState that will be used for resolving of schema.
@NotNull Document	serializeToXsd()
void	setRuntime(boolean runtime)
void	setSourceDescription(String sourceDescription)
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateAware

setSchemaLookup

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, findTypeDefinitionsByElementName, findTypeDefinitionsByType

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

getComplexTypeDefinitions, getObjectDefinitions, isEmpty, size

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

@NotNull
protected final @NotNull PrismContextImpl prismContext

Constructor Details

PrismSchemaImpl

public PrismSchemaImpl(@NotNull
 @NotNull String namespace)

PrismSchemaImpl

public PrismSchemaImpl(@NotNull
 @NotNull String namespace,
 @Nullable
 @Nullable Package compileTimePackage)

Method Details

getNamespace

@NotNull
public @NotNull String getNamespace()

Description copied from interface: PrismSchema

All top-level definitions (types, items) are in this namespace.

Specified by:

getNamespace in interface PrismSchema

Specified by:

getNamespace in interface SchemaBuilder

Specified by:

getNamespace in interface SerializableSchema

getDefinitions

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

Description copied from interface: PrismSchema

Returns all definitions: both types and items. Their order is insignificant. The collection is unmodifiable. The returned value should not be used for looking up specific definitions, as there may be thousands of them. Use more specific lookup methods instead.

Specified by:

getDefinitions in interface PrismSchema

getDefinitionsToSerialize

@NotNull
public @NotNull Collection<? extends SerializableDefinition> getDefinitionsToSerialize()

Specified by:

getDefinitionsToSerialize in interface SerializableSchema

getDefinitions

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

Description copied from interface: PrismSchema

Returns a collection of definitions of a given type. Similar to PrismSchema.getDefinitions().

Specified by:

getDefinitions in interface PrismSchema

addDelayedItemDefinition

public void addDelayedItemDefinition(ItemDefinitionSupplier supplier)

Description copied from interface: SchemaBuilder

Some containers cannot be added to the schema immediately, because their CTD is not yet parsed. This can occur when multiple schemas with circular dependencies are present. So we add them only after all the schemas are parsed.

Specified by:

addDelayedItemDefinition in interface SchemaBuilder

add

public void add(@NotNull
 @NotNull Definition def)

Description copied from interface: PrismSchema.PrismSchemaMutator

Adds any definition (item or type).

Specified by:

add in interface PrismSchema.PrismSchemaMutator

newComplexTypeDefinitionLikeBuilder

@NotNull
public @NotNull ComplexTypeDefinition.ComplexTypeDefinitionLikeBuilder newComplexTypeDefinitionLikeBuilder(String localTypeName)

Description copied from interface: SchemaBuilder

Returns the builder for complex type definition; does not add anything to the schema (yet). We use this one instead of simply creating a new ComplexTypeDefinition using the DefinitionFactory in order to be able to build non-prism definitions, i.e., ones that are not of Definition type.

Specified by:

newComplexTypeDefinitionLikeBuilder in interface SchemaBuilder

add

public void add(@NotNull
 @NotNull Definition.DefinitionBuilder builder)

Description copied from interface: SchemaBuilder

Adds the definition corresponding to provided builder - potentially incomplete - to the schema.

Specified by:

add in interface SchemaBuilder

builder

public SchemaBuilder builder()

Specified by:

builder in interface PrismSchema

getSubstitutions

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

Specified by:

getSubstitutions in interface PrismSchema

serializeToXsd

@NotNull
public @NotNull Document serializeToXsd()
                                 throws SchemaException

Specified by:

serializeToXsd in interface PrismSchema

Throws:

SchemaException

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

extendDebugDump

protected void extendDebugDump(StringBuilder sb,
 int indent)

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

public TypeDefinition findTypeDefinitionByType(@NotNull
 @NotNull QName typeName)

Description copied from interface: SchemaBuilder

Returns existing type definition (if there's one) in the schema being built. This is used when types can be referenced by other types, e.g., in the case of complex types. Its implementation is optional; currently, it is used only in genuine prism schemas.

Specified by:

findTypeDefinitionByType in interface GlobalDefinitionsStore

Specified by:

findTypeDefinitionByType in interface SchemaBuilder

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 SchemaRegistryStateAware

clone

public PrismSchemaImpl clone()

Overrides:

clone in class Object

mutator

public PrismSchema.PrismSchemaMutator mutator()

Specified by:

mutator in interface PrismSchema

copyContent

protected void copyContent(PrismSchemaImpl target)

assertNoDelayedDefinitionsOnClone

protected void assertNoDelayedDefinitionsOnClone()

qualify

@NotNull
protected @NotNull QName qualify(@NotNull
 @NotNull String localTypeName)

isRuntime

public boolean isRuntime()

Specified by:

isRuntime in interface PrismSchema

Specified by:

isRuntime in interface SchemaBuilder

setRuntime

public void setRuntime(boolean runtime)

Specified by:

setRuntime in interface SchemaBuilder

getSourceDescription

public String getSourceDescription()

Specified by:

getSourceDescription in interface PrismSchema

setSourceDescription

public void setSourceDescription(String sourceDescription)

getCompileTimePackage

public Package getCompileTimePackage()

schemaLookup

public SchemaRegistryStateImpl schemaLookup()

Description copied from class: SchemaRegistryStateAware

Return schemaRegistryState that will be used for resolving of schema. This method is used to move the variable to another class. For resolving of definition use SchemaRegistryStateAware.schemaLookup().

Specified by:

schemaLookup in interface SchemaLookup.Aware

Overrides:

schemaLookup in class SchemaRegistryStateAware

Returns:

SchemaRegistryState that can be used for resolving of schema