Package org.eclipse.persistence.sdo.helper

Interface SDOXSDHelper

  • All Superinterfaces:
    commonj.sdo.helper.XSDHelper
    All Known Implementing Classes:
    SDOXSDHelperDelegate, SDOXSDHelperDelegator
    public interface SDOXSDHelper
extends commonj.sdo.helper.XSDHelper

    Purpose: Provides access to additional information when the Type or Property is defined by an XML Schema (XSD).

    Responsibilities:

    • Define methods define Types from an XSD.
    • Generate methods generate an XSD from Types.
    • Other Methods return null/false for exception conditions.

    • Field Summary

      • Fields inherited from interface commonj.sdo.helper.XSDHelper

        INSTANCE

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addGlobalProperty​(javax.xml.namespace.QName qname, commonj.sdo.Property prop, boolean isElement)
      INTERNAL:
      java.util.Map buildAppInfoMap​(java.util.List appInfoElements)
      INTERNAL:
      java.util.List define​(javax.xml.transform.Source xsdSource, SchemaResolver schemaResolver)
      INTERNAL:
      java.lang.String generate​(java.util.List types, SchemaLocationResolver schemaLocationResolver)
      INTERNAL:
      commonj.sdo.Property getGlobalProperty​(javax.xml.namespace.QName qname, boolean isElement)
      INTERNAL:
      commonj.sdo.helper.HelperContext getHelperContext()
      INTERNAL: Return the helperContext that this instance is associated with.
      void reset()
      INTERNAL:
      void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
      INTERNAL: Set the helperContext that this instance is associated with.

      • Methods inherited from interface commonj.sdo.helper.XSDHelper

        define, define, define, generate, generate, getAppinfo, getAppinfo, getGlobalProperty, getLocalName, getLocalName, getNamespaceURI, getNamespaceURI, isAttribute, isElement, isMixed, isXSD

    • Method Detail

      • getGlobalProperty

        commonj.sdo.Property getGlobalProperty​(javax.xml.namespace.QName qname,
                                       boolean isElement)
        INTERNAL:
        Parameters:
        qname -
        isElement -
        Returns:

      • define

        java.util.List define​(javax.xml.transform.Source xsdSource,
                      SchemaResolver schemaResolver)
        INTERNAL:
        Parameters:
        xsdSource -
        schemaResolver -
        Returns:

      • generate

        java.lang.String generate​(java.util.List types,
                          SchemaLocationResolver schemaLocationResolver)
        INTERNAL:
        Parameters:
        types -
        schemaLocationResolver -
        Returns:

      • buildAppInfoMap

        java.util.Map buildAppInfoMap​(java.util.List appInfoElements)
        INTERNAL:
        Parameters:
        appInfoElements -
        Returns:

      • getHelperContext

        commonj.sdo.helper.HelperContext getHelperContext()
        INTERNAL: Return the helperContext that this instance is associated with.
        Returns:

      • setHelperContext

        void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
        INTERNAL: Set the helperContext that this instance is associated with.
        Parameters:
        helperContext -

      • reset

        void reset()
        INTERNAL:

      • addGlobalProperty

        void addGlobalProperty​(javax.xml.namespace.QName qname,
                       commonj.sdo.Property prop,
                       boolean isElement)
        INTERNAL:
        Parameters:
        qname -
        prop -
        isElement - Register the given property with the given qname.