Package org.eclipse.persistence.sdo.helper.delegates

Class SDOTypeHelperDelegate

  • All Implemented Interfaces:
    commonj.sdo.helper.TypeHelper, SDOTypeHelper
    public class SDOTypeHelperDelegate
extends java.lang.Object
implements SDOTypeHelper

    Purpose: Helper to provide access to declared SDO Types.

    Responsibilities:

    • Look up a Type given the uri and typeName or interfaceClass.
    • SDO Types are available through the getType("commonj.sdo", typeName) method.
    • Defines Types from DataObjects.

    • Field Summary

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

        INSTANCE

    • Constructor Summary

      Constructors 
      Constructor Description
      SDOTypeHelperDelegate​(commonj.sdo.helper.HelperContext aContext)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String addNamespace​(java.lang.String prefix, java.lang.String uri)
      INTERNAL: Add the given namespace uri and prefix to the global namespace resolver.
      void addType​(SDOType newType)
      INTERNAL:
      void addWrappersToProject​(org.eclipse.persistence.sessions.Project project)  
      commonj.sdo.Type define​(commonj.sdo.DataObject dataObject)  
      commonj.sdo.Type define​(commonj.sdo.DataObject dataObject, java.util.List types)
      Define the DataObject as a Type.
      java.util.List define​(java.util.List types)
      Define the list of DataObjects as Types.
      commonj.sdo.Property defineOpenContentProperty​(java.lang.String uri, commonj.sdo.DataObject propertyDO)
      Define the DataObject as a Property for setting open content.
      java.util.List getAnonymousTypes()  
      commonj.sdo.helper.HelperContext getHelperContext()
      INTERNAL: Return the current helperContext associated with this delegate.
      java.util.Map<java.lang.Class,​SDOType> getImplClassesToSDOType()  
      java.util.Map getInterfacesToSDOTypeHashMap()  
      java.lang.Class getJavaWrapperTypeForSDOType​(commonj.sdo.Type type)
      INTERNAL:
      org.eclipse.persistence.oxm.NamespaceResolver getNamespaceResolver()
      INTERNAL: Return the NamespaceResolver
      java.util.Map getOpenContentProperties()
      INTERNAL: Return the Map of Open Content Properties
      commonj.sdo.Property getOpenContentProperty​(java.lang.String uri, java.lang.String propertyName)
      Get the open Property with the specified uri and name, or null if not found.
      java.lang.String getPrefix​(java.lang.String uri)
      INTERNAL: Return the prefix for the given uri, or generate a new one if necessary
      SDOType getSDOTypeFromXSDType​(javax.xml.namespace.QName aName)
      A function to access the values stored in sdoToXSDTypes HashMap
      SDOType getType​(java.lang.Class interfaceClass)
      Return the Type for this interfaceClass or null if not found.
      SDOType getType​(java.lang.String uri, java.lang.String typeName)
      Return the Type specified by typeName with the given uri, or null if not found.
      SDOType getTypeForImplClass​(java.lang.Class implClass)  
      SDOType getTypeForSimpleJavaType​(java.lang.Class implClass)
      INTERNAL: Used to determine which SDO Type corresponds the given Java simple type
      java.util.Map getTypesHashMap()
      INTERNAL:
      java.util.Map getWrappersHashMap()
      INTERNAL: Return the map of Wrapper objects (SDOWrapperTypes that wrap a primitive document).
      javax.xml.namespace.QName getXSDTypeFromSDOType​(commonj.sdo.Type aType)
      A function to access the values stored in xsdToSDOType HashMap
      void initWrapperTypes()  
      void reset()
      INTERNAL:
      void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
      INTERNAL: Set the current helperContext to be associated with this delegate
      void setTypesHashMap​(java.util.Map typesHashMap)
      INTERNAL:
      void setWrappersHashMap​(java.util.Map aMap)
      INTERNAL: Set the map of Wrapper objects (SDOWrapperTypes that wrap a primitive document).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SDOTypeHelperDelegate

        public SDOTypeHelperDelegate​(commonj.sdo.helper.HelperContext aContext)

    • Method Detail

      • initWrapperTypes

        public void initWrapperTypes()

      • addWrappersToProject

        public void addWrappersToProject​(org.eclipse.persistence.sessions.Project project)
        Specified by:
        addWrappersToProject in interface SDOTypeHelper

      • getType

        public SDOType getType​(java.lang.String uri,
                       java.lang.String typeName)
        Return the Type specified by typeName with the given uri, or null if not found.
        Specified by:
        getType in interface commonj.sdo.helper.TypeHelper
        Parameters:
        uri - The uri of the Type - type.getURI();
        typeName - The name of the Type - type.getName();
        Returns:
        the Type specified by typeName with the given uri, or null if not found.

      • getType

        public SDOType getType​(java.lang.Class interfaceClass)
        Return the Type for this interfaceClass or null if not found.
        Specified by:
        getType in interface commonj.sdo.helper.TypeHelper
        Parameters:
        interfaceClass - is the interface for the DataObject's Type - type.getInstanceClass();
        Returns:
        the Type for this interfaceClass or null if not found.

      • getTypeForSimpleJavaType

        public SDOType getTypeForSimpleJavaType​(java.lang.Class implClass)
        INTERNAL: Used to determine which SDO Type corresponds the given Java simple type
        Specified by:
        getTypeForSimpleJavaType in interface SDOTypeHelper
        Returns:

      • define

        public commonj.sdo.Type define​(commonj.sdo.DataObject dataObject)
        Specified by:
        define in interface commonj.sdo.helper.TypeHelper

      • define

        public commonj.sdo.Type define​(commonj.sdo.DataObject dataObject,
                               java.util.List types)
        Define the DataObject as a Type. The Type is available through TypeHelper and DataGraph getType() methods.
        Parameters:
        dataObject - the DataObject representing the Type.
        Returns:
        the defined Type.
        Throws:
        java.lang.IllegalArgumentException - if the Type could not be defined.

      • define

        public java.util.List define​(java.util.List types)
        Define the list of DataObjects as Types. The Types are available through TypeHelper and DataGraph getType() methods.
        Specified by:
        define in interface commonj.sdo.helper.TypeHelper
        Parameters:
        types - a List of DataObjects representing the Types.
        Returns:
        the defined Types.
        Throws:
        java.lang.IllegalArgumentException - if the Types could not be defined.

      • getXSDTypeFromSDOType

        public javax.xml.namespace.QName getXSDTypeFromSDOType​(commonj.sdo.Type aType)
        A function to access the values stored in xsdToSDOType HashMap
        Specified by:
        getXSDTypeFromSDOType in interface SDOTypeHelper
        Parameters:
        aType - a SDO Type Object
        Returns:
        the corresponding XSD QName Object

      • getSDOTypeFromXSDType

        public SDOType getSDOTypeFromXSDType​(javax.xml.namespace.QName aName)
        A function to access the values stored in sdoToXSDTypes HashMap
        Specified by:
        getSDOTypeFromXSDType in interface SDOTypeHelper
        Parameters:
        aName -
        Returns:

      • getWrappersHashMap

        public java.util.Map getWrappersHashMap()
        INTERNAL: Return the map of Wrapper objects (SDOWrapperTypes that wrap a primitive document).
        Specified by:
        getWrappersHashMap in interface SDOTypeHelper
        Returns:
        a HashMap of SDOWrapperTypes, keyed on the XSD type that it wraps.

      • setWrappersHashMap

        public void setWrappersHashMap​(java.util.Map aMap)
        INTERNAL: Set the map of Wrapper objects (SDOWrapperTypes that wrap a primitive document).
        Specified by:
        setWrappersHashMap in interface SDOTypeHelper
        Parameters:
        aMap - a HashMap of SDOWrapperTypes, keyed on the XSD type that it wraps.

      • defineOpenContentProperty

        public commonj.sdo.Property defineOpenContentProperty​(java.lang.String uri,
                                                      commonj.sdo.DataObject propertyDO)
        Define the DataObject as a Property for setting open content. The new property or, if already defined, an existing property is returned. The containing Type of the open property is not specified by SDO. If the specified uri is not null the defined property is accessible through TypeHelper.getOpenProperty(uri, propertyName). If a null uri is specified, the location and management of the open property is not specified by SDO.
        Specified by:
        defineOpenContentProperty in interface commonj.sdo.helper.TypeHelper
        Parameters:
        uri - the namespace URI of the open Property or null.
        Returns:
        the defined open Property.
        Throws:
        java.lang.IllegalArgumentException - if the Property could not be defined.

      • getOpenContentProperty

        public commonj.sdo.Property getOpenContentProperty​(java.lang.String uri,
                                                   java.lang.String propertyName)
        Get the open Property with the specified uri and name, or null if not found.
        Specified by:
        getOpenContentProperty in interface commonj.sdo.helper.TypeHelper
        Parameters:
        uri - the namespace URI of the open Property.
        propertyName - the name of the open Property.
        Returns:
        the open Property.

      • getHelperContext

        public commonj.sdo.helper.HelperContext getHelperContext()
        INTERNAL: Return the current helperContext associated with this delegate.
        Specified by:
        getHelperContext in interface SDOTypeHelper
        Returns:

      • setHelperContext

        public void setHelperContext​(commonj.sdo.helper.HelperContext helperContext)
        INTERNAL: Set the current helperContext to be associated with this delegate
        Specified by:
        setHelperContext in interface SDOTypeHelper

      • getPrefix

        public java.lang.String getPrefix​(java.lang.String uri)
        INTERNAL: Return the prefix for the given uri, or generate a new one if necessary
        Specified by:
        getPrefix in interface SDOTypeHelper

      • addNamespace

        public java.lang.String addNamespace​(java.lang.String prefix,
                                     java.lang.String uri)
        INTERNAL: Add the given namespace uri and prefix to the global namespace resolver.
        Specified by:
        addNamespace in interface SDOTypeHelper

      • getNamespaceResolver

        public org.eclipse.persistence.oxm.NamespaceResolver getNamespaceResolver()
        INTERNAL: Return the NamespaceResolver
        Specified by:
        getNamespaceResolver in interface SDOTypeHelper

      • getOpenContentProperties

        public java.util.Map getOpenContentProperties()
        INTERNAL: Return the Map of Open Content Properties
        Specified by:
        getOpenContentProperties in interface SDOTypeHelper