org.hibernate.ogm.model.key.spi

Class IdSourceKey

java.lang.Object

org.hibernate.ogm.model.key.spi.IdSourceKey

public final class IdSourceKey
extends Object

Represents a source of an id sequence such as a table (row) or a physical sequence. This is used to identify a Sequence or a Table based id generator. At most a single column is needed: columnName and columnValue to map to the attributes of JPA's TableGenerated.

Author:

Gunnar Morling, Sanne Grinovero

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static IdSourceKey	forSequence(IdSourceKeyMetadata metadata)
static IdSourceKey	forTable(IdSourceKeyMetadata metadata, String segmentName)
String	getColumnName() Get the segment column name if this is a table-based generator, null otherwise.
String	getColumnValue() Get the segment name if this is a table-based generator, null otherwise.
IdSourceKeyMetadata	getMetadata()
String	getTable() Get the table name if this is a table-based generator, the sequence name otherwise.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

forTable

public static IdSourceKey forTable(IdSourceKeyMetadata metadata,
                                   String segmentName)

forSequence

public static IdSourceKey forSequence(IdSourceKeyMetadata metadata)

getMetadata

public IdSourceKeyMetadata getMetadata()

getTable

public String getTable()

Get the table name if this is a table-based generator, the sequence name otherwise.

Returns:

the table or the sequence name

getColumnName

public String getColumnName()

Get the segment column name if this is a table-based generator, null otherwise.

Returns:

the segment column name when using a table-based generator, null otherwise

getColumnValue

public String getColumnValue()

Get the segment name if this is a table-based generator, null otherwise.

Returns:

the segment name when using a table-based generator, null otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object