PlasmaType (Plasma Core 2.1.5 API)

All Superinterfaces:

commonj.sdo.Type

All Known Implementing Classes:

CoreType
```
public interface PlasmaType
extends commonj.sdo.Type
```
A representation of the type of a type of a data object.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<commonj.sdo.Property>`	`findProperties(org.plasma.sdo.profile.KeyType keyType)` Returns the declared property from `Type` and its base types tagged with the given key type.
`commonj.sdo.Property`	`findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType)`
`commonj.sdo.Property`	`findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType, org.plasma.sdo.profile.ConcurrentDataFlavor dataFlavor)` Returns the declared property from `Type` and its base types tagged with the given concurrency type and data flavor.
`commonj.sdo.Property`	`findProperty(org.plasma.sdo.profile.KeyType keyType)` Returns the declared property from `Type` and its base types tagged with the given key type.
`commonj.sdo.Property`	`findProperty(String name)` Returns the declared property from `Type` and its base types with the given property name, or null if not exists
`org.plasma.sdo.Alias`	`getAlias()` Returns the alias for `Type`
`Classifier`	`getClassifier()` Return the repository classifier underlying this `Type`
`List<commonj.sdo.Property>`	`getDeclaredPropertiesSorted()` Returns an alphabetically sorted list of the Properties declared in `Type` as opposed to those declared in base Types.
`org.plasma.sdo.Derivation`	`getDerivation()` Returns the derivation information for `Type` if exists, or null if not exists
`PlasmaType`	`getDerivationSupplier()` Returns the derivation supplier type for `Type` or null if not exists.
`List<Comment>`	`getDescription()` Returns the comments from the repository classifier for this `Type`.
`String`	`getDescriptionText()` Returns the concatenated comments from the repository classifier for this `Type`.
`String`	`getId()` Returns the unique id for the element within its meta data repository.
`String`	`getLocalName()` Returns the local name alias of this `Type` as a string.
`byte[]`	`getLocalNameBytes()` Returns the local name of `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 `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 `Type` as a string, or null if no physical name alias exists.
`byte[]`	`getPackagePhysicalNameBytes()` Returns the physical name alias of package containing `Type` as a byte array which may be cached or lazily cached on demand, or null if no physical alias name 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 `Type` as a byte array which may be cached or lazily cached on demand.
`int`	`getQualifiedNameHashCode()` Returns a qualified logical-name hash code for `Type`.
`QName`	`getQualifiedPhysicalName()` Return the (physical) namespace qualified physical name for this type or null if no physical namespace and physical name exists.
`byte[]`	`getQualifiedPhysicalNameBytes()` Returns the namespace qualified physical name of `Type` as a byte array which may be cached or lazily cached on demand.
`List<commonj.sdo.Type>`	`getSubTypes()` Returns a list of types which specialize or inherit from `Type`.
`byte[]`	`getURIBytes()` Returns the URI of this `Type` as a byte array which may be cached or lazily cached on demand.
`String`	`getURIPhysicalName()` Returns the physical name alias of the URI associated with this `Type` as a string, or null if no physical alias name exists.
`byte[]`	`getURIPhysicalNameBytes()` Returns the physical name alias of the URI associated this `Type` as a byte array which may be cached or lazily cached on demand, or null if no physical alias name exists.
`boolean`	`isBaseType(PlasmaType other)` Returns true if the given type is a base type for this type.
`boolean`	`isConcurrent()` Returns true if the type contains at least one property defined as concurrent.
`boolean`	`isRelation(PlasmaType other, AssociationPath relationPath)` Returns true if the given type is linked or related to `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 `Type`.
`List<Object>`	`search(commonj.sdo.Property property)` Collects and returns all values from `Type` and its base types mapped to the given instance property.
`Class<?>`	`toDataTypeInstanceClass(org.plasma.sdo.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()
```
    Returns the comments from the repository classifier for this Type.
    
    Returns:
    
    the comments from the repository classifier for this Type.
  - getClassifier
```
Classifier getClassifier()
```
    Return the repository classifier underlying this Type
    
    Returns:
    
    the repository classifier underlying this Type
  - getDescriptionText
```
String getDescriptionText()
```
    Returns the concatenated comments from the repository classifier for this Type.
    
    Returns:
    
    the concatenated comments from the repository classifier for this Type.
  - 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
  - getURIPhysicalName
```
String getURIPhysicalName()
```
    Returns the physical name alias of the URI associated with 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..
  - getURIPhysicalNameBytes
```
byte[] getURIPhysicalNameBytes()
```
    Returns the physical name alias of the URI associated 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 the URI associated this Type as a byte array, or null if no physical alias name exists.
  - 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
  - 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 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 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 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 Type as a byte array
  - getQualifiedNameHashCode
