org.hibernate.ogm.model.key.spi

Interface AssociatedEntityKeyMetadata

public interface AssociatedEntityKeyMetadata

Provides meta-data about a one-to-one/many-to-one association represented by one or more columns contained within a Tuple.

Author:

Davide D'Alto, Gunnar Morling

Method Summary

Modifier and Type	Method and Description
String[]	getAssociationKeyColumns() get the names of those columns of a tuple or association row which make up the represented association, i.e.
String	getCorrespondingEntityKeyColumn(String associationKeyColumn) Returns the name of the column in the target entity key corresponding to the given association key column.
EntityKeyMetadata	getEntityKeyMetadata() Get the meta-data for the entity key on the other side of the represented association.

Method Detail

getEntityKeyMetadata

EntityKeyMetadata getEntityKeyMetadata()

Get the meta-data for the entity key on the other side of the represented association.

Returns:

The entity key meta-data

getCorrespondingEntityKeyColumn

String getCorrespondingEntityKeyColumn(String associationKeyColumn)

Returns the name of the column in the target entity key corresponding to the given association key column.

E.g. let there be an entity key comprising the columns id.countryCode and id.sequenceNo which is referenced by the columns address_id.countryCode and address_id.sequenceNo. When invoked for the column address_id.countryCode, this method will return id.countryCode.

Parameters:

associationKeyColumn - The name of the column in the association

Returns:

The name of the corresponding column in the referenced entity key

getAssociationKeyColumns

String[] getAssociationKeyColumns()

get the names of those columns of a tuple or association row which make up the represented association, i.e. the columns referring to the entity key on the other side.

Returns:

The association key columns names