Interface Schema

  • All Superinterfaces:
    ExtensibilityElement, java.io.Serializable
    All Known Implementing Classes:
    SchemaImpl

    public interface Schema
    extends ExtensibilityElement, java.io.Serializable
    Represents a schema element. This is a lightweight schema wrapper that provides access to the schema DOM element, but does not parse the schema details. The implementor may provide alternative schema parsing if required.
    Author:
    Jeremy Hughes
    • Method Detail

      • getImports

        java.util.Map getImports()
        Get a map of lists containing all the imports defined here. The map's keys are the namespaceURIs, and the map's values are lists. There is one list for each namespaceURI for which imports have been defined.
        Returns:
        a map of lists of schema imports
      • createImport

        SchemaImport createImport()
        Create a new schema import
        Returns:
        the newly created schema import
      • addImport

        void addImport​(SchemaImport importSchema)
        Add an import to this LightWeightSchema
        Parameters:
        importSchema - the import to be added
      • getIncludes

        java.util.List getIncludes()
        Get a list containing all of the includes defined here. The list elements are schema references.
        Returns:
        a list of schema references.
      • createInclude

        SchemaReference createInclude()
        Create a new schema reference to represent an include.
        Returns:
        the newly created SchemaReference
      • addInclude

        void addInclude​(SchemaReference includeSchema)
        Add an include to this LightWeightSchema
        Parameters:
        includeSchema - The include to be added, represented as a SchemaReference
      • getRedefines

        java.util.List getRedefines()
        Get a list containing all of the redefines defined here. The list elements are schema references.
        Returns:
        a list of schema references.
      • createRedefine

        SchemaReference createRedefine()
        Create a new schema reference to represent a redefine.
        Returns:
        the newly created SchemaReference
      • addRedefine

        void addRedefine​(SchemaReference redefineSchema)
        Add a redefine to this LightWeightSchema
        Parameters:
        redefineSchema - The redefine to be added, represented as a SchemaReference
      • setElement

        void setElement​(org.w3c.dom.Element element)
        Set the DOM Element that represents this schema element.
        Parameters:
        element - the DOM element representing this schema
      • getElement

        org.w3c.dom.Element getElement()
        Get the DOM Element that represents this schema element.
        Returns:
        the DOM element representing this schema
      • setDocumentBaseURI

        void setDocumentBaseURI​(java.lang.String documentBaseURI)
        Set the document base URI of this schema definition. Can be used to represent the origin of the schema, and can be exploited when resolving relative URIs (e.g. in <import>s).
        Parameters:
        documentBaseURI - the document base URI of this schema
      • getDocumentBaseURI

        java.lang.String getDocumentBaseURI()
        Get the document base URI of this schema
        Returns:
        the document base URI