org.hibernate.ogm.model.key.spi

Interface IdSourceKeyMetadata

public interface IdSourceKeyMetadata

Meta-data about an id sequence source. In the case of table-based generators, corresponds to the table used by one ore more generators. In the case of sequence-based generators, corresponds to one sequence.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdSourceKeyMetadata.IdSourceType The type of an id sequence source.

Method Summary

Modifier and Type	Method and Description
String	getKeyColumnName() Get the key column name for table-based sources, null otherwise.
String	getName() Returns the table name for table-based sources, the sequence name otherwise.
IdSourceKeyMetadata.IdSourceType	getType() Get the type of the represented id source.
String	getValueColumnName() Get the value column name for table-based sources, null otherwise.

Method Detail

getType

IdSourceKeyMetadata.IdSourceType getType()

Get the type of the represented id source.

Returns:

type of the id source

getName

String getName()

Returns the table name for table-based sources, the sequence name otherwise.

Returns:

the table name for table-based sources, the sequence name otherwise

getKeyColumnName

String getKeyColumnName()

Get the key column name for table-based sources, null otherwise.

Returns:

the key column name for table-based sources, null otherwise.

getValueColumnName

String getValueColumnName()

Get the value column name for table-based sources, null otherwise.

Returns:

the value column name for table-based sources, null otherwise.