org.datanucleus.store.schema.table

Interface Table

All Known Implementing Classes:

CompleteClassTable

public interface Table

Representation of a table for a class.

Method Summary

Modifier and Type	Method and Description
String	getCatalogName()
AbstractClassMetaData	getClassMetaData() Accessor for the primary class metadata for this table.
Column	getColumnForName(String name) Accessor for the column with the supplied name (if present).
Column	getColumnForPosition(int pos) Accessor for the column at the specified position (numbered from 0 to numcols-1).
List<Column>	getColumns()
Column	getDatastoreIdColumn() Accessor for the surrogate datastore id column (if present).
Column	getDiscriminatorColumn() Accessor for the surrogate discriminator column (if present).
MemberColumnMapping	getMemberColumnMappingForEmbeddedMember(List<AbstractMemberMetaData> mmds) Method to return the member-column mapping for the specified embedded member.
MemberColumnMapping	getMemberColumnMappingForMember(AbstractMemberMetaData mmd) Method to return the member-column mapping for the specified member.
Set<MemberColumnMapping>	getMemberColumnMappings()
Column	getMultitenancyColumn() Accessor for the surrogate multitenancy column (if present).
String	getName()
int	getNumberOfColumns() Accessor for number of columns.
String	getSchemaName()
StoreManager	getStoreManager()
Column	getVersionColumn() Accessor for the surrogate version column (if present).

Method Detail

getStoreManager

StoreManager getStoreManager()

getName

String getName()

getSchemaName

String getSchemaName()

getCatalogName

String getCatalogName()

getClassMetaData

AbstractClassMetaData getClassMetaData()

Accessor for the primary class metadata for this table.

Returns:

Class metadata

getNumberOfColumns

int getNumberOfColumns()

Accessor for number of columns.

Returns:

Number of cols

getColumns

List<Column> getColumns()

getColumnForPosition

Column getColumnForPosition(int pos)

Accessor for the column at the specified position (numbered from 0 to numcols-1).

Parameters:

pos - Position of the column

Returns:

The column at this position (or null if invalid position)

getDatastoreIdColumn

Column getDatastoreIdColumn()

Accessor for the surrogate datastore id column (if present).

Returns:

The surrogate datastore id column (if present)

getVersionColumn

Column getVersionColumn()

Accessor for the surrogate version column (if present). If the version is persisted into a persistable field, or no version then this will be null.

Returns:

The surrogate version column (if present)

getDiscriminatorColumn

Column getDiscriminatorColumn()

Accessor for the surrogate discriminator column (if present).

Returns:

The surrogate discriminator column (if present)

getMultitenancyColumn

Column getMultitenancyColumn()

Accessor for the surrogate multitenancy column (if present).

Returns:

The surrogate multitenancy column (if present)

getColumnForName

Column getColumnForName(String name)

Accessor for the column with the supplied name (if present).

Parameters:

name - name of the column (the identifier)

Returns:

The column (or null if none present with that name)

getMemberColumnMappingForMember

MemberColumnMapping getMemberColumnMappingForMember(AbstractMemberMetaData mmd)

Method to return the member-column mapping for the specified member.

Parameters:

mmd - Metadata for the member

Returns:

The member-column mapping

getMemberColumnMappingForEmbeddedMember

MemberColumnMapping getMemberColumnMappingForEmbeddedMember(List<AbstractMemberMetaData> mmds)

Method to return the member-column mapping for the specified embedded member.

Parameters:

mmds - Metadata for the member(s) to navigate to the required member

Returns:

The member-column mapping

getMemberColumnMappings

Set<MemberColumnMapping> getMemberColumnMappings()