com.ibm.websphere.projector.md
Interface EntityMetadata

public interface EntityMetadata

The metadata for an entity. An entity is a collection of data that consists of a set of keys and/or values.

Entities can be associated to other entities only if the entity has a key and a name.

Since:

WAS XD 6.1

Method Summary

AccessType	getAccessType() The method in which the persistent state of the entity is accessed by the runtime.
int	getId() Get the internally generated identifier for this entity.
EntityMetadata	getIdClassMetadata() Return the EntityMetadata that represents the composite key class metadata for this EntityMetadata.
TupleMetadata	getKeyMetadata() The TupleMetadata for the entity's key.
Class	getMetadataClass() Retrieve the entity class that is associated with this metadata.
String	getMetadataClassName() Retrieve the entity class name that is associated with this metadata.
String	getName() Get the name for this entity.
EntityMetadata	getSupersetEntityMetadata() Return the EntityMetadata for the superset of this EntityMetadata.
TupleMetadata	getValueMetadata() The TupleMetadata for the entity's value.
boolean	isSchemaRoot() Return true if this EntityMetadata represents the root of the entity schema.

Method Detail

getId

int getId()

Get the internally generated identifier for this entity. Each entity has a unique id within a schema.

Returns:

the id of this EntityMetadata

getName

String getName()

Get the name for this entity.

Returns:

the name for this entity or null if this entity is not addressable (anonymous).

getKeyMetadata

TupleMetadata getKeyMetadata()

The TupleMetadata for the entity's key. If the key does not contain any attributes, then this entity represents a value-only entity and cannot be the target of an association.

Returns:

the TupleMetadata for the entity's key.

getValueMetadata

TupleMetadata getValueMetadata()

The TupleMetadata for the entity's value. If the value does not contain any attributes or associations, then this entity represents a key-only entity.

Returns:

the TupleMetadata for the entity's value.

getMetadataClass

Class getMetadataClass()

Retrieve the entity class that is associated with this metadata.

Returns:

the class that the metadata is associated with or void.class if there is no metadata class.

getAccessType

AccessType getAccessType()

The method in which the persistent state of the entity is accessed by the runtime.

If the entity has field-based access, the runtime accesses instance variables directly.

If the entity has property-based access, the runtime accesses persistent state using property accessor methods.

Returns:

the AccessType

getSupersetEntityMetadata

EntityMetadata getSupersetEntityMetadata()

Return the EntityMetadata for the superset of this EntityMetadata.

Returns:

the superset of this subset EntityMetadata or null if this EntityMetadata is not a subset of another EntityMetadata

getIdClassMetadata

EntityMetadata getIdClassMetadata()

Return the EntityMetadata that represents the composite key class metadata for this EntityMetadata.

Returns:

the IdClass that is associated with this entity or null if no IdClass was specified.

isSchemaRoot

boolean isSchemaRoot()

Return true if this EntityMetadata represents the root of the entity schema. There can only be one root per schema.

Returns:

true if this EntityMetadata is the root of the schema.

getMetadataClassName

String getMetadataClassName()

Retrieve the entity class name that is associated with this metadata. If there is no class associated with this entity metadata, getMetadataClass() will return void.class. This method will return the class name that was specified in the entity descriptor file.

If this EntityMetadata has no class associated with it, the name returned will be in the format of "@".

Returns:

the class name or the class less entity metadata identifier.

Since:

7.0.0.0 FIX2