org.plasma.sdo
Interface PlasmaType

All Superinterfaces:

Type

All Known Implementing Classes:

CoreType

public interface PlasmaType
extends Type

A representation of the type of a type of a data object.

Method Summary

List<Property>	findProperties(KeyType keyType) Returns the declared property from this type and its base types tagged with the given key type.
Property	findProperty(ConcurrencyType concurrencyType, ConcurrentDataFlavor dataFlavor) Returns the declared property from this type and its base types tagged with the given concurrency type and data flavor.
Property	findProperty(KeyType keyType) Returns the declared property from this type and its base types tagged with the given key type.
Property	findProperty(String name) Returns the declared property from this type and its base types with the given property name, or null if not exists
Alias	getAlias() Returns the alias for this type
Classifier	getClassifier()
List<Property>	getDeclaredPropertiesSorted() Returns an alphabetically sorted list of the Properties declared in this Type as opposed to those declared in base Types.
Derivation	getDerivation() Returns the derivation information for this type if exists, or null if not exists
PlasmaType	getDerivationSupplier() Returns the derivation supplier type for this type or null if not exists.
List<Comment>	getDescription()
String	getDescriptionText()
String	getLocalName() Returns the local name alias of this Type as a string.
byte[]	getLocalNameBytes() Returns the local name of this Type as a byte array which may be cached or lazily cached on demand.
byte[]	getNameBytes() Returns the name of this Type as a byte array which may be cached or lazily cached on demand.
String	getPackageName() Returns the logical name of the model package (if any) associated with this Type as a string, or null if no package exists.
String	getPackagePhysicalName() Returns the physical name alias of the model package (if any) associated with this Type as a string, or null if no physical name alias exists.
String	getPhysicalName() Returns the physical name alias of this Type as a string, or null if no physical alias name exists.
byte[]	getPhysicalNameBytes() Returns the physical name alias of this Type as a byte array which may be cached or lazily cached on demand, or null if no physical alias name exists.
QName	getQualifiedName() Return the namespace qualified logical name for this type.
byte[]	getQualifiedNameBytes() Returns the namespace qualified logical name of this Type as a byte array which may be cached or lazily cached on demand.
int	getQualifiedNameHashCode() Returns a qualified logical-name hash code for this type.
QName	getQualifiedPhysicalName() Return the namespace qualified physical name for this type or null if no physical alias name exists.
byte[]	getQualifiedPhysicalNameBytes() Returns the namespace qualified physical name of this Type as a byte array which may be cached or lazily cached on demand.
List<Type>	getSubTypes() Returns a list of types which specialize or inherit from this type.
byte[]	getURIBytes() Returns the URI of this Type as a byte array which may be cached or lazily cached on demand.
boolean	isBaseType(PlasmaType other) Returns true if the given type is a base type for this type.
boolean	isRelation(PlasmaType other, AssociationPath relationPath) Returns true if the given type is linked or related to this type across any number of traversals or hops as qualified by the given relation path type.
boolean	isSubType(PlasmaType other) Returns true if the given type is a specialization or inherits from this type.
List<Object>	search(Property property) Collects and returns all values from this type and its base types mapped to the given instance property.
Class<?>	toDataTypeInstanceClass(DataType dataType) Returns a Java class for the given SDO data-type (as per the SDO Specification 2.10 Section 8.1).

Methods inherited from interface commonj.sdo.Type

get, getAliasNames, getBaseTypes, getDeclaredProperties, getInstanceClass, getInstanceProperties, getName, getProperties, getProperty, getURI, isAbstract, isDataType, isInstance, isOpen, isSequenced

Method Detail

getDescription

List<Comment> getDescription()

getClassifier

Classifier getClassifier()

getDescriptionText

String getDescriptionText()

getNameBytes

byte[] getNameBytes()

Returns the name of this Type as a byte array which may be cached or lazily cached on demand.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the name of this Type as a byte array

getURIBytes

byte[] getURIBytes()

Returns the URI of this Type as a byte array which may be cached or lazily cached on demand.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the URI of this Type as a byte array

getPhysicalName

String getPhysicalName()

Returns the physical name alias of this Type as a string, or null if no physical alias name exists.

Returns:

the physical name alias of this Type as a string, or null if no physical alias name exists..

getPhysicalNameBytes

byte[] getPhysicalNameBytes()

Returns the physical name alias of this Type as a byte array which may be cached or lazily cached on demand, or null if no physical alias name exists.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the physical name alias of this Type as a byte array, or null if no physical alias name exists.

getLocalName

String getLocalName()

Returns the local name alias of this Type as a string.

Returns:

the local name alias of this Type as a string.

getLocalNameBytes

byte[] getLocalNameBytes()

Returns the local name of this Type as a byte array which may be cached or lazily cached on demand.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the local name of this Type as a byte array

getQualifiedName

QName getQualifiedName()

Return the namespace qualified logical name for this type. This method is provided as using a QName may be more efficient, depending on the client usage context, than performing string concatenations, particularly where hashing and hash lookups by qualified Type name are required.

Returns:

the namespace qualified logical name for this type.

getQualifiedNameBytes

