Class SDOHelper


  • public class SDOHelper
    extends Object
    This class provides a mechanism to obtain the EclipseLink implementation of various SDO runtime classes based on a given SDO class/interface. This is useful for accessing extended EclipseLink features. Using this helper class will alleviate the need for consumers of EclipseLink SDO to perform casts where their code makes use of the standard SDO API. In addition, a given SDO class/interface can be unwrapped based on a user-specified class. This will allow access - in certain cases - to a given SDO implementation class' underlying class(es). For example, an XMLHelper could be unwrapped resulting in an EclipseLink SDOXMLHelper or its underlying XMLContext.
    • Constructor Summary

      Constructors 
      Constructor Description
      SDOHelper()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SDOChangeSummary getChangeSummary​(commonj.sdo.ChangeSummary changeSummary)
      Return the EclipseLink implementation of ChangeSummary.
      static SDOCopyHelper getCopyHelper​(commonj.sdo.helper.CopyHelper copyHelper)
      Return the EclipseLink implementation of CopyHelper.
      static SDODataFactory getDataFactory​(commonj.sdo.helper.DataFactory dataFactory)
      Return the EclipseLink implementation of DataFactory.
      static SDODataHelper getDataHelper​(commonj.sdo.helper.DataHelper dataHelper)
      Return the EclipseLink implementation of DataHelper.
      static SDODataObject getDataObject​(commonj.sdo.DataObject dataObject)
      Return the EclipseLink implementation of DataObject.
      static SDOEqualityHelper getEqualityHelper​(commonj.sdo.helper.EqualityHelper equalityHelper)
      Return the EclipseLink implementation of EqualityHelper.
      static SDOHelperContext getHelperContext​(commonj.sdo.helper.HelperContext helperContext)
      Return the EclipseLink implementation of HelperContext.
      static SDOProperty getProperty​(commonj.sdo.Property property)
      Return the EclipseLink implementation of Property.
      static SDOSequence getSequence​(commonj.sdo.Sequence sequence)
      Return the EclipseLink implementation of Sequence.
      static SDOType getType​(commonj.sdo.Type type)
      Return the EclipseLink implementation of Type.
      static SDOTypeHelper getTypeHelper​(commonj.sdo.helper.TypeHelper typeHelper)
      Return the EclipseLink implementation of TypeHelper.
      static SDOXMLHelper getXMLHelper​(commonj.sdo.helper.XMLHelper xmlHelper)
      Return the EclipseLink implementation of XMLHelper.
      static SDOXSDHelper getXSDHelper​(commonj.sdo.helper.XSDHelper xsdHelper)
      Return the EclipseLink implementation of XSDHelper.
      static <T> T unwrap​(commonj.sdo.ChangeSummary changeSummary, Class<T> clazz)
      Unwraps a given ChangeSummary resulting in an EclipseLink SDOChangeSummary.
      static <T> T unwrap​(commonj.sdo.DataObject dataObject, Class<T> clazz)
      Unwraps a given DataObject resulting in an EclipseLink SDODataObject.
      static <T> T unwrap​(commonj.sdo.helper.CopyHelper copyHelper, Class<T> clazz)
      Unwraps a given CopyHelper resulting in an EclipseLink SDOCopyHelper.
      static <T> T unwrap​(commonj.sdo.helper.DataFactory dataFactory, Class<T> clazz)
      Unwraps a given DataFactory resulting in an EclipseLink SDODataFactory.
      static <T> T unwrap​(commonj.sdo.helper.DataHelper dataHelper, Class<T> clazz)
      Unwraps a given DataHelper resulting in an EclipseLink SDODataHelper.
      static <T> T unwrap​(commonj.sdo.helper.EqualityHelper equalityHelper, Class<T> clazz)
      Unwraps a given EqualityHelper resulting in an EclipseLink SDOEqualityHelper.
      static <T> T unwrap​(commonj.sdo.helper.HelperContext helperContext, Class<T> clazz)
      Unwraps a given HelperContext resulting in an EclipseLink SDOHelperContext.
      static <T> T unwrap​(commonj.sdo.helper.TypeHelper typeHelper, Class<T> clazz)
      Unwraps a given TypeHelper resulting in an EclipseLink SDOTypeHelper.
      static <T> T unwrap​(commonj.sdo.helper.XMLHelper xmlHelper, Class<T> clazz)
      Unwraps a given XMLHelper resulting in an EclipseLink SDOXMLHelper or an EclipseLink XMLContext depending on clazz.
      static <T> T unwrap​(commonj.sdo.helper.XSDHelper xsdHelper, Class<T> clazz)
      Unwraps a given XSDHelper resulting in an EclipseLink SDOXSDHelper.
      static <T> T unwrap​(commonj.sdo.Property property, Class<T> clazz)
      Unwraps a given Property resulting in an EclipseLink SDOProperty.
      static <T> T unwrap​(commonj.sdo.Sequence sequence, Class<T> clazz)
      Unwraps a given Sequence resulting in an EclipseLink SDOSequence.
      static <T> T unwrap​(commonj.sdo.Type type, Class<T> clazz)
      Unwraps a given Type resulting in an EclipseLink SDOType.
    • Constructor Detail

      • SDOHelper

        public SDOHelper()
    • Method Detail

      • getHelperContext

        public static SDOHelperContext getHelperContext​(commonj.sdo.helper.HelperContext helperContext)
                                                 throws IllegalArgumentException
        Return the EclipseLink implementation of HelperContext. If the given HelperContext is an instance of the DefaultContext, an SDOHelperContext will be obtained via SDOHelperContext.getHelperContext(). Otherwise, the given HelperContext is assumed to be an instance of SDOHelperContext. If not, an exception will be thrown.
        Parameters:
        helperContext -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.Type type,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given Type resulting in an EclipseLink SDOType. Assumes that the given Type is an instance of EclipseLink SDOType, and clazz is one of: org.eclipse.persistence.sdo.SDOType, org.eclipse.persistence.sdo.type.SDOTypeType, org.eclipse.persistence.sdo.type.SDOPropertyType, org.eclipse.persistence.sdo.type.SDOChangeSummaryType, org.eclipse.persistence.sdo.type.SDODataObjectType, org.eclipse.persistence.sdo.type.SDODataType, org.eclipse.persistence.sdo.type.SDOOpenSequencedType, org.eclipse.persistence.sdo.type.SDOObjectType, org.eclipse.persistence.sdo.type.SDOWrapperType, org.eclipse.persistence.sdo.type.SDOXMLHelperLoadOptionsType
        Type Parameters:
        T -
        Parameters:
        type -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.Property property,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given Property resulting in an EclipseLink SDOProperty. Assumes that the given Property is an instance of EclipseLink SDOProperty, and clazz is org.eclipse.persistence.sdo.SDOProperty.
        Type Parameters:
        T -
        Parameters:
        property -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.DataObject dataObject,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given DataObject resulting in an EclipseLink SDODataObject. Assumes that the given DataObject is an instance of EclipseLink SDODataObject, and clazz is org.eclipse.persistence.sdo.SDODataObject.
        Type Parameters:
        T -
        Parameters:
        dataObject -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.ChangeSummary changeSummary,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given ChangeSummary resulting in an EclipseLink SDOChangeSummary. Assumes that the given ChangeSummary is an instance of EclipseLink SDOChangeSummary, and clazz is org.eclipse.persistence.sdo.SDOChangeSummary.
        Type Parameters:
        T -
        Parameters:
        changeSummary -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.Sequence sequence,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given Sequence resulting in an EclipseLink SDOSequence. Assumes that the given Sequence is an instance of EclipseLink SDOSequence, and clazz is org.eclipse.persistence.sdo.SDOSequence.
        Type Parameters:
        T -
        Parameters:
        sequence -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.HelperContext helperContext,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given HelperContext resulting in an EclipseLink SDOHelperContext. Assumes that the given HelperContext is an instance of EclipseLink SDOHelperContext, and clazz is org.eclipse.persistence.sdo.helper.SDOHelperContext.
        Type Parameters:
        T -
        Parameters:
        helperContext -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.CopyHelper copyHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given CopyHelper resulting in an EclipseLink SDOCopyHelper. Assumes that the given CopyHelper is an instance of EclipseLink SDOCopyHelper, and clazz is org.eclipse.persistence.sdo.helper.SDOCopyHelper.
        Type Parameters:
        T -
        Parameters:
        copyHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.DataFactory dataFactory,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given DataFactory resulting in an EclipseLink SDODataFactory. Assumes that the given DataFactory is an instance of EclipseLink SDODataFactory, and clazz is org.eclipse.persistence.sdo.helper.SDODataFactory.
        Type Parameters:
        T -
        Parameters:
        dataFactory -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.DataHelper dataHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given DataHelper resulting in an EclipseLink SDODataHelper. Assumes that the given DataHelper is an instance of EclipseLink SDODataHelper, and clazz is org.eclipse.persistence.sdo.helper.SDODataHelper.
        Type Parameters:
        T -
        Parameters:
        dataHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.EqualityHelper equalityHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given EqualityHelper resulting in an EclipseLink SDOEqualityHelper. Assumes that the given EqualityHelper is an instance of EclipseLink SDOEqualityHelper, and clazz is org.eclipse.persistence.sdo.helper.SDOEqualityHelper.
        Type Parameters:
        T -
        Parameters:
        equalityHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.TypeHelper typeHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given TypeHelper resulting in an EclipseLink SDOTypeHelper. Assumes that the given TypeHelper is an instance of EclipseLink SDOTypeHelper, and clazz is org.eclipse.persistence.sdo.helper.SDOTypeHelper.
        Type Parameters:
        T -
        Parameters:
        typeHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.XMLHelper xmlHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given XMLHelper resulting in an EclipseLink SDOXMLHelper or an EclipseLink XMLContext depending on clazz. Assumes that the given XMLHelper is an instance of EclipseLink SDOXMLHelper, and clazz is one of org.eclipse.persistence.sdo.helper.SDOXMLHelper, or org.eclipse.persistence.oxm.XMLContext. If not, an exception will be thrown.
        Type Parameters:
        T -
        Parameters:
        xmlHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException
      • unwrap

        public static <T> T unwrap​(commonj.sdo.helper.XSDHelper xsdHelper,
                                   Class<T> clazz)
                            throws IllegalArgumentException
        Unwraps a given XSDHelper resulting in an EclipseLink SDOXSDHelper. Assumes that the given XSDHelper is an instance of EclipseLink SDOXSDHelper, and clazz is org.eclipse.persistence.sdo.helper.SDOXSDHelper.
        Type Parameters:
        T -
        Parameters:
        xsdHelper -
        clazz -
        Returns:
        Throws:
        IllegalArgumentException