public interface PlasmaType
extends commonj.sdo.Type
type of a data object.| 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).
|
List<Comment> getDescription()
Type.Type.Classifier getClassifier()
TypeTypeString getDescriptionText()
Type.Type.byte[] getURIBytes()
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.
Type as a byte arrayString getURIPhysicalName()
Type as a string, or null if no physical alias name
exists.Type as a
string, or null if no physical alias name exists..byte[] getURIPhysicalNameBytes()
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.
Type as a byte array, or null if no physical
alias name exists.byte[] getNameBytes()
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.
Type as a byte arrayString getPhysicalName()
Type as a
string, or null if no physical alias name exists.Type as a
string, or null if no physical alias name exists..byte[] getPhysicalNameBytes()
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.
Type as a byte
array, or null if no physical alias name exists.String getLocalName()
Type as a string.Type as a string.byte[] getLocalNameBytes()
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.
Type as a byte arrayQName getQualifiedName()
byte[] getQualifiedNameBytes()
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.
Type as
a byte arrayint getQualifiedNameHashCode()
Type.Type.QName getQualifiedPhysicalName()
byte[] getQualifiedPhysicalNameBytes()
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.
Type as
a byte arrayorg.plasma.sdo.Alias getAlias()
Typeorg.plasma.sdo.Derivation getDerivation()
Type if exists,
or null if not existsPlasmaType getDerivationSupplier()
Type or null if
not exists.Type or null if
not exists.String getPackageName()
Type as a string, or null if no package exists.Type as a string, or null if no package exists.String getPackagePhysicalName()
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.Type as a string, or null if no physical
name alias exists.byte[] getPackagePhysicalNameBytes()
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.
Type as a byte array, or null if no physical alias name exists.List<commonj.sdo.Property> getDeclaredPropertiesSorted()
Type as opposed to those declared in base Types.
Properties are alphabetically sorted by name.Type.List<Object> search(commonj.sdo.Property property)
Type and its base
types mapped to the given instance property.property - one of the properties returned by Type.getInstanceProperties()
.Type and its base types mapped
to the given instance propertycommonj.sdo.Property findProperty(String name)
Type and its base
types with the given property name, or null if not existsname - the property nameType and its base
types with the given property name, or null if not existscommonj.sdo.Property findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType,
org.plasma.sdo.profile.ConcurrentDataFlavor dataFlavor)
Type and its base
types tagged with the given concurrency type and data flavor.concurrencyType - the concurrency typedataFlavor - the concurrency data flavorType and its base
types tagged with the given concurrency type and data flavor, or
null if not existscommonj.sdo.Property findProperty(org.plasma.sdo.profile.ConcurrencyType concurrencyType)
commonj.sdo.Property findProperty(org.plasma.sdo.profile.KeyType keyType)
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.keyType - the key typeType 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.List<commonj.sdo.Property> findProperties(org.plasma.sdo.profile.KeyType keyType)
Type and its base
types tagged with the given key type.keyType - the key typeType and its base types
tagged with the given key type, or null if not exists.Class<?> toDataTypeInstanceClass(org.plasma.sdo.DataType dataType)
dataType - boolean isBaseType(PlasmaType other)
other - the base type candidateList<commonj.sdo.Type> getSubTypes()
Type. An empty list is returned if no sub types exist.Type. An empty list is returned if no sub types exist.boolean isSubType(PlasmaType other)
Type.other - the sub type candidateType.boolean isRelation(PlasmaType other, AssociationPath relationPath)
Type across any number of traversals or hops as qualified by the given
relation path type.other - the other typerelationPath - the relation path typeType across any number of traversals or hops as qualified by the
given relation path type.String getId()
boolean isConcurrent()
Copyright © 2021. All rights reserved.