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()
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()
String	getName()
int	getNumberOfColumns() Accessor for number of columns.
String	getSchemaName()
StoreManager	getStoreManager()
Column	getSurrogateColumn(SurrogateColumnType colType) Accessor for the surrogate column of the specified type.

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)

getSurrogateColumn

Column getSurrogateColumn(SurrogateColumnType colType)

Accessor for the surrogate column of the specified type.

Parameters:

colType - The type of surrogate column

Returns:

The column definition, if it exists for this table

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()