Package com.evolveum.midpoint.prism.schema

Interface PrismSchema

All Superinterfaces:
Cloneable, DebugDumpable, DefinitionSearchImplementation, DefinitionsStore, Freezable, GlobalDefinitionsStore
All Known Subinterfaces:
BareResourceSchema, CompleteResourceSchema, ConnectorSchema, ResourceSchema
All Known Implementing Classes:
BareResourceSchemaImpl, CompleteResourceSchemaImpl, ConnectorSchemaImpl, com.evolveum.midpoint.prism.impl.schema.PrismSchemaImpl, ResourceSchemaImpl
public interface PrismSchema extends DebugDumpable, GlobalDefinitionsStore, DefinitionSearchImplementation, Freezable, Cloneable
Schema as a collection of definitions. This is a midPoint-specific view of schema definition. It is just a collection of definitions grouped under a specific namespace. The schema and all the public classes in this package define a schema meta-model. It is supposed to be used for run-time schema interpretation. It will not be a convenient tool to work with static data model objects such as user or role. But it is needed for interpreting dynamic schemas for resource objects, extensions and so on.
Author:
semancik

  • Method Details

    • getNamespace

      @NotNull @NotNull String getNamespace()
      All top-level definitions (types, items) are in this namespace.

    • getDefinitions

      @NotNull @NotNull Collection<Definition> getDefinitions()
      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.

    • size

      default int size()
      Just a convenience method. Useful for diagnostics & tests.

    • isEmpty

      default boolean isEmpty()
      Just a convenience method. Primarily for tests.

    • getDefinitions

      @NotNull <T extends Definition> @NotNull List<T> getDefinitions(@NotNull @NotNull Class<T> type)
      Returns a collection of definitions of a given type. Similar to getDefinitions().

    • getObjectDefinitions

      @NotNull default @NotNull List<? extends PrismObjectDefinition<?>> getObjectDefinitions()

    • getComplexTypeDefinitions

      @NotNull default @NotNull List<ComplexTypeDefinition> getComplexTypeDefinitions()

    • serializeToXsd

      @NotNull @NotNull Document serializeToXsd() throws SchemaException
      Throws:
      SchemaException

    • getSubstitutions

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

    • isRuntime

      boolean isRuntime()

    • getSourceDescription

      String getSourceDescription()

    • mutator

      PrismSchema.PrismSchemaMutator mutator()

    • builder

      SchemaBuilder builder()