org.plasma.sdo
Interface PlasmaProperty

All Superinterfaces:

Property

All Known Implementing Classes:

CoreProperty

public interface PlasmaProperty
extends Property

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

Field Summary

static PlasmaProperty	INSTANCE_PROPERTY_BOOLEAN_ISOPERATIONAL
static PlasmaProperty	INSTANCE_PROPERTY_BOOLEAN_ISUNIQUE
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_LOCAL_NAME_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_NAME_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_PHYSICAL_NAME_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_QUALIFIED_NAME_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_QUALIFIED_PHYSICAL_NAME_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_BYTES_URI_BYTES
static PlasmaProperty	INSTANCE_PROPERTY_INT_MAXLENGTH
static PlasmaProperty	INSTANCE_PROPERTY_LONG_SNAPSHOT_TIMESTAMP
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_CONCURRENCY_USER
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_CONCURRENCY_VERSION
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_DESCRIPTION
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_IS_LOCKED_PROPERTY
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_LOCKING_TIMESTAMP
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_LOCKING_USER
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_ORIGINATION_TIMESTAMP
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_ORIGINATION_USER
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_PRIKEY_PROPERTIES
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_QUALIFIED_NAME
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_SNAPSHOT_DATE_PROPERTY
static PlasmaProperty	INSTANCE_PROPERTY_OBJECT_VISIBILITY
static PlasmaProperty	INSTANCE_PROPERTY_STRING_LOCAL_NAME
static PlasmaProperty	INSTANCE_PROPERTY_STRING_NAMESPACE_PHYSICAL_NAME
static PlasmaProperty	INSTANCE_PROPERTY_STRING_NAMESPACE_URI
static PlasmaProperty	INSTANCE_PROPERTY_STRING_PHYSICAL_NAME
static PlasmaProperty	INSTANCE_PROPERTY_STRING_UUID

Method Summary

Alias	getAlias() Returns the alias for this property if exists, or null if not exists
Concurrent	getConcurrent() Returns the concurrent information for this property if exists, or null if not exists
DataFlavor	getDataFlavor() For data type properties, returns the data flavor associated with the property data type.
Derivation	getDerivation() Returns the derivation information for this property if exists, or null if not exists
PlasmaProperty	getDerivationSupplier() Returns the derivation supplier property for this property or null if not exists.
List<Comment>	getDescription()
String	getDescriptionText()
EnumerationConstraint	getEnumerationConstraint() Returns the enumeration constraint information for this property if exists, or null if not exists
Key	getKey() Returns the key information for this property if exists, or null if not exists
PlasmaProperty	getKeySupplier() Returns the key supplier property for this property or null if not exists.
String	getLocalName() Returns the local name alias for this Property if exists, or otherwise the property name
byte[]	getLocalNameBytes() Returns the local name of this Property as a byte array which may be cached or lazily cached on demand.
long	getMaxLength() Returns the maximum length allowed this property, or -1 if no maximum length is defined.
byte[]	getNameBytes() Returns the logical name of this Property as a byte array which may be cached or lazily cached on demand.
String	getPhysicalName() Returns the physical name alias for this property if exists, or null if not exists
byte[]	getPhysicalNameBytes() Returns the physical name alias of this Property as a byte array which may be cached or lazily cached on demand, or null if no physical alias name exists.
Enumeration	getRestriction()
Sort	getSort() Returns the sorting information for this property if exists, or null if not exists
Temporal	getTemporal() Returns the temporal information for this property if exists, or null if not exists
UniqueConstraint	getUniqueConstraint() Returns the unique constraint information for this property if exists, or null if not exists
ValueConstraint	getValueConstraint() Returns the value constraint information for this property if exists, or null if not exists
ValueSetConstraint	getValueSetConstraint() Returns the value-set constraint information for this property if exists, or null if not exists
XmlProperty	getXmlProperty() Returns the XML property information for this property if exists, or null if not exists
boolean	isConcurrent() Returns true if this property is tagged as concurrent.
boolean	isConcurrent(ConcurrencyType type, ConcurrentDataFlavor dataFlavor) Returns true if this property is tagged as concurrent for the given concurrency type and data flavor.
boolean	isKey() Returns true if the key information for this property if exists.
boolean	isKey(KeyType keyType) Returns true if the key information for this property if exists and the key type is set to the given type.
boolean	isXMLAttribute() Returns true if this property is rendered within an XML document as an XML attribute.

Methods inherited from interface commonj.sdo.Property

