Package com.evolveum.midpoint.prism.schema

Interface SchemaRegistry

All Superinterfaces:

DebugDumpable, DefinitionsStore, GlobalDefinitionsStore

All Known Implementing Classes:

SchemaRegistryImpl

public interface SchemaRegistry
extends DebugDumpable, GlobalDefinitionsStore

Author:

mederly

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SchemaRegistry.ComparisonResult

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
<T extends Objectable> void	applyDefinition(ObjectDelta<T> objectDelta, Class<T> type, boolean force)
<C extends Containerable> void	applyDefinition(PrismContainer<C> container, Class<C> type)	This method will try to locate the appropriate object definition and apply it.
<C extends Containerable> void	applyDefinition(PrismContainer<C> prismObject, Class<C> type, boolean force)
<C extends Containerable,O extends Objectable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, Class<O> type, ItemPath path, boolean force)
<C extends Containerable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, QName typeName, ItemPath path, boolean force)
boolean	areComparable(QName type1, QName type2)
<ID extends ItemDefinition> SchemaRegistry.ComparisonResult	compareDefinitions(ID def1, ID def2)
ItemDefinition<?>	createAdHocDefinition(QName elementName, QName typeName, int minOccurs, int maxOccurs)
Class<?>	determineClassForItemDefinition(ItemDefinition<?> itemDefinition)
<T> Class<T>	determineClassForType(QName type)
<T> Class<T>	determineCompileTimeClass(QName typeName)
PrismObjectDefinition	determineDefinitionFromClass(Class type)
ComplexTypeDefinition	determineParentDefinition(ComplexTypeDefinition child, ItemPath rest)
PrismObjectDefinition	determineReferencedObjectDefinition(QName targetTypeName, ItemPath rest)
QName	determineTypeForClass(Class<?> clazz)	Tries to determine type name for any class (primitive, complex one).
ItemDefinition	findItemDefinitionByElementName(QName elementName, List<String> ignoredNamespaces)
<T extends ItemDefinition> T	findItemDefinitionByFullPath(Class<? extends Objectable> objectClass, Class<T> defClass, QName... itemNames)
PrismSchema	findSchemaByCompileTimeClass(Class<?> compileTimeClass)
PrismSchema	findSchemaByNamespace(String namespaceURI)
PrismSchema	findSchemaByPrefix(String prefix)
SchemaDescription	findSchemaDescriptionByNamespace(String namespaceURI)
SchemaDescription	findSchemaDescriptionByPrefix(String prefix)
<TD extends TypeDefinition> Collection<TD>	findTypeDefinitionsByElementName(QName name, Class<TD> clazz)
<T> Class<T>	getCompileTimeClass(QName xsdType)
Class<? extends ObjectType>	getCompileTimeClassForObjectType(QName objectType)
Collection<Package>	getCompileTimePackages()
String	getDefaultNamespace()
Schema	getJavaxSchema()
DynamicNamespacePrefixMapper	getNamespacePrefixMapper()
PrismContext	getPrismContext()
PrismSchema	getPrismSchema(String namespace)
Collection<SchemaDescription>	getSchemaDescriptions()
Collection<PrismSchema>	getSchemas()
boolean	hasImplicitTypeDefinition(QName itemName, QName typeName)
void	initialize()
<T extends Objectable> PrismObject<T>	instantiate(Class<T> compileTimeClass)	Deprecated.
boolean	isAssignableFrom(QName superType, QName subType)
boolean	isContainer(QName typeName)
ItemDefinition	locateItemDefinition(QName itemName, ComplexTypeDefinition complexTypeDefinition, Function<QName,ItemDefinition> dynamicDefinitionResolver)
QName	qualifyTypeName(QName typeName)
ItemDefinition	resolveGlobalItemDefinition(QName itemName, ComplexTypeDefinition complexTypeDefinition)
ItemDefinition	resolveGlobalItemDefinition(QName elementQName, PrismContainerDefinition<?> containerDefinition)	Deprecated.
QName	resolveUnqualifiedTypeName(QName type)
<ID extends ItemDefinition> ID	selectMoreSpecific(ID def1, ID def2)
QName	selectMoreSpecific(QName type1, QName type2)
QName	unifyTypes(QName type1, QName type2)	Returns most specific common supertype for these two.

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

