org.hibernate.ogm.model.spi

Interface AssociationSnapshot

All Known Implementing Classes:

AssociationRows

public interface AssociationSnapshot

Represents the association snapshot as loaded by the datastore.

Interface implemented by the datastore dialect to avoid data duplication in memory (if possible). Note that this snapshot will not be modified by the Hibernate OGM engine

Author:

Emmanuel Bernard <emmanuel@hibernate.org>

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(RowKey rowKey) Whether this snapshot contains the specified key or not.
Tuple	get(RowKey rowKey) Get the row associated to the RowKey.
Iterable<RowKey>	getRowKeys() Returns an iterable with the rows contained in this snapshot.
int	size() Returns the number of rows contained in this snapshot.

Method Detail

get

Tuple get(RowKey rowKey)

Get the row associated to the RowKey.

Parameters:

rowKey - the identifier of the row in the association

Returns:

the row with the specified key from this association, if present. null otherwise.

containsKey

boolean containsKey(RowKey rowKey)

Whether this snapshot contains the specified key or not.

Parameters:

rowKey - the identifier of the row in the association

Returns:

true if the snapshot contains the row identified by the RowKey. false otherwise

size

int size()

Returns the number of rows contained in this snapshot.

Returns:

the number of rows in the association snapshot

getRowKeys

Iterable<RowKey> getRowKeys()

Returns an iterable with the rows contained in this snapshot.

Returns:

an Iterable over the rows in the association