```
int getQualifiedNameHashCode()
```
    Returns a qualified logical-name hash code for Type.
    
    Returns:
    
    a qualified logical-name hash code for Type.
  - getQualifiedPhysicalName
```
QName getQualifiedPhysicalName()
```
    Return the (physical) namespace qualified physical name for this type or null if no physical namespace and physical 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 (physical) 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 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 Type as a byte array
  - getAlias
```
org.plasma.sdo.Alias getAlias()
```
    Returns the alias for Type
    
    Returns:
    
    the alias
  - getDerivation
```
org.plasma.sdo.Derivation getDerivation()
```
    Returns the derivation information for 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 Type or null if not exists.
    
    Returns:
    
    the derivation supplier type for Type or null if not exists.
  - getPackageName
```
String getPackageName()
```
    Returns the logical name of the model package (if any) associated with Type as a string, or null if no package exists.
    
    Returns:
    
    the logical name of the model package (if any) associated with 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 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 Type as a string, or null if no physical name alias exists.
  - getPackagePhysicalNameBytes
```
byte[] getPackagePhysicalNameBytes()
```
    Returns the physical name alias of package containing 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 package containing Type as a byte array, or null if no physical alias name exists.
  - getDeclaredPropertiesSorted
```
List<commonj.sdo.Property> getDeclaredPropertiesSorted()
```
    Returns an alphabetically sorted list of the Properties declared in Type as opposed to those declared in base Types. Properties are alphabetically sorted by name.
    
    Returns:
    
    the Properties declared in Type.
  - search
```
List<Object> search(commonj.sdo.Property property)
```
    Collects and returns all values from 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 Type and its base types mapped to the given instance property
  - findProperty
```
commonj.sdo.Property findProperty(String name)
```
    Returns the declared property from 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 Type and its base types with the given property name, or null if not exists
  - findProperty
```
commonj.sdo.Property findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType,
                                  org.plasma.sdo.profile.ConcurrentDataFlavor dataFlavor)
```
    Returns the declared property from 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 Type and its base types tagged with the given concurrency type and data flavor, or null if not exists
  - findProperty
```
commonj.sdo.Property findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType)
```
  - findProperty
```
commonj.sdo.Property findProperty(org.plasma.sdo.profile.KeyType keyType)
```
    Returns the declared property from 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 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<commonj.sdo.Property> findProperties(org.plasma.sdo.profile.KeyType keyType)
```
    Returns the declared property from Type and its base types tagged with the given key type.
    
    Parameters:
    
    keyType - the key type
    
    Returns:
    
    declared property from Type and its base types tagged with the given key type, or null if not exists.
  - toDataTypeInstanceClass
```
Class<?> toDataTypeInstanceClass(org.plasma.sdo.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<commonj.sdo.Type> getSubTypes()
```
    Returns a list of types which specialize or inherit from Type. An empty list is returned if no sub types exist.
    
    Returns:
    
    a list of types which specialize or inherit from 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 Type.
    
    Parameters:
    
    other - the sub type candidate
    
    Returns:
    
    true if the given type is a specialization or inherits from Type.
  - isRelation
```
boolean isRelation(PlasmaType other,
                   AssociationPath relationPath)
```
    Returns true if the given type is linked or related to 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 Type across any number of traversals or hops as qualified by the given relation path type.
  - getId
```
String getId()
```
    Returns the unique id for the element within its meta data repository.
    
    Returns:
    
    the unique id for the element within its meta data repository.
  - isConcurrent
```
boolean isConcurrent()
```
    Returns true if the type contains at least one property defined as concurrent.
    
    Returns:
    
    true if the type contains at least one property defined as concurrent.

Interface PlasmaType

Method Summary

Methods inherited from interface commonj.sdo.Type

Method Detail

getDescription

getClassifier

getDescriptionText

getURIBytes

getURIPhysicalName

getURIPhysicalNameBytes

getNameBytes

getPhysicalName

getPhysicalNameBytes

getLocalName

getLocalNameBytes

getQualifiedName

getQualifiedNameBytes

getQualifiedNameHashCode

getQualifiedPhysicalName

getQualifiedPhysicalNameBytes

getAlias

getDerivation

getDerivationSupplier

getPackageName

getPackagePhysicalName

getPackagePhysicalNameBytes

getDeclaredPropertiesSorted

search

findProperty

findProperty

findProperty

findProperty

findProperties

toDataTypeInstanceClass

isBaseType

getSubTypes

isSubType

isRelation

getId

isConcurrent