Package org.eclipse.persistence.sdo

Class SDOType

    • Field Detail

      • isDataType

        protected boolean isDataType

      • javaImplClass

        protected Class javaImplClass

    • Method Detail

      • getQName

        public QName getQName()

      • setQName

        public void setQName​(QName qName)

      • getName

        public String getName()
        Description copied from interface: Type
        Returns the name of the type.
        Specified by:
        getName in interface Type
        Returns:
        the type name.

      • getURI

        public String getURI()
        Description copied from interface: Type
        Returns the namespace URI of the type or null if the type has no URI (for example it was generated from a Schema with no target namespace).
        Specified by:
        getURI in interface Type
        Returns:
        the namespace URI.

      • getInstanceClass

        public Class getInstanceClass()
        Description copied from interface: Type
        Returns the Java class that this type represents.
        Specified by:
        getInstanceClass in interface Type
        Returns:
        the Java class.

      • isInstance

        public boolean isInstance​(Object object)
        Description copied from interface: Type
        Returns whether the specified object is an instance of this type.
        Specified by:
        isInstance in interface Type
        Parameters:
        object - the object in question.
        Returns:
        true if the object is an instance.
        See Also:
        Class.isInstance(java.lang.Object)

      • getProperties

        public List getProperties()
        Description copied from interface: Type
        Returns the List of the Properties of this type.

        The expression 

           type.getProperties().indexOf(property)
        yields the property's index relative to this type. As such, these expressions are equivalent: 
            dataObject.get(i)
    dataObject.get((Property)dataObject.getType().getProperties().get(i));

        Specified by:
        getProperties in interface Type
        Returns:
        the Properties of the type.
        See Also:
        Property.getContainingType()

      • getProperty

        public SDOProperty getProperty​(String propertyName)
        Description copied from interface: Type
        Returns from all the Properties of this type, the one with the specified name. As such, these expressions are equivalent: 
            dataObject.get("name")
    dataObject.get(dataObject.getType().getProperty("name"))

        Specified by:
        getProperty in interface Type
        Returns:
        the Property with the specified name.
        See Also:
        Type.getProperties()

      • isDataType

        public boolean isDataType()
        Description copied from interface: Type
        Indicates if this Type specifies DataTypes (true) or DataObjects (false). When false, any object that is an instance of this type also implements the DataObject interface. True for simple types such as Strings and numbers. For any object: 
           isInstance(object) && !isDataType() implies
   DataObject.class.isInstance(object) returns true.
        Specified by:
        isDataType in interface Type
        Returns:
        true if Type specifies DataTypes, false for DataObjects.

      • isOpen

        public boolean isOpen()
        Description copied from interface: Type
        Indicates if this Type allows any form of open content. If false, dataObject.getInstanceProperties() must be the same as dataObject.getType().getProperties() for any DataObject dataObject of this Type.
        Specified by:
        isOpen in interface Type
        Returns:
        true if this Type allows open content.

      • isSequenced

        public boolean isSequenced()
        Description copied from interface: Type
        Indicates if this Type specifies Sequenced DataObjects. Sequenced DataObjects are used when the order of values between Properties must be preserved. When true, a DataObject will return a Sequence. For example, 
          Sequence elements = dataObject.getSequence();
        Specified by:
        isSequenced in interface Type
        Returns:
        true if this Type specifies Sequenced DataObjects.

      • isAbstract

        public boolean isAbstract()
        Description copied from interface: Type
        Indicates if this Type is abstract. If true, this Type cannot be instantiated. Abstract types cannot be used in DataObject or DataFactory create methods.
        Specified by:
        isAbstract in interface Type
        Returns:
        true if this Type is abstract.

      • getBaseTypes

        public List getBaseTypes()
        Description copied from interface: Type
        Returns the List of base Types for this Type. The List is empty if there are no base Types. XSD , , and Java extends keyword are mapped to this list.
        Specified by:
        getBaseTypes in interface Type
        Returns:
        the List of base Types for this Type.

      • isSubType

        public boolean isSubType()
        INTERNAL: Provide a means to determine if this type has base types without causing the base types property to be initialized.

      • getDeclaredProperties

        public List getDeclaredProperties()
        Description copied from interface: Type
        Returns the Properties declared in this Type as opposed to those declared in base Types.
        Specified by:
        getDeclaredProperties in interface Type
        Returns:
        the Properties declared in this Type.

      • getAliasNames

        public List getAliasNames()
        Description copied from interface: Type
        Return a list of alias names for this Type.
        Specified by:
        getAliasNames in interface Type
        Returns:
        a list of alias names for this Type.

      • addAliasName

        public void addAliasName​(String name)
        INTERNAL: Assign a unique string to a type, which belongs to same uri, among types.
        Parameters:
        name - a unique string representing a type.

      • setAliasNames

        public void setAliasNames​(List names)
        INTERNAL: Assign a list of alias names to a type, which are unique in URI.
        Parameters:
        names - a unique string representing a type.

      • setOpen

        public void setOpen​(boolean bOpen)
        INTERNAL: Make this Type an opened Type to allow open content by assigning true value or a Type not to accept any additional properties by assigning false value, isOpen().
        Parameters:
        bOpen - boolean value implying if this Type is open

      • setAbstract

        public void setAbstract​(boolean makeAbstract)
        INTERNAL: Change this Type's abstract setting. If it is true, this Type can't be instantiated and typically serve as base Type.
        Parameters:
        makeAbstract - boolean value implying if this Type is abstract.

      • setSequenced

        public void setSequenced​(boolean sequenced)
        INTERNAL: If set as true, this Type specifies Sequenced DataObjects.
        Parameters:
        sequenced - boolean value implying if this type is sequenced.

      • setMixed

        public void setMixed​(boolean isMixed)

      • setDataType

        public void setDataType​(boolean datatype)
        INTERNAL: Set this Type to a simple Type by passing in boolean value true. Otherwise, If boolean value is passed in, instances of this type implement DataObject.
        Parameters:
        datatype - boolean value implying if it is a simple Type

      • setBaseTypes

        public void setBaseTypes​(List bTypes)
        INTERNAL: Set a list of Types as This Type's base Types.
        Parameters:
        bTypes - a list types to become this Type's base Type.

      • addBaseType

        public void addBaseType​(SDOType type)
        INTERNAL:
        Parameters:
        type - a type to become this Type's base Type.

      • setInstanceClass

        public void setInstanceClass​(Class aClass)
        INTERNAL: Sets the Java class that this type represents.
        Parameters:
        aClass - the Java class that this type represents.

      • setXsd

        public void setXsd​(boolean bXsd)
        INTERNAL: Set if this property was declared in an XML schema.
        Parameters:
        bXsd - a boolean representing if this property was declared in an XML schema

      • isXsd

        public boolean isXsd()
        INTERNAL: Returns if this property was declared in an XML schema. Defaults to false.
        Returns:
        if this property was declared in an XML schema

      • setXsdLocalName

        public void setXsdLocalName​(String xsdLocalNameString)
        INTERNAL: Set the local name of this property.
        Parameters:
        xsdLocalNameString - a String representing the local name of this property if it was declared in an XML schema

      • getXsdLocalName

        public String getXsdLocalName()
        INTERNAL: Returns the local name of the Property.
        Returns:
        the local name of the property.

      • addDeclaredProperty

        public void addDeclaredProperty​(Property property)
        INTERNAL:
        Parameters:
        property -

      • addDeclaredProperty

        public void addDeclaredProperty​(SDOProperty property)
        INTERNAL:
        Parameters:
        property -

      • addDeclaredProperty

        public void addDeclaredProperty​(Property property,
                                int index)
        INTERNAL:
        Parameters:
        property -

      • addDeclaredProperty

        public void addDeclaredProperty​(SDOProperty property,
                                int index)
        INTERNAL:
        Parameters:
        property -

      • removeDeclaredProperties

        public void removeDeclaredProperties​(Property p)
        INTERNAL:

      • getDeclaredPropertiesMap

        public Map getDeclaredPropertiesMap()
        INTERNAL:

      • setInstanceClassName

        public void setInstanceClassName​(String instanceClassName)
        INTERNAL: Sets the name of the Java class that this type represents.
        Parameters:
        instanceClassName - the Java class that this type represents.

      • getInstanceClassName

        public String getInstanceClassName()
        INTERNAL: Returns the Java class name that this type represents.
        Returns:
        the Java class name.

      • setXsdList

        public void setXsdList​(boolean anXsdList)
        INTERNAL: Set if this type is an xsd:list in the schema
        Parameters:
        anXsdList - a boolean representing if this type represents an xsd:list in the schema

      • isXsdList

        public boolean isXsdList()
        INTERNAL: Indicates if this Type is an xsd:list in the schema
        Returns:
        true if this Type represents an xsd:list in the schema

      • setXmlDescriptor

        public void setXmlDescriptor​(XMLDescriptor anXMLDescriptor)
        INTERNAL: Set the XMLDescriptor on this Type
        Parameters:
        anXMLDescriptor -

      • initializeNamespaces

        public void initializeNamespaces​(List namespaceResolvers)
        INTERNAL: Get the XMLDescriptor associated with this Type or generate a new one.

      • setupInheritance

        public void setupInheritance​(SDOType parentType)

      • preInitialize

        public void preInitialize​(String packageName,
                          List namespaceResolvers)
        INTERNAL: For this Type generate classes
        Parameters:
        packageName -
        namespaceResolvers -

      • postInitialize

        public void postInitialize()
        INTERNAL:

      • setImplClassName

        public void setImplClassName​(String implClassName)
        INTERNAL:

      • getImplClassName

        public String getImplClassName()
        INTERNAL:

      • getImplClass

        public Class getImplClass()
        INTERNAL:

      • getInstanceProperties

        public List getInstanceProperties()
        Description copied from interface: Type
        Returns a read-only List of instance Properties available on this Type.

        This list includes, at a minimum, any open content properties (extensions) added to the object before defining the Type's Type. Implementations may, but are not required to in the 2.1 version of SDO, provide additional instance properties.

        Specified by:
        getInstanceProperties in interface Type
        Returns:
        the List of instance Properties on this Type.

      • setPropertyValues

        public void setPropertyValues​(Map properties)
        INTERNAL:

      • getPropertyValues

        public Map getPropertyValues()
        INTERNAL:

      • setInstanceProperty

        public void setInstanceProperty​(Property property,
                                Object value)
        INTERNAL:
        Parameters:
        property -
        value -

      • getChangeSummaryProperty

        public SDOProperty getChangeSummaryProperty()
        INTERNAL:

      • getPropertiesArray

        public SDOProperty[] getPropertiesArray()
        INTERNAL:

      • setSubTypes

        public void setSubTypes​(List subTypesList)
        INTERNAL:

      • getSubTypes

        public List getSubTypes()
        INTERNAL:

      • isBaseType

        public boolean isBaseType()
        INTERNAL: Provide a means to determine if this type has sub types without causing the sub types property to be initialized.

      • setXsdType

        public void setXsdType​(QName xsdTypeQName)
        INTERNAL:

      • getXsdType

        public QName getXsdType()
        INTERNAL:

      • setFinalized

        public void setFinalized​(boolean bFinalized)
        INTERNAL:

      • isFinalized

        public boolean isFinalized()
        INTERNAL:

      • setNonFinalizedReferencingProps

        public void setNonFinalizedReferencingProps​(List nonFinalizedReferencingProps)
        INTERNAL:

      • getNonFinalizedReferencingProps

        public List getNonFinalizedReferencingProps()
        INTERNAL:

      • setNonFinalizedMappingURIs

        public void setNonFinalizedMappingURIs​(List nonFinalizedMappingURIsList)
        INTERNAL:

      • getNonFinalizedMappingURIs

        public List getNonFinalizedMappingURIs()
        INTERNAL:

      • setAppInfoElements

        public void setAppInfoElements​(List appInfoElementsList)
        INTERNAL:

      • getAppInfoElements

        public List getAppInfoElements()
        INTERNAL:

      • getAppInfoMap

        public Map getAppInfoMap()
        INTERNAL:

      • getPseudoDefault

        public Object getPseudoDefault()
        INTERNAL: Return the wrapped initial value for the primitive numeric (when not defined) See p.45 of Java Spec 4th edition. See p.85 Sect 9.3 of the SDO Spec.
        Returns:
        aDefault Object (primitive numerics) or null (DataObjects, String, Lists)

      • setPseudoDefault

        public void setPseudoDefault​(Object anObject)
        INTERNAL: Set an Object wrapper around primitive numeric types
        Parameters:
        anObject -

      • getHelperContext

        public HelperContext getHelperContext()
        Return the HelperContext object associated with this type. For example, the typeHelper associated with the returned HelperContext would contain this type

      • isChangeSummaryType

        public boolean isChangeSummaryType()

      • isDataObjectType

        public boolean isDataObjectType()

      • isTypeType

        public boolean isTypeType()

      • isOpenSequencedType

        public boolean isOpenSequencedType()

      • isWrapperType

        public boolean isWrapperType()