## com.saxonica.schema
Class PreparedSchema

    java.lang.Object
      com.saxonica.schema.SchemaStructure
          com.saxonica.schema.PreparedSchema

All Implemented Interfaces:
  Serializable, SourceLocator

Direct Known Subclasses:
  SchemaAwareConfiguration.SurrogateSchema

    public class PreparedSchema

extends SchemaStructure

A schema is a collection of schema components. It may be derived from a single schema document (an xs:schema element), in which case it contains those components defined in that schema document, the components defined in the included documents (expanded transitively), and the components defined in imported schema documents (not expanded transitively). Alternatively, it may be a collection of schema components derived from multiple independent schema documents.

See Also:
  Serialized Form

Constructor Summary
`PreparedSchema(SchemaAwareConfiguration config)` Create a new Schema definition

Method Summary
`void` `addAnonymousType(SchemaType type)` Register an anonymous type defined in this schema
`void` `addAttribute(AttributeDecl attribute)` Adds the given global attribute declaration to this Schema.
`void` `addAttributeGroup(AttributeGroupDecl attributeGroup)` Adds the given attribute group declaration to this Schema.
`void` `addComponent(UserSchemaComponent obj)` Add an object that might contain a forwards reference to be fixed up later
`void` `addElementDecl(ElementDecl elementDecl)` Adds the given global element declaration to this Schema definition
`void` `addGroup(ModelGroupDefinition group)` Adds the given group (xs:group) to this Schema.
`void` `addIdentityConstraint(IdentityConstraint constraint)` Add an identity constraint
`void` `addNotation(Notation notation)` Adds the given Notation declaration to this Schema defintion
`void` `addSimpleType(SimpleTypeDefinition simpleType)` Adds the given named SimpleType definition to this Schema.
`void` `addType(SchemaType type)` Adds the given type definition to this Schema.
`void` `copyTo(PreparedSchema destination, SchemaCompiler compiler)` Copy the components of this schema to another schema
`AttributeDecl` `getAttributeDecl(int fingerprint)` Get the attribute declaration with a given name if there is one.
`AttributeGroupDecl` `getAttributeGroup(int fingerprint)` Get the attribute declaration with a given name if there is one.
`SchemaAwareConfiguration` `getConfiguration()` Get the configuration
`ElementDecl` `getElementDecl(int fingerprint)` Get the global element declaration with a given name
`ModelGroupDefinition` `getGroup(int fingerprint)` Get the model group with a given name if there is one.
`IdentityConstraint` `getIdentityConstraint(int fingerprint)` Get the identity constraint whose name has a given fingerprint
`NamePool` `getNamePool()` Get the NamePool used by this schema
`Notation` `getNotation(int fingerprint)` Get the notation with a given name
`String` `getSchemaLocation()` Returns the schemaLocation hint provided for this schema
`SchemaType` `getSchemaType(int fingerprint)` Get the type with a given name if there is one.
`SimpleType` `getSimpleType(int fingerprint)` Get the simple type with a given name if there is one.
`String` `getTargetNamespace()` Returns the target namespace for this Schema, or "" if the schema is a no-namespace schema.
`SchemaType` `getType(int fingerprint)` Get type defined in this schema, searching both named and anonymous types
`String` `getVersion()` Returns the version information of the XML Schema definition represented by this Schema instance.
`Iterator` `iterateAttributeDeclarations()` Get an iterator over all the global attribute declarations defined in this schema
`Iterator` `iterateAttributeGroups()` Get an iterator over all the named attribute groups defined in this schema
`Iterator` `iterateElementDeclarations()` Get an iterator over all the global element declarations defined in this schema.
`Iterator` `iterateIdentityConstraints()` Get an iterator over all the identity constraints defined in this schema (that is, unique, key, and keyref components).
`Iterator` `iterateModelGroups()` Get an iterator over all the named model groups defined in this schema
`Iterator` `iterateNotations()` Get an iterator over all the notations defined in this schema.
`Iterator` `iterateTypes()` Get an iterator over all the named simple and complex types defined in this schema.
`static PreparedSchema` `merge(PreparedSchema ps1, PreparedSchema ps2)` Merge two PreparedSchemas into one, rejecting any components that are defined in both.
`void` `setConfiguration(SchemaAwareConfiguration config)` Set the configuration
`void` `setSchemaLocation(String schemaLocation)` Set the schemaLocation for this schema.
`void` `setTargetNamespace(String targetNamespace)` Sets the target namespace for this Schema
`void` `setVersion(String version)` Sets the version information for the XML Schema defintion represented by this Schema instance.
`boolean` `validate(SchemaCompiler compiler)` Checks the validity of this Schema definition, and if valid, adds the schema to the cache held by the SchemaAwareConfiguration
`static SchemaComponent` `validateReference(ComponentReference ref, SchemaCompiler compiler)` Helper method to validate that a reference to a schema component can be resolved

Methods inherited from class com.saxonica.schema.SchemaStructure
`getColumnNumber, getFixupStatus, getLineNumber, getPublicId, getSystemId, getValidationStatus, lookForCycles, setFixupStatus, setLineNumber, setLocator, setSystemId, setValidationStatus`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### PreparedSchema

    public PreparedSchema(SchemaAwareConfiguration config)

  Create a new Schema definition

  Parameters:
    `config` - The configuration object holding system configuration information

Method Detail

### setConfiguration

    public void setConfiguration(SchemaAwareConfiguration config)

  Set the configuration

  Overrides:
    `setConfiguration` in class `SchemaStructure`

### getConfiguration

    public SchemaAwareConfiguration getConfiguration()

  Get the configuration

  Overrides:
    `getConfiguration` in class `SchemaStructure`

### addComponent

    public void addComponent(UserSchemaComponent obj)

  Add an object that might contain a forwards reference to be fixed up later

### getAttributeDecl

    public AttributeDecl getAttributeDecl(int fingerprint)

  Get the attribute declaration with a given name if there is one.

  Returns:
    the attribute declaration if found, or null otherwise

### iterateAttributeDeclarations

    public Iterator iterateAttributeDeclarations()

  Get an iterator over all the global attribute declarations defined in this schema

  Returns:
    an iterator over the attribute declarations. Each item returned by the iterator will be an instance of `AttributeDecl`

### addAttribute

    public void addAttribute(AttributeDecl attribute)

  Adds the given global attribute declaration to this Schema. It will overwrite any existing attribute declaration with the same name.

  Parameters:
    `attribute` - the AttributeDecl to add

### getAttributeGroup

    public AttributeGroupDecl getAttributeGroup(int fingerprint)

  Get the attribute declaration with a given name if there is one.

  Returns:
    the attribute declaration if found, or null otherwise

### iterateAttributeGroups

    public Iterator iterateAttributeGroups()

  Get an iterator over all the named attribute groups defined in this schema

  Returns:
    an iterator over the attribute groups. Each item returned by the iterator will be an instance of `AttributeGroupDecl`

### addAttributeGroup

    public void addAttributeGroup(AttributeGroupDecl attributeGroup)

  Adds the given attribute group declaration to this Schema. It will overwrite any existing attribute group declaration with the same name.

  Parameters:
    `attributeGroup` - the AttributeDecl to add

### getGroup

    public ModelGroupDefinition getGroup(int fingerprint)

  Get the model group with a given name if there is one.

  Returns:
    the group if found, or null otherwise

### iterateModelGroups

    public Iterator iterateModelGroups()

  Get an iterator over all the named model groups defined in this schema

  Returns:
    an iterator over the model groups. Each item returned by the iterator will be an instance of `ModelGroupDefinition`

### addGroup

    public void addGroup(ModelGroupDefinition group)

  Adds the given group (xs:group) to this Schema. It will overwrite any existing group with the same name.

  Parameters:
    `group` - the group to add

### getSchemaType

    public SchemaType getSchemaType(int fingerprint)

  Get the type with a given name if there is one. This method will also find built-in types.

  Returns:
    the named simple or complex type if found, or null otherwise

### getSimpleType

    public SimpleType getSimpleType(int fingerprint)

  Get the simple type with a given name if there is one. This method will also find built-in types.

  Returns:
    the simple type if found, or null otherwise

### iterateTypes

    public Iterator iterateTypes()

  Get an iterator over all the named simple and complex types defined in this schema. This iterator will not include built-in types or anonymous types.

  Returns:
    an iterator over the types. Each item returned by the iterator will be an instance of `SchemaType`

### addType

    public void addType(SchemaType type)

  Adds the given type definition to this Schema. If another type with this name already exists, it is overwritten.

  Parameters:
    `type` - the type to add to this Schema

### addAnonymousType

    public void addAnonymousType(SchemaType type)

  Register an anonymous type defined in this schema

### getType

    public SchemaType getType(int fingerprint)

  Get type defined in this schema, searching both named and anonymous types

### addElementDecl

    public void addElementDecl(ElementDecl elementDecl)
                        throws SchemaException

  Adds the given global element declaration to this Schema definition

  Parameters:
    `elementDecl` - the ElementDecl to add to this Schema
  Throws:
    `SchemaException`

### getElementDecl

    public ElementDecl getElementDecl(int fingerprint)

  Get the global element declaration with a given name

  Parameters:
    `fingerprint` - identifies the name of the element
  Returns:
    the element declaration, or null if not found.

### iterateElementDeclarations

    public Iterator iterateElementDeclarations()

  Get an iterator over all the global element declarations defined in this schema.

  Returns:
    an iterator over the global element declarations. Each item returned by the iterator will be an instance of `ElementDecl`

### addNotation

    public void addNotation(Notation notation)
                     throws SchemaException

  Adds the given Notation declaration to this Schema defintion

  Parameters:
    `notation` - the Notation to add to this Schema
  Throws:
    `SchemaException`

### getNotation

    public Notation getNotation(int fingerprint)

  Get the notation with a given name

  Parameters:
    `fingerprint` - identifies the name of the notation
  Returns:
    the element notation, or null if not found.

### iterateNotations

    public Iterator iterateNotations()

  Get an iterator over all the notations defined in this schema.

  Returns:
    an iterator over the notations. Each item returned by the iterator will be an instance of `Notation`

### addSimpleType

    public void addSimpleType(SimpleTypeDefinition simpleType)
                       throws SchemaException

  Adds the given named SimpleType definition to this Schema. If another simpleType with the same name already exists, it is overwritten.

  Parameters:
    `simpleType` - the SimpleType to add to this Schema
  Throws:
    `SchemaException` - if the SimpleType does not have a name

### addIdentityConstraint

    public void addIdentityConstraint(IdentityConstraint constraint)

  Add an identity constraint

### getIdentityConstraint

    public IdentityConstraint getIdentityConstraint(int fingerprint)

  Get the identity constraint whose name has a given fingerprint

  Returns:
    the identity constraint, or null if there is none with that name

### iterateIdentityConstraints

    public Iterator iterateIdentityConstraints()

  Get an iterator over all the identity constraints defined in this schema (that is, unique, key, and keyref components).

  Returns:
    an iterator over the identity constraints. Each item returned by the iterator will be an instance of `IdentityConstraint`

### getTargetNamespace

    public String getTargetNamespace()

  Returns the target namespace for this Schema, or "" if the schema is a no-namespace schema.

  Returns:
    the target namespace for this Schema, or "" if the schema is a no-namespace schema. Returns null if the schema was not derived directly from a single schema document (plus its imports and includes)

### getVersion

    public String getVersion()

  Returns the version information of the XML Schema definition represented by this Schema instance.

  Returns:
    the version information of the XML Schema definition, or null if no version information exists.

### getNamePool

    public NamePool getNamePool()

  Get the NamePool used by this schema

### getSchemaLocation

    public String getSchemaLocation()

  Returns the schemaLocation hint provided for this schema

  Returns:
    the schemaLocation hint provided for this schema. This will be null unless the PreparedSchema was built by parsing a schema document at a particular location.

### setSchemaLocation

    public void setSchemaLocation(String schemaLocation)

  Set the schemaLocation for this schema. This is useful when this schema has been imported by another schema

  Parameters:
    `schemaLocation` - the location hint for this Schema

### setTargetNamespace

    public void setTargetNamespace(String targetNamespace)

  Sets the target namespace for this Schema

  Parameters:
    `targetNamespace` - the target namespace for this Schema
  See Also:
    § 2.7 XML Schema Part 1: Structures

### setVersion

    public void setVersion(String version)

  Sets the version information for the XML Schema defintion represented by this Schema instance.

  Parameters:
    `version` - the version for this XML Schema defination.

### copyTo

    public void copyTo(PreparedSchema destination,
                       SchemaCompiler compiler)
                throws SchemaException

  Copy the components of this schema to another schema

  Parameters:
    `destination` - the destination of the copy
  Throws:
    `SchemaException` - if there are name clashes between this schema and the destination schema

### validate

    public boolean validate(SchemaCompiler compiler)
                     throws SchemaException,
                            ValidationException

  Checks the validity of this Schema definition, and if valid, adds the schema to the cache held by the SchemaAwareConfiguration

  Parameters:
    `compiler` - a SchemaCompiler to which all errors should be reported
  Throws:
    `SchemaException` - if the SchemaCompiler decides that an error is fatal
    `ValidationException`

### validateReference

    public static SchemaComponent validateReference(ComponentReference ref,
                                                    SchemaCompiler compiler)
                                             throws SchemaException

  Helper method to validate that a reference to a schema component can be resolved

  Throws:
    `SchemaException`

### merge

    public static PreparedSchema merge(PreparedSchema ps1,
                                       PreparedSchema ps2)
                                throws SchemaException

  Merge two PreparedSchemas into one, rejecting any components that are defined in both.

  Parameters:
    `ps1` - the first PreparedSchema
    `ps2` - the second PreparedSchema
  Returns:
    the merged PreparedSchema
  Throws:
    `SchemaException`

Copyright (C) Michael H. Kay. All rights reserved.