byte[] getQualifiedNameBytes()

Returns the namespace qualified logical name of this Type as a byte array which may be cached or lazily cached on demand.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the namespace qualified logical name of this Type as a byte array

getQualifiedNameHashCode

int getQualifiedNameHashCode()

Returns a qualified logical-name hash code for this type.

Returns:

a qualified logical-name hash code for this type.

getQualifiedPhysicalName

QName getQualifiedPhysicalName()

Return the namespace qualified physical name for this type or null if no physical alias name exists. This method is provided as using a QName may be more efficient, depending on the client usage context, than performing string concatenations, particularly where hashing and hash lookups by qualified Type name are required.

Returns:

the namespace qualified logical name for this type or null if no physical alias name exists.

getQualifiedPhysicalNameBytes

byte[] getQualifiedPhysicalNameBytes()

Returns the namespace qualified physical name of this Type as a byte array which may be cached or lazily cached on demand.

Helps support Data Access Services for sparse, distributed "cloud" data stores typically storing lexicographically ordered row and column keys as uninterpreted arrays of bytes. Fast dynamic construction of such keys is important as such services may necessarily construct unique composite keys based in part on qualified or unqualified logical or physical type names.

Returns:

the namespace qualified physical name of this Type as a byte array

getAlias

Alias getAlias()

Returns the alias for this type

Returns:

the alias

getDerivation

Derivation getDerivation()

Returns the derivation information for this type if exists, or null if not exists

Returns:

the derivation information, or null if not exists

getDerivationSupplier

PlasmaType getDerivationSupplier()

Returns the derivation supplier type for this type or null if not exists.

Returns:

the derivation supplier type for this type or null if not exists.

getPackageName

String getPackageName()

Returns the logical name of the model package (if any) associated with this Type as a string, or null if no package exists.

Returns:

the logical name of the model package (if any) associated with this Type as a string, or null if no package exists.

getPackagePhysicalName

String getPackagePhysicalName()

Returns the physical name alias of the model package (if any) associated with this Type as a string, or null if no physical name alias exists. The package physical name alias is useful for various services, such as those providing access to relational data stores.

Returns:

the physical name alias of the model package (if any) associated with this Type as a string, or null if no physical name alias exists.

getDeclaredPropertiesSorted

List<Property> getDeclaredPropertiesSorted()

Returns an alphabetically sorted list of the Properties declared in this Type as opposed to those declared in base Types. Properties are alphabetically sorted by name.

Returns:

the Properties declared in this Type.

search

List<Object> search(Property property)

Collects and returns all values from this type and its base types mapped to the given instance property.

Parameters:

property - one of the properties returned by Type.getInstanceProperties().

Returns:

all values from this type and its base types mapped to the given instance property

findProperty

Property findProperty(String name)

Returns the declared property from this type and its base types with the given property name, or null if not exists

Parameters:

name - the property name

Returns:

the declared property from this type and its base types with the given property name, or null if not exists

findProperty

Property findProperty(ConcurrencyType concurrencyType,
                      ConcurrentDataFlavor dataFlavor)

Returns the declared property from this type and its base types tagged with the given concurrency type and data flavor.

Parameters:

concurrencyType - the concurrency type

dataFlavor - the concurrency data flavor

Returns:

the declared property from this type and its base types tagged with the given concurrency type and data flavor, or null if not exists

findProperty

Property findProperty(KeyType keyType)

Returns the declared property from this type and its base types tagged with the given key type. If more than one property is found, a warning is logged and the first property is returned.

Parameters:

keyType - the key type

Returns:

declared property from this type and its base types tagged with the given key type, or null if not exists. If more than one property is found, a warning is logged and the first property is returned.

findProperties

List<Property> findProperties(KeyType keyType)

Returns the declared property from this type and its base types tagged with the given key type.

Parameters:

keyType - the key type

Returns:

declared property from this type and its base types tagged with the given key type, or null if not exists.

toDataTypeInstanceClass

Class<?> toDataTypeInstanceClass(DataType dataType)

Returns a Java class for the given SDO data-type (as per the SDO Specification 2.10 Section 8.1).

Parameters:

dataType -

Returns:

the SDO Java class.

isBaseType

boolean isBaseType(PlasmaType other)

Returns true if the given type is a base type for this type.

Parameters:

other - the base type candidate

Returns:

true if the given type is a base type for this type.

getSubTypes

List<Type> getSubTypes()

Returns a list of types which specialize or inherit from this type. An empty list is returned if no sub types exist.

Returns:

a list of types which specialize or inherit from this type. An empty list is returned if no sub types exist.

isSubType

boolean isSubType(PlasmaType other)

Returns true if the given type is a specialization or inherits from this type.

Parameters:

other - the sub type candidate

Returns:

true if the given type is a specialization or inherits from this type.

isRelation

boolean isRelation(PlasmaType other,
                   AssociationPath relationPath)

Returns true if the given type is linked or related to this type across any number of traversals or hops as qualified by the given relation path type.

Parameters:

other - the other type

relationPath - the relation path type

Returns:

true if the given type is linked or related to this type across any number of traversals or hops as qualified by the given relation path type.