get, getAliasNames, getContainingType, getDefault, getInstanceProperties, getName, getOpposite, getType, isContainment, isMany, isNullable, isOpenContent, isReadOnly

Field Detail

INSTANCE_PROPERTY_STRING_UUID

static final PlasmaProperty INSTANCE_PROPERTY_STRING_UUID

INSTANCE_PROPERTY_LONG_SNAPSHOT_TIMESTAMP

static final PlasmaProperty INSTANCE_PROPERTY_LONG_SNAPSHOT_TIMESTAMP

INSTANCE_PROPERTY_BOOLEAN_ISOPERATIONAL

static final PlasmaProperty INSTANCE_PROPERTY_BOOLEAN_ISOPERATIONAL

INSTANCE_PROPERTY_INT_MAXLENGTH

static final PlasmaProperty INSTANCE_PROPERTY_INT_MAXLENGTH

INSTANCE_PROPERTY_BOOLEAN_ISUNIQUE

static final PlasmaProperty INSTANCE_PROPERTY_BOOLEAN_ISUNIQUE

INSTANCE_PROPERTY_OBJECT_PRIKEY_PROPERTIES

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_PRIKEY_PROPERTIES

INSTANCE_PROPERTY_OBJECT_CONCURRENCY_USER

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_CONCURRENCY_USER

INSTANCE_PROPERTY_OBJECT_CONCURRENCY_VERSION

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_CONCURRENCY_VERSION

INSTANCE_PROPERTY_OBJECT_LOCKING_USER

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_LOCKING_USER

INSTANCE_PROPERTY_OBJECT_LOCKING_TIMESTAMP

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_LOCKING_TIMESTAMP

INSTANCE_PROPERTY_OBJECT_ORIGINATION_USER

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_ORIGINATION_USER

INSTANCE_PROPERTY_OBJECT_ORIGINATION_TIMESTAMP

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_ORIGINATION_TIMESTAMP

INSTANCE_PROPERTY_OBJECT_DESCRIPTION

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_DESCRIPTION

INSTANCE_PROPERTY_STRING_NAMESPACE_URI

static final PlasmaProperty INSTANCE_PROPERTY_STRING_NAMESPACE_URI

INSTANCE_PROPERTY_STRING_NAMESPACE_PHYSICAL_NAME

static final PlasmaProperty INSTANCE_PROPERTY_STRING_NAMESPACE_PHYSICAL_NAME

INSTANCE_PROPERTY_STRING_PHYSICAL_NAME

static final PlasmaProperty INSTANCE_PROPERTY_STRING_PHYSICAL_NAME

INSTANCE_PROPERTY_OBJECT_VISIBILITY

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_VISIBILITY

INSTANCE_PROPERTY_STRING_LOCAL_NAME

static final PlasmaProperty INSTANCE_PROPERTY_STRING_LOCAL_NAME

INSTANCE_PROPERTY_BYTES_NAME_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_NAME_BYTES

INSTANCE_PROPERTY_BYTES_URI_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_URI_BYTES

INSTANCE_PROPERTY_BYTES_PHYSICAL_NAME_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_PHYSICAL_NAME_BYTES

INSTANCE_PROPERTY_BYTES_LOCAL_NAME_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_LOCAL_NAME_BYTES

INSTANCE_PROPERTY_OBJECT_QUALIFIED_NAME

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_QUALIFIED_NAME

INSTANCE_PROPERTY_BYTES_QUALIFIED_NAME_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_QUALIFIED_NAME_BYTES

INSTANCE_PROPERTY_BYTES_QUALIFIED_PHYSICAL_NAME_BYTES

static final PlasmaProperty INSTANCE_PROPERTY_BYTES_QUALIFIED_PHYSICAL_NAME_BYTES

INSTANCE_PROPERTY_OBJECT_SNAPSHOT_DATE_PROPERTY

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_SNAPSHOT_DATE_PROPERTY

INSTANCE_PROPERTY_OBJECT_IS_LOCKED_PROPERTY

static final PlasmaProperty INSTANCE_PROPERTY_OBJECT_IS_LOCKED_PROPERTY

Method Detail

getDataFlavor

DataFlavor getDataFlavor()

For data type properties, returns the data flavor associated with the property data type.

Returns:

the data flavor associated with the property data type

Throws:

UnsupportedOperationException - when the property is not a data type property i.e. when property.getType().isDataType() returns false.

getDescription

List<Comment> getDescription()

getDescriptionText

String getDescriptionText()

getRestriction

