com.ibm.websphere.projector.md
Interface TupleMetadata

public interface TupleMetadata

This describes the metadata for a Tuple.

Since:

WAS XD 6.1

See Also:

EntityMetadata

Method Summary

Tuple	createTuple() Create a new Tuple associated with this metadata.
TupleAssociation	getAssociation(int position) Retrieve the association metadata at the given position.
int	getAssociationPosition(String name) Retrieve the position of the named association.
TupleAttribute	getAttribute(int position) Retrieve the attribute metadata at the given position.
int	getAttributePosition(String name) Retrieve the position of the named attribute.
int	getNumAssociations() The number of associations this tuple has to other entities.
int	getNumAttributes() The number of basic attributes in this tuple
int	getVersionAttributePosition() Retrieve the position of the version attribute.

Method Detail

getNumAttributes

int getNumAttributes()

The number of basic attributes in this tuple

Returns:

the number of basic attributes defined for this tuple.

getAttribute

TupleAttribute getAttribute(int position)

Retrieve the attribute metadata at the given position.

Parameters:

position - the position of the attribute. The first attribute is in position 0;

Returns:

the attribute metadata.

getNumAssociations

int getNumAssociations()

The number of associations this tuple has to other entities.

Returns:

the number of associations defined for this tuple.

getAssociation

TupleAssociation getAssociation(int position)

Retrieve the association metadata at the given position.

Parameters:

position - the position of the association. The first association is in position 0;

Returns:

the association metadata

createTuple

Tuple createTuple()

Create a new Tuple associated with this metadata.

Returns:

a new, empty Tuple instance

getAttributePosition

int getAttributePosition(String name)

Retrieve the position of the named attribute.

Parameters:

name - the name of the attribute.

Returns:

the position of the attribute or -1 if not found.

getAssociationPosition

int getAssociationPosition(String name)

Retrieve the position of the named association.

Parameters:

name - the name of the association.

Returns:

the position of the association or -1 if not found.

getVersionAttributePosition

int getVersionAttributePosition()

Retrieve the position of the version attribute.

Returns:

the position of version attribute. It will return -1 if TupleMetadata doesn't contain a Version attribute.

See Also:

Version