org.hibernate.ogm.datastore.redis.dialect.value

Class Entity

java.lang.Object

org.hibernate.ogm.datastore.redis.dialect.value.StructuredValue

org.hibernate.ogm.datastore.redis.dialect.value.Entity

public class Entity
extends StructuredValue

Contains the information related to a Tuple. The use of this class is to serialize and deserialize the JSON stored in Redis; Documents have the following structure:

 
 {
     "name": "Bob",
     "login": "dude",
     "homeAddress": {
         "street2": null,
         "street1": "1 avenue des Champs Elysees",
         "country": "France",
         "city": "Paris"
     },
 }
 
 

Implementation note: The entity's properties are stored in a map, with embedded properties being represented by dot-separated property paths. When (de-)serializing this document from/to JSON via Jackson, this flat representation is converted into a hierarchical representation using nested maps (if embedded properties are present).

Author:

Andrea Boriero <dreborier@gmail.com>, Gunnar Morling, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
Set<String>	getKeys()
Map<String,Object>	getProperties() Returns all properties of this entity, including its revision.
Map<String,Object>	getPropertiesAsHierarchy() Returns a map with all non-static properties.
Object	getProperty(String dotPath)
static boolean	isEmbeddedProperty(String columnName)
boolean	isEmpty()
static void	putEmbeddedProperty(Map<String,Object> root, String name, Object value) Adds the given embedded property indirectly to the given map, creating any intermediary embedded maps as required.
void	set(String name, Object value) Invoked by Jackson for any non-static property.
void	unset(String name)

Methods inherited from class org.hibernate.ogm.datastore.redis.dialect.value.StructuredValue

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Entity

public Entity()

Method Detail

getProperties

public Map<String,Object> getProperties()

Returns all properties of this entity, including its revision.

Returns:

all properties of this entity

getPropertiesAsHierarchy

public Map<String,Object> getPropertiesAsHierarchy()

Returns a map with all non-static properties. Will contain nested maps in case of embedded objects. Invoked by Jackson during serialization.

Returns:

a map with all non-static properties

putEmbeddedProperty

public static void putEmbeddedProperty(Map<String,Object> root,
                                       String name,
                                       Object value)

Adds the given embedded property indirectly to the given map, creating any intermediary embedded maps as required.

Parameters:

root - the root map to which the embedded property will be added

name - the dot-separated path denoting the property to add

value - the value of the property

isEmbeddedProperty

public static boolean isEmbeddedProperty(String columnName)

set

public void set(String name,
                Object value)

Invoked by Jackson for any non-static property.

A Map creates an additional set of properties, one for each entry of the map.

Parameters:

name - the property name

value - the property value

unset

public void unset(String name)

isEmpty

public boolean isEmpty()

getKeys

public Set<String> getKeys()

getProperty

public Object getProperty(String dotPath)