Package com.saxonica.ee.schema


package com.saxonica.ee.schema

This package contains classes used to represent the information in a schema, that is, the schema components. The model is closely related to the schema component model defined in the XSD specifications, but not identical in every respect. The actual use of a schema for validating instance documents is in package com.saxonica.ee.validate.

Representing the schema itself is the class PreparedSchema. All the schemas that have been imported into the application are linked from the Configuration object; they thus outlive a single transformation or query. Other important classes have intuitive names, for example ComplexType, SimpleType, ElementDecl, and AttributeDecl.

Schema components in Saxon are always built from schema documents, so the classes representing objects in the schema are constructed using the corresponding classes in the com.saxonica.ee.schema.sdoc package. (There is an exception to this: schema components can also be exported to an SCM file, and subsequently re-imported from this file.)

The schema class obtained by the Configuration.getSuperSchema() method represents the collection of all loaded schemas. There can only be one active collection of schema components for any one namespace. This means it is not possible to use two unrelated no-namespace schemas concurrently, or two different versions of a schema for the same namespace.

Named types, element declarations, and attribute declarations are indexed directly from the NamePool. It is not necessary first to locate the schema in which they are contained, they can be found directly using the namePool fingerprint of their expanded QName.

The schema model retains nearly all the information in the source schema: the notable omission is annotations.

The API for this package is particular to Saxon, though it is influenced by the definition of schema components in the XSD specification. At some time in the future it is possible that it may be replaced by an API conforming to externally-defined standards.

  • Class
    Description
    An AllModelGroup represents an xs:all element in the schema
    An Assertion schema component (See XML Schema 1.1 Part 1)
    Represents an assertion facet on a schema-defined simple type.
    An XML Schema Attribute Declaration.
    An XML Schema Attribute Group Declaration.
    An XML Schema Attribute Group Reference, corresponding to an xs:attributeGroup element with a 'ref' attribute.
    An XML Schema Attribute Use: that is, a reference to an attribute declaration from within a complex type or attribute group.
    This class represents an xs:anyAttribute element in the schema.
    A ChoiceCompositor represents an xs:choice element in the schema
    A reference to a schema component.
    Interface for Element Declaration, Attribute Declaration and Attribute Use, created because they share common functionality for handling fixed and default values
    Corresponds to a Content Type Property Record as defined in the XML Schema 1.1 specification
    Represents either of the facets totalDigits or fractionDigits
    The saxon:distinct facet on a list type can be used to constrain the list to contain distinct values.
    The object represents an element declaration in the schema.
    A reference to an element declaration within the content model of a complex type.
    This class represents an <any> element in the schema.
    Represents a single enumeration facet defined on a simple type.
    Represents the set of enumeration values defined on a single simple type, This is a "virtual" facet that combines all the enumeration facets in one simple type definition.
    Represents an explicitTimezone facet on a schema-defined simple type derived from date, time, dateTime, gYear, gYearMonth, gMonth, gMonthDay, or gDay
    Represents an XML Schema Facet.
    The selector of an IdentityConstraint
    Represents the fraction-digits facet in a simple type restriction
    The base class for the XML Schema Identity Constraints (key, keyref, unique).
    A reference to an identity constraint
    The field selector for an IdentityConstraint
    The selector of an IdentityConstraint
    A class that represents the XML Schema Identity Constraint: Key.
    This class represents an xs:keyRef identity constraint in a schema
    Represents the length facet
    Abstract class for the three facets length, minLength, and maxLength.
    Implements the maxExclusive facet on a simple type
    Implements the maxInclusive facet on a simple type
    Represents the minLength facet
    Implements the minExclusive facet on a simple type
    Implements the minInclusive facet on a simple type
    Represents the minLength facet
    This exception occurs when an attempt is made to dereference a reference from one schema component to another, if the target of the reference cannot be found.
    An XML Schema Model Group.
    A Model Group Definition: a schema component corresponding to a top-level (named) xs:group element in a schema document.
    A reference within the content model of a complex type to a Model Group Definition.
    A Notation Declaration Schema Component
     
    The saxon:order facet on a list type can be used to constrain the list to be in ascending or descending order.
    Represents a Particle as defined by XML Schema.
    Represents a pattern facet on a schema-defined simple type
    A schema is a collection of schema components.
    Represents the preprocess facet on a schema-defined simple type.
    A SchemaCompiler is capable of reading source schema documents and converting them into collections of schema components.
    This class allows a compiled schema model in SCM format to be loaded into memory.
    This class provides services enabling a compiled schema to be serialized to disk
    The base class for all XML Schema stuctures.
    A SequenceCompositor represents an xs:sequence element in the schema
    A component that can be serialized by the SchemaSerializer.
    A reference to a named schema group within the content model of a complex type
    A schema (collection of schema components) that has an identifiable target namespace: typically the set of components derived from a single import or include.
    This class holds constants used to identify the various symbol spaces defined in XML Schema: element declarations, attribute declarations, types, groups, and so on.
    Represents a Term in a content model as defined by XML Schema.
    Eepresents the value of the totalDigits facet
    A TypeAlternative schema component (See XML Schema 1.1 Part 1 Working Draft)
    A reference to a simple or complex type
    This class represents an xs:unique identity constraint
    An object belonging to this class represents an atomic type: either a built-in atomic type, or a user-defined atomic type.
    A user-defined complex type (that is, any complex type other than xs:anyType)
    This class represents a user-defined simple type or complex type as defined in XML Schema.
    Represents a SimpleType that is a list of a given SimpleType, known as its itemType.
    A SchemaComponent is an object in a schema.
    This class represents a used-defined simple type, as defined in the XML Schema specification.
    A class that represents the XML Schema simple-type with variety union.
    A value constraint represents the default or fixed value of an element declaration, attribute declaration, or attribute use
     
    Represents any of the facets minInclusive, maxInclusive, minExclusive, maxExclusive
    Represents a whitespace facet on a schema-defined simple type
    A class that represents an XML Schema Wildcard.