Enumeration getRestriction()

isXMLAttribute

boolean isXMLAttribute()

Returns true if this property is rendered within an XML document as an XML attribute. This determination is based on 1.) whether the XmlProperty information exists for this property and the nodeType is 'attribute' and then 2.) on a simple algorithm based on the data type and data flavor.

Returns:

true if this property is rendered within an XML document as an XML attribute.

See Also:

XmlProperty, XmlNodeType

getAlias

Alias getAlias()

Returns the alias for this property if exists, or null if not exists

Returns:

the alias, or null if not exists

See Also:

Alias

getNameBytes

byte[] getNameBytes()

Returns the logical name of this Property 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 logical name alias as a byte array.

getPhysicalName

String getPhysicalName()

Returns the physical name alias for this property if exists, or null if not exists

Returns:

the physical name alias, or null if not exists

See Also:

Alias

getPhysicalNameBytes

byte[] getPhysicalNameBytes()

Returns the physical name alias of this Property 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 Property as a byte array, or null if no physical alias name exists.

getLocalName

String getLocalName()

Returns the local name alias for this Property if exists, or otherwise the property name

Returns:

the local name alias for this Property if exists, or otherwise the property name

See Also:

Alias

getLocalNameBytes

byte[] getLocalNameBytes()

Returns the local name of this Property 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 Property as a byte array

getKey

Key getKey()

Returns the key information for this property if exists, or null if not exists

Returns:

the key information, or null if not exists

See Also:

Key

isKey

boolean isKey()

Returns true if the key information for this property if exists.

Parameters:

keyType - the key type

Returns:

true if the key information for this property if exists

See Also:

Key

isKey

boolean isKey(KeyType keyType)

Returns true if the key information for this property if exists and the key type is set to the given type.

Parameters:

keyType - the key type

Returns:

true if the key information for this property if exists and the key type is set to the given type

See Also:

KeyType

getKeySupplier

PlasmaProperty getKeySupplier()

Returns the key supplier property for this property or null if not exists.

Returns:

the key supplier property for this property or null if not exists.

getConcurrent

Concurrent getConcurrent()

Returns the concurrent information for this property if exists, or null if not exists

Returns:

the concurrent information, or null if not exists

See Also:

Concurrent

isConcurrent

boolean isConcurrent()

Returns true if this property is tagged as concurrent.

Returns:

true if this property is tagged as concurrent.

isConcurrent

boolean isConcurrent(ConcurrencyType type,
                     ConcurrentDataFlavor dataFlavor)

Returns true if this property is tagged as concurrent for the given concurrency type and data flavor.

Parameters:

type - the concurrency type

dataFlavor - concurrency data flavor

Returns:

true if this property is tagged as concurrent for the given concurrency type and data flavor.

getTemporal

Temporal getTemporal()

Returns the temporal information for this property if exists, or null if not exists

Returns:

the temporal information, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

Temporal

getEnumerationConstraint

EnumerationConstraint getEnumerationConstraint()

Returns the enumeration constraint information for this property if exists, or null if not exists

Returns:

the enumeration constraint information, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

Temporal

getValueSetConstraint

ValueSetConstraint getValueSetConstraint()

Returns the value-set constraint information for this property if exists, or null if not exists

Returns:

the value-set constraint information, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

ValueSetConstraint

getSort

Sort getSort()

Returns the sorting information for this property if exists, or null if not exists

Returns:

the sorting information, or null if not exists

See Also:

Sequence

getMaxLength

long getMaxLength()

Returns the maximum length allowed this property, or -1 if no maximum length is defined.

Returns:

the maximum length or -1 if no maximum length is defined

getValueConstraint

ValueConstraint getValueConstraint()

Returns the value constraint information for this property if exists, or null if not exists

Returns:

the value constraint, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

ValueConstraint

getUniqueConstraint

UniqueConstraint getUniqueConstraint()

Returns the unique constraint information for this property if exists, or null if not exists

Returns:

the unique constraint information, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

ValueConstraint

getXmlProperty

XmlProperty getXmlProperty()

Returns the XML property information for this property if exists, or null if not exists

Returns:

the XML property information, or null if not exists

Throws:

IllegalArgumentException - if the property's type is not a data type, e.g. if property.getType().isDataType() returns false.

See Also:

XmlProperty

getDerivation

Derivation getDerivation()

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

Returns:

the derivation information, or null if not exists

getDerivationSupplier

PlasmaProperty getDerivationSupplier()

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

Returns:

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