Class CompleteClassTable

java.lang.Object

org.datanucleus.store.schema.table.CompleteClassTable

All Implemented Interfaces:

Table

public class CompleteClassTable
extends Object
implements Table

Representation of a table for a class where the class is stored in "complete-table" inheritance (or in JPA "TablePerClass") whereby all members (in this class and superclasses) are handled in this table. Also assumes that any persistable fields and collection/map fields are stored in this table (i.e not usable where you have foreign keys in the datastore). Allows for each member to have potentially multiple columns (using MemberColumnMapping). Each column generated will have its position set (origin = 0) and respects "ColumnMetaData.position".

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	catalogName
(package private) AbstractClassMetaData	cmd
(package private) Map<String,Column>	columnByName	Map of DatastoreColumn, keyed by the column identifier.
(package private) List<Column>	columns
(package private) Column	datastoreIdColumn
(package private) Column	discriminatorColumn
(package private) String	identifier
(package private) Map<String, MemberColumnMapping>	mappingByEmbeddedMember	Map of member-column mapping, keyed by the navigated path of embedded members.
(package private) Map<String, MemberColumnMapping>	mappingByMember	Map of member-column mapping, keyed by the metadata for the member.
(package private) Column	multitenancyColumn
(package private) String	schemaName
(package private) SchemaVerifier	schemaVerifier
(package private) Column	softDeleteColumn
(package private) StoreManager	storeMgr
(package private) Column	versionColumn

Constructor Summary

Constructors

Constructor	Description
CompleteClassTable(StoreManager storeMgr, AbstractClassMetaData cmd, SchemaVerifier verifier)

Method Summary

Modifier and Type	Method	Description
protected ColumnImpl	addColumn(AbstractMemberMetaData mmd, String colName)
protected ColumnImpl	addColumn(AbstractMemberMetaData mmd, String colName, ColumnType colType)
protected ColumnImpl	addEmbeddedColumn(String colName, TypeConverter typeConv)
String	debugString()
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()
private String	getEmbeddedMemberNavigatedPath(List<AbstractMemberMetaData> mmds)
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.
protected TypeConverter	getTypeConverterForMember(AbstractMemberMetaData mmd, ColumnMetaData[] colmds, TypeManager typeMgr)
protected void	processEmbeddedMember(List<AbstractMemberMetaData> mmds, AbstractClassMetaData embCmd, ClassLoaderResolver clr, EmbeddedMetaData embmd, boolean ownerNested)	Handler for an embedded member.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

storeMgr

StoreManager storeMgr

cmd

AbstractClassMetaData cmd

catalogName

String catalogName

schemaName

String schemaName

identifier

String identifier

columns

List<Column> columns

versionColumn

Column versionColumn

discriminatorColumn

Column discriminatorColumn

datastoreIdColumn

Column datastoreIdColumn

multitenancyColumn

Column multitenancyColumn

softDeleteColumn

Column softDeleteColumn

mappingByMember

Map<String, MemberColumnMapping> mappingByMember

Map of member-column mapping, keyed by the metadata for the member.

mappingByEmbeddedMember

Map<String, MemberColumnMapping> mappingByEmbeddedMember

Map of member-column mapping, keyed by the navigated path of embedded members.

columnByName

Map<String,Column> columnByName

Map of DatastoreColumn, keyed by the column identifier.

schemaVerifier

SchemaVerifier schemaVerifier

Constructor Details

CompleteClassTable

public CompleteClassTable(StoreManager storeMgr,
 AbstractClassMetaData cmd,
 SchemaVerifier verifier)

Method Details

getTypeConverterForMember

protected TypeConverter getTypeConverterForMember(AbstractMemberMetaData mmd,
 ColumnMetaData[] colmds,
 TypeManager typeMgr)

processEmbeddedMember

protected void processEmbeddedMember(List<AbstractMemberMetaData> mmds,
 AbstractClassMetaData embCmd,
 ClassLoaderResolver clr,
 EmbeddedMetaData embmd,
 boolean ownerNested)

Handler for an embedded member.

Parameters:

mmds - Chain of member metadata to the embedded member

embCmd - Class metadata for the embedded member type

clr - ClassLoader resolver

embmd - Any EmbeddedMetaData defining column info

ownerNested - Whether the owner is nested

addColumn

protected ColumnImpl addColumn(AbstractMemberMetaData mmd,
 String colName)

addColumn

protected ColumnImpl addColumn(AbstractMemberMetaData mmd,
 String colName,
 ColumnType colType)

addEmbeddedColumn

protected ColumnImpl addEmbeddedColumn(String colName,
 TypeConverter typeConv)

getEmbeddedMemberNavigatedPath

private String getEmbeddedMemberNavigatedPath(List<AbstractMemberMetaData> mmds)

getClassMetaData

public AbstractClassMetaData getClassMetaData()

Description copied from interface: Table

Accessor for the primary class metadata for this table.

Specified by:

getClassMetaData in interface Table

Returns:

Class metadata

getStoreManager

public StoreManager getStoreManager()

Specified by:

getStoreManager in interface Table

getSchemaName

public String getSchemaName()

Specified by:

getSchemaName in interface Table

getCatalogName

public String getCatalogName()

Specified by:

getCatalogName in interface Table

getName

public String getName()

Specified by:

getName in interface Table

getNumberOfColumns

public int getNumberOfColumns()

Description copied from interface: Table

Accessor for number of columns.

Specified by:

getNumberOfColumns in interface Table

Returns:

Number of cols

getColumns

public List<Column> getColumns()

Specified by:

getColumns in interface Table

getColumnForPosition

public Column getColumnForPosition(int pos)

Description copied from interface: Table

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

Specified by:

getColumnForPosition in interface Table

Parameters:

pos - Position of the column

Returns:

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

getSurrogateColumn

public Column getSurrogateColumn(SurrogateColumnType colType)

Description copied from interface: Table

Accessor for the surrogate column of the specified type.

Specified by:

getSurrogateColumn in interface Table

Parameters:

colType - The type of surrogate column

Returns:

The column definition, if it exists for this table

getColumnForName

public Column getColumnForName(String name)

Description copied from interface: Table

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

Specified by:

getColumnForName in interface Table

Parameters:

name - name of the column (the identifier)

Returns:

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

getMemberColumnMappingForMember

public MemberColumnMapping getMemberColumnMappingForMember(AbstractMemberMetaData mmd)

Description copied from interface: Table

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

Specified by:

getMemberColumnMappingForMember in interface Table

Parameters:

mmd - Metadata for the member

Returns:

The member-column mapping

getMemberColumnMappingForEmbeddedMember

public MemberColumnMapping getMemberColumnMappingForEmbeddedMember(List<AbstractMemberMetaData> mmds)

Description copied from interface: Table

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

Specified by:

getMemberColumnMappingForEmbeddedMember in interface Table

Parameters:

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

Returns:

The member-column mapping

getMemberColumnMappings

public Set<MemberColumnMapping> getMemberColumnMappings()

Specified by:

getMemberColumnMappings in interface Table

toString

public String toString()

Overrides:

toString in class Object

debugString

public String debugString()