EclipseLink 2.0.0, build 'v20091127-r5931' API Reference

org.eclipse.persistence.sdo.types
Class SDOChangeSummaryType

java.lang.Object
  extended by org.eclipse.persistence.sdo.SDOType
      extended by org.eclipse.persistence.sdo.types.SDOChangeSummaryType
All Implemented Interfaces:
Type, java.io.Serializable

public class SDOChangeSummaryType
extends SDOType
implements Type

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.persistence.sdo.SDOType
SDOType.TypeInstantiationPolicy
 
Field Summary
 
Fields inherited from class org.eclipse.persistence.sdo.SDOType
aHelperContext, isDataType, xmlDescriptor
 
Constructor Summary
SDOChangeSummaryType(SDOTypeHelper sdoTypeHelper)
           
 
Method Summary
 java.lang.Object get(Property property)
          Returns the value of the specified instance property of this Type.
 java.util.List getAliasNames()
          Return a list of alias names for this Type.
 java.util.List getBaseTypes()
          Returns the List of base Types for this Type.
 java.util.List getDeclaredProperties()
          Returns the Properties declared in this Type as opposed to those declared in base Types.
 java.util.List getInstanceProperties()
          Returns a read-only List of instance Properties available on this Type.
 java.lang.String getName()
          Returns the name of the type.
 java.util.List getProperties()
          Returns the List of the Properties of this type.
 SDOProperty getProperty(java.lang.String propertyName)
          Returns from all the Properties of this type, the one with the specified name.
 java.lang.String getURI()
          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).
 boolean isAbstract()
          Indicates if this Type is abstract.
 boolean isChangeSummaryType()
           
 boolean isDataType()
          Indicates if this Type specifies DataTypes (true) or DataObjects (false).
 boolean isInstance(java.lang.Object object)
          Returns whether the specified object is an instance of this type.
 boolean isOpen()
          Indicates if this Type allows any form of open content.
 boolean isSequenced()
          Indicates if this Type specifies Sequenced DataObjects.
 
Methods inherited from class org.eclipse.persistence.sdo.SDOType
addAliasName, addBaseType, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, addDeclaredProperty, equals, getAppInfoElements, getAppInfoMap, getChangeSummaryProperty, getDeclaredPropertiesMap, getHelperContext, getImplClass, getImplClassName, getInstanceClass, getInstanceClassName, getNonFinalizedMappingURIs, getNonFinalizedReferencingProps, getPropertiesArray, getPropertyValues, getPseudoDefault, getQName, getSubTypes, getXmlDescriptor, getXsdLocalName, getXsdType, initializeNamespaces, isDataObjectType, isFinalized, isOpenSequencedType, isSubType, isTypeType, isWrapperType, isXsd, isXsdList, postInitialize, preInitialize, removeDeclaredProperties, setAbstract, setAliasNames, setAppInfoElements, setBaseTypes, setDataType, setFinalized, setImplClassName, setInstanceClass, setInstanceClassName, setInstanceProperty, setMixed, setNonFinalizedMappingURIs, setNonFinalizedReferencingProps, setOpen, setPropertyValues, setPseudoDefault, setQName, setSequenced, setSubTypes, setupInheritance, setXmlDescriptor, setXsd, setXsdList, setXsdLocalName, setXsdType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface commonj.sdo.Type
getInstanceClass
 

Constructor Detail

SDOChangeSummaryType

public SDOChangeSummaryType(SDOTypeHelper sdoTypeHelper)
Method Detail

get

public java.lang.Object get(Property property)
Description copied from interface: Type
Returns the value of the specified instance property of this Type.

Specified by:
get in interface Type
Overrides:
get in class SDOType
Parameters:
property - one of the properties returned by Type.getInstanceProperties().
Returns:
the value of the specified property.
See Also:
DataObject.get(Property)

getAliasNames

public java.util.List getAliasNames()
Description copied from interface: Type
Return a list of alias names for this Type.

Specified by:
getAliasNames in interface Type
Overrides:
getAliasNames in class SDOType
Returns:
a list of alias names for this Type.

getBaseTypes

public java.util.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
Overrides:
getBaseTypes in class SDOType
Returns:
the List of base Types for this Type.

getDeclaredProperties

public java.util.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
Overrides:
getDeclaredProperties in class SDOType
Returns:
the Properties declared in this Type.

getInstanceProperties

public java.util.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
Overrides:
getInstanceProperties in class SDOType
Returns:
the List of instance Properties on this Type.

getName

public java.lang.String getName()
Description copied from interface: Type
Returns the name of the type.

Specified by:
getName in interface Type
Overrides:
getName in class SDOType
Returns:
the type name.

getProperties

public java.util.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
Overrides:
getProperties in class SDOType
Returns:
the Properties of the type.
See Also:
Property.getContainingType()

getProperty

public SDOProperty getProperty(java.lang.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
Overrides:
getProperty in class SDOType
Returns:
the Property with the specified name.
See Also:
Type.getProperties()

getURI

public java.lang.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
Overrides:
getURI in class SDOType
Returns:
the namespace URI.

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
Overrides:
isAbstract in class SDOType
Returns:
true if this Type is abstract.

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
Overrides:
isDataType in class SDOType
Returns:
true if Type specifies DataTypes, false for DataObjects.

isInstance

public boolean isInstance(java.lang.Object object)
Description copied from interface: Type
Returns whether the specified object is an instance of this type.

Specified by:
isInstance in interface Type
Overrides:
isInstance in class SDOType
Parameters:
object - the object in question.
Returns:
true if the object is an instance.
See Also:
Class.isInstance(java.lang.Object)

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
Overrides:
isOpen in class SDOType
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
Overrides:
isSequenced in class SDOType
Returns:
true if this Type specifies Sequenced DataObjects.

isChangeSummaryType

public boolean isChangeSummaryType()
Overrides:
isChangeSummaryType in class SDOType

EclipseLink 2.0.0, build 'v20091127-r5931' API Reference