org.hibernate.ogm.datastore.redis.dialect.model.impl

Class RedisAssociation

java.lang.Object

org.hibernate.ogm.datastore.redis.dialect.model.impl.RedisAssociation

public abstract class RedisAssociation
extends Object

Represents an association stored in Redis, backed either by an association value (external storage of associations) or an association sub-tree within an entity value (embedded storage of associations).

The owning document must be written back to Redis to make changes to the rows of an association persistent in the data store.

Author:

Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
RedisAssociation()

Method Summary

Modifier and Type	Method and Description
static RedisAssociation	fromAssociationDocument(Association associationDocument) Creates a RedisAssociation from the given Association.
static RedisAssociation	fromEmbeddedAssociation(Entity entity, AssociationKeyMetadata associationKeyMetadata) Creates a RedisAssociation from the given Entity and association name.
static RedisAssociation	fromEmbeddedAssociation(Map<String,String> entity, AssociationKeyMetadata associationKeyMetadata) Creates a RedisAssociation from the given Map and association name.
abstract StructuredValue	getOwningDocument() Returns the Redis value which owns this association, either an Association or an Entity.
abstract Object	getRows() Get all the rows of this association.
abstract void	setRows(Object rows) Sets the rows of this association.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisAssociation

public RedisAssociation()

Method Detail

fromEmbeddedAssociation

public static RedisAssociation fromEmbeddedAssociation(Entity entity,
                                                       AssociationKeyMetadata associationKeyMetadata)

Creates a RedisAssociation from the given Entity and association name.

Parameters:

entity - the owner of the association

associationKeyMetadata - association key meta-data

Returns:

a RedisAssociation representing the association

fromEmbeddedAssociation

public static RedisAssociation fromEmbeddedAssociation(Map<String,String> entity,
                                                       AssociationKeyMetadata associationKeyMetadata)

Creates a RedisAssociation from the given Map and association name.

Parameters:

entity - the owner of the association

associationKeyMetadata - association key meta-data

Returns:

a RedisAssociation representing the association

fromAssociationDocument

public static RedisAssociation fromAssociationDocument(Association associationDocument)

Creates a RedisAssociation from the given Association.

Parameters:

associationDocument - the document representing the association

Returns:

a RedisAssociation of the given Association

getRows

public abstract Object getRows()

Get all the rows of this association. Does not contain columns which are part of the association key.

Returns:

a list with all the rows for this association

setRows

public abstract void setRows(Object rows)

Sets the rows of this association. The given list must not contain columns which are part of the association key.

Parameters:

rows - the rows of the association

getOwningDocument

public abstract StructuredValue getOwningDocument()

Returns the Redis value which owns this association, either an Association or an Entity.

Returns:

the StructuredValue representing the owner of the association