findComplexTypeDefinition, findComplexTypeDefinitionByCompileTimeClass, findComplexTypeDefinitionByType, findContainerDefinitionByCompileTimeClass, findContainerDefinitionByElementName, findContainerDefinitionByType, findItemDefinition, findItemDefinition, findItemDefinitionByCompileTimeClass, findItemDefinitionByElementName, findItemDefinitionByElementName, findItemDefinitionByType, findItemDefinitionByType, findItemDefinitionsByCompileTimeClass, findItemDefinitionsByElementName, findItemDefinitionsByElementName, findObjectDefinitionByCompileTimeClass, findObjectDefinitionByElementName, findObjectDefinitionByType, findPropertyDefinitionByElementName, findReferenceDefinitionByElementName, findSimpleTypeDefinitionByType, findTypeDefinitionByCompileTimeClass, findTypeDefinitionByType, findTypeDefinitionByType, findTypeDefinitionsByType, findTypeDefinitionsByType

Method Detail

getNamespacePrefixMapper

DynamicNamespacePrefixMapper getNamespacePrefixMapper()

getPrismContext

PrismContext getPrismContext()

getDefaultNamespace

String getDefaultNamespace()

initialize

void initialize()
         throws SAXException,
                IOException,
                SchemaException

Throws:

SAXException

IOException

SchemaException

getJavaxSchema

Schema getJavaxSchema()

getPrismSchema

PrismSchema getPrismSchema(String namespace)

getSchemas

Collection<PrismSchema> getSchemas()

getSchemaDescriptions

Collection<SchemaDescription> getSchemaDescriptions()

getCompileTimePackages

Collection<Package> getCompileTimePackages()

locateItemDefinition

ItemDefinition locateItemDefinition(@NotNull
                                    QName itemName,
                                    @Nullable
                                    ComplexTypeDefinition complexTypeDefinition,
                                    @Nullable
                                    Function<QName,ItemDefinition> dynamicDefinitionResolver)
                             throws SchemaException

Throws:

SchemaException

resolveUnqualifiedTypeName

QName resolveUnqualifiedTypeName(QName type)
                          throws SchemaException

Throws:

SchemaException

qualifyTypeName

QName qualifyTypeName(QName typeName)
               throws SchemaException

Throws:

SchemaException

determineParentDefinition

ComplexTypeDefinition determineParentDefinition(@NotNull
                                                ComplexTypeDefinition child,
                                                @NotNull
                                                ItemPath rest)

determineReferencedObjectDefinition

PrismObjectDefinition determineReferencedObjectDefinition(@NotNull
                                                          QName targetTypeName,
                                                          ItemPath rest)

getCompileTimeClassForObjectType

Class<? extends ObjectType> getCompileTimeClassForObjectType(QName objectType)

findItemDefinitionByElementName

ItemDefinition findItemDefinitionByElementName(QName elementName,
                                               @Nullable
                                               List<String> ignoredNamespaces)

determineCompileTimeClass

<T> Class<T> determineCompileTimeClass(QName typeName)

getCompileTimeClass

<T> Class<T> getCompileTimeClass(QName xsdType)

findSchemaByCompileTimeClass

PrismSchema findSchemaByCompileTimeClass(@NotNull
                                         Class<?> compileTimeClass)

determineTypeForClass

QName determineTypeForClass(Class<?> clazz)

Tries to determine type name for any class (primitive, complex one). Does not use schemas (TODO explanation)

Parameters:

clazz -

Returns:

applyDefinition

<C extends Containerable> void applyDefinition(PrismContainer<C> container,
                                               Class<C> type)
                                        throws SchemaException

This method will try to locate the appropriate object definition and apply it.

Parameters:

container -

type -

Throws:

SchemaException

applyDefinition

<C extends Containerable> void applyDefinition(PrismContainer<C> prismObject,
                                               Class<C> type,
                                               boolean force)
                                        throws SchemaException

Throws:

SchemaException

applyDefinition

<T extends Objectable> void applyDefinition(ObjectDelta<T> objectDelta,
                                            Class<T> type,
                                            boolean force)
                                     throws SchemaException

Throws:

SchemaException

applyDefinition

<C extends Containerable,O extends Objectable> void applyDefinition(PrismContainerValue<C> prismContainerValue,
                                                                          Class<O> type,
                                                                          ItemPath path,
                                                                          boolean force)
                                                                   throws SchemaException

Throws:

SchemaException

applyDefinition

<C extends Containerable> void applyDefinition(PrismContainerValue<C> prismContainerValue,
                                               QName typeName,
                                               ItemPath path,
                                               boolean force)
                                        throws SchemaException

Throws:

SchemaException

findItemDefinitionByFullPath

<T extends ItemDefinition> T findItemDefinitionByFullPath(Class<? extends Objectable> objectClass,
                                                          Class<T> defClass,
                                                          QName... itemNames)
                                                   throws SchemaException

Throws:

SchemaException

findSchemaByNamespace

PrismSchema findSchemaByNamespace(String namespaceURI)

findSchemaDescriptionByNamespace

SchemaDescription findSchemaDescriptionByNamespace(String namespaceURI)

findSchemaByPrefix

PrismSchema findSchemaByPrefix(String prefix)

findSchemaDescriptionByPrefix

SchemaDescription findSchemaDescriptionByPrefix(String prefix)

determineDefinitionFromClass

PrismObjectDefinition determineDefinitionFromClass(Class type)

hasImplicitTypeDefinition

boolean hasImplicitTypeDefinition(@NotNull
                                  QName itemName,
                                  @NotNull
                                  QName typeName)

resolveGlobalItemDefinition

@Deprecated
ItemDefinition resolveGlobalItemDefinition(QName elementQName,
                                           PrismContainerDefinition<?> containerDefinition)
                                    throws SchemaException

Deprecated.

Throws:

SchemaException

resolveGlobalItemDefinition

ItemDefinition resolveGlobalItemDefinition(QName itemName,
                                           @Nullable
                                           ComplexTypeDefinition complexTypeDefinition)
                                    throws SchemaException

Throws:

SchemaException

instantiate

@Deprecated
<T extends Objectable> PrismObject<T> instantiate(Class<T> compileTimeClass)
                                           throws SchemaException

Deprecated.

Throws:

SchemaException

determineClassForType

<T> Class<T> determineClassForType(QName type)

determineClassForItemDefinition

Class<?> determineClassForItemDefinition(ItemDefinition<?> itemDefinition)

selectMoreSpecific

<ID extends ItemDefinition> ID selectMoreSpecific(ID def1,
                                                  ID def2)
                                           throws SchemaException

Throws:

SchemaException

selectMoreSpecific

QName selectMoreSpecific(QName type1,
                         QName type2)
                  throws SchemaException

Throws:

SchemaException

areComparable

boolean areComparable(QName type1,
                      QName type2)
               throws SchemaException

Throws:

SchemaException

isContainer

boolean isContainer(QName typeName)

findTypeDefinitionsByElementName

@NotNull
<TD extends TypeDefinition> Collection<TD> findTypeDefinitionsByElementName(@NotNull
                                                                            QName name,
                                                                            @NotNull
                                                                            Class<TD> clazz)

compareDefinitions

<ID extends ItemDefinition> SchemaRegistry.ComparisonResult compareDefinitions(@NotNull
                                                                               ID def1,
                                                                               @NotNull
                                                                               ID def2)
                                                                        throws SchemaException

Returns:

null means we cannot decide (types are different, and no compile time class for def1 and/or def2)

Throws:

SchemaException

isAssignableFrom

boolean isAssignableFrom(@NotNull
                         QName superType,
                         @NotNull
                         QName subType)

unifyTypes

QName unifyTypes(QName type1,
                 QName type2)

Returns most specific common supertype for these two. If any of input params is null, it means it is ignored

Returns:

null if unification cannot be done (or if both input types are null)

createAdHocDefinition

ItemDefinition<?> createAdHocDefinition(QName elementName,
                                        QName typeName,
                                        int minOccurs,
                                        int maxOccurs)