eu.ehri.project.persistence

Class Bundle

java.lang.Object

eu.ehri.project.persistence.Bundle

All Implemented Interfaces:

NestableData<Bundle>

public final class Bundle
extends Object
implements NestableData<Bundle>

Class that represents a graph entity and subtree relations prior to being materialised as vertices and edges.

Note: unlike a vertex, a bundle can contain null values in its data map, though these values will not be externally visible. Null values are however used in merge operations, where the secondary bundle's null data values will indicate that the key/value should be removed from the primary bundle's data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bundle.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_KEY
static String	ID_KEY Serialization constant definitions
static String	META_KEY
static String	REL_KEY
static String	TYPE_KEY

Method Summary

Modifier and Type	Method and Description
static com.tinkerpop.blueprints.CloseableIterable<Bundle>	bundleStream(InputStream inputStream)
Bundle	dependentsOnly() Return a bundle consisting of only dependent relations.
int	depth() The depth of this bundle tree, i.e.
String	diff(Bundle target) Return a JSON-Patch representation of the difference between this bundle and another.
boolean	equals(Object o)
Bundle	filterRelations(BiPredicate<String,Bundle> filter) Filter relations, removing items that *match* the given filter function.
Optional<Bundle>	find(Predicate<Bundle> f)
boolean	forAny(Predicate<Bundle> f) Test if a predicate function holds true for any item in the bundle, including the top level.
static Bundle	fromData(Object data) Create a bundle from raw data.
static Bundle	fromStream(InputStream stream) Create a bundle from a stream containing JSON data..
static Bundle	fromString(String json) Create a bundle from a (JSON) string.
Bundle	generateIds(Collection<String> scopes) Generate missing IDs for the subtree.
Class<?>	getBundleJavaClass() Get the target class.
Map<String,Object>	getData() Get the bundle data.
<T> T	getDataValue(String key) Get a data value by its key.
com.google.common.collect.Multimap<String,Bundle>	getDependentRelations() Get only the bundle's relations which have a dependent relationship.
String	getId() Get the id of the bundle's graph vertex (or null if it does not yet exist).
Map<String,Object>	getMetaData() Get the bundle metadata
Collection<String>	getPropertyKeys() Return a list of names for mandatory properties, as represented in the graph.
com.google.common.collect.Multimap<String,Bundle>	getRelations() Get the bundle's relation bundles.
List<Bundle>	getRelations(String relation) Get a set of relations.
EntityClass	getType() Get the type of entity this bundle represents as per the target class's entity type key.
Collection<String>	getUniquePropertyKeys() Return a list of property keys which must be unique.
boolean	hasGeneratedId() Check if this bundle as a generated ID.
int	hashCode()
boolean	hasMetaData() Check if this bundle has associated metadata.
boolean	hasRelations(String relation) Check if this bundle contains the given relation set.
Bundle	map(Function<Bundle,Bundle> f) Run a function transforming all items in the bundle, including the top level, returning a new bundle.
Bundle	mergeDataWith(Bundle otherBundle) Merge this bundle's data with that of another.
static Bundle	of(EntityClass type) Constructor for just a type.
static Bundle	of(EntityClass type, Map<String,Object> data) Constructor for bundle without existing id or relations.
static Bundle	of(EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations, Map<String,Object> meta) Factory.
Bundle	removeDataValue(String key) Remove a value in the bundle's data.
Bundle	removeRelation(String relation, Bundle item) Remove a single relation.
Bundle	replaceRelations(com.google.common.collect.Multimap<String,Bundle> relations) Set entire set of relations.
Map<String,Object>	toData() Serialize a bundle to raw data.
String	toJson() Serialize a bundle to a JSON string.
static void	toStream(Bundle bundle, OutputStream stream) Write a bundle to a JSON stream.
String	toString()
Bundle	withData(Map<String,Object> data) Set the entire data map for this bundle.
Bundle	withDataValue(String key, Object value) Set a value in the bundle's data.
Bundle	withId(String id) Get a bundle with the given id.
Bundle	withMetaData(Map<String,Object> meta) Set the entire meta data map for this bundle.
Bundle	withMetaDataValue(String key, Object value) Set a value in the bundle's meta data.
Bundle	withRelation(String relation, Bundle other) Add a bundle for a particular relation.
Bundle	withRelations(com.google.common.collect.Multimap<String,Bundle> others) Add a map of addition relationships.
Bundle	withRelations(String relation, List<Bundle> others) Set bundles for a particular relation.

Methods inherited from class java.lang.Object

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

Field Detail

ID_KEY

public static final String ID_KEY

Serialization constant definitions

See Also:

Constant Field Values

REL_KEY

public static final String REL_KEY

See Also:

Constant Field Values

DATA_KEY

public static final String DATA_KEY

See Also:

Constant Field Values

TYPE_KEY

public static final String TYPE_KEY

See Also:

Constant Field Values

META_KEY

public static final String META_KEY

See Also:

Constant Field Values

Method Detail

of

public static Bundle of(String id,
                        EntityClass type,
                        Map<String,Object> data,
                        com.google.common.collect.Multimap<String,Bundle> relations)

Factory for bundle without existing id.

Parameters:

id - The bundle's id

type - The bundle's type class

data - An initial map of data

relations - An initial set of relations

of

public static Bundle of(String id,
                        EntityClass type,
                        Map<String,Object> data,
                        com.google.common.collect.Multimap<String,Bundle> relations,
                        Map<String,Object> meta)

Factory.

Parameters:

id - The bundle's id

type - The bundle's type class

data - An initial map of data

relations - An initial set of relations

meta - An initial map of metadata

of

public static Bundle of(EntityClass type,
                        Map<String,Object> data,
                        com.google.common.collect.Multimap<String,Bundle> relations)

Factory for bundle without existing id.

Parameters:

type - The bundle's type class

data - An initial map of data

relations - An initial set of relations

of

public static Bundle of(EntityClass type)

Constructor for just a type.

Parameters:

type - The bundle's type class

of

public static Bundle of(EntityClass type,
                        Map<String,Object> data)

Constructor for bundle without existing id or relations.

Parameters:

type - The bundle's type class

data - An initial map of data

getId

public String getId()

Get the id of the bundle's graph vertex (or null if it does not yet exist).

Returns:

The bundle's id

withId

public Bundle withId(String id)

Get a bundle with the given id.

Parameters:

id - The bundle's id

getType

public EntityClass getType()

Get the type of entity this bundle represents as per the target class's entity type key.

Returns:

The bundle's type

getDataValue

public <T> T getDataValue(String key)
                   throws ClassCastException

Get a data value by its key.

Specified by:

getDataValue in interface NestableData<Bundle>

Returns:

The data value, or null if there is no data for this key

Throws:

ClassCastException - if the fetched data does not match the type requested

withDataValue

public Bundle withDataValue(String key,
                            Object value)

Set a value in the bundle's data. If value is null, this Bundle is returned.

Specified by:

withDataValue in interface NestableData<Bundle>

Parameters:

key - The data key

value - The data value

Returns:

A new bundle with value as key

withMetaDataValue

public Bundle withMetaDataValue(String key,
                                Object value)

Set a value in the bundle's meta data.

Parameters:

key - The metadata key

value - The metadata value

Returns:

A new bundle

removeDataValue

public Bundle removeDataValue(String key)

Remove a value in the bundle's data.

Specified by:

removeDataValue in interface NestableData<Bundle>

Parameters:

key - The data key to remove

Returns:

A new bundle

getData

public Map<String,Object> getData()

Get the bundle data.

Returns:

The full data map

getMetaData

public Map<String,Object> getMetaData()

Get the bundle metadata

Returns:

The full metadata map

hasMetaData

public boolean hasMetaData()

Check if this bundle has associated metadata.

Returns:

Whether metadata is present

withData

public Bundle withData(Map<String,Object> data)

Set the entire data map for this bundle.

Parameters:

data - The full data map to set

Returns:

The new bundle

withMetaData

public Bundle withMetaData(Map<String,Object> meta)

Set the entire meta data map for this bundle.

Parameters:

meta - The full metadata map to set

Returns:

The new bundle

getRelations

public com.google.common.collect.Multimap<String,Bundle> getRelations()

Get the bundle's relation bundles.

Specified by:

getRelations in interface NestableData<Bundle>

Returns:

The full set of relations

getDependentRelations

public com.google.common.collect.Multimap<String,Bundle> getDependentRelations()

Get only the bundle's relations which have a dependent relationship.

Returns:

A multimap of dependent relations.

replaceRelations

public Bundle replaceRelations(com.google.common.collect.Multimap<String,Bundle> relations)

Set entire set of relations.

Specified by:

replaceRelations in interface NestableData<Bundle>

Parameters:

relations - A full set of relations

Returns:

The new bundle

withRelations

public Bundle withRelations(com.google.common.collect.Multimap<String,Bundle> others)

Add a map of addition relationships.

Specified by:

withRelations in interface NestableData<Bundle>

Parameters:

others - Additional relationship map

Returns:

The new bundle

getRelations

public List<Bundle> getRelations(String relation)

Get a set of relations.

Specified by:

getRelations in interface NestableData<Bundle>

Parameters:

relation - A relationship key

Returns:

A given set of relations

withRelations

public Bundle withRelations(String relation,
                            List<Bundle> others)

Set bundles for a particular relation.

Specified by:

withRelations in interface NestableData<Bundle>

Parameters:

relation - A relationship key

others - A set of relations for the given key

Returns:

A new bundle

withRelation

public Bundle withRelation(String relation,
                           Bundle other)

Add a bundle for a particular relation.

Specified by:

withRelation in interface NestableData<Bundle>

Parameters:

relation - A relationship key

other - A related bundle

Returns:

A new bundle

hasRelations

public boolean hasRelations(String relation)

Check if this bundle contains the given relation set.

Specified by:

hasRelations in interface NestableData<Bundle>

Parameters:

relation - A relationship key

Returns:

Whether this bundle has relations for the given key

removeRelation

public Bundle removeRelation(String relation,
                             Bundle item)

Remove a single relation.

Parameters:

relation - A relationship key

item - The item to remove

Returns:

A new bundle

mergeDataWith

public Bundle mergeDataWith(Bundle otherBundle)

Merge this bundle's data with that of another. Relation data is merged when corresponding related items exist in the tree, but new related items are not added.

Parameters:

otherBundle - Another bundle

Returns:

A bundle with data merged

filterRelations

public Bundle filterRelations(BiPredicate<String,Bundle> filter)

Filter relations, removing items that *match* the given filter function.

Parameters:

filter - a predicate taking a string relation name and a bundle item

Returns:

a bundle with relations matching the given predicate function removed.

map

public Bundle map(Function<Bundle,Bundle> f)

Run a function transforming all items in the bundle, including the top level, returning a new bundle.

Parameters:

f - A (pure) function transforming the bundle

Returns:

A new bundle

forAny

public boolean forAny(Predicate<Bundle> f)

Test if a predicate function holds true for any item in the bundle, including the top level.

Parameters:

f - A predicate function

Returns:

If the predicate tested true

find

public Optional<Bundle> find(Predicate<Bundle> f)

getBundleJavaClass

public Class<?> getBundleJavaClass()

Get the target class.

Returns:

The bundle's type class

getPropertyKeys

public Collection<String> getPropertyKeys()

Return a list of names for mandatory properties, as represented in the graph.

Returns:

A list of property keys for the bundle's type

getUniquePropertyKeys

public Collection<String> getUniquePropertyKeys()

Return a list of property keys which must be unique.

Returns:

A list of unique property keys for the bundle's type

fromData

public static Bundle fromData(Object data)
                       throws DeserializationError

Create a bundle from raw data.

Parameters:

data - A raw data object

Returns:

A bundle

Throws:

DeserializationError

toData

public Map<String,Object> toData()

Serialize a bundle to raw data.

Returns:

A raw data object

fromString

public static Bundle fromString(String json)
                         throws DeserializationError

Create a bundle from a (JSON) string.

Parameters:

json - A JSON representation

Returns:

A bundle

Throws:

DeserializationError

fromStream

public static Bundle fromStream(InputStream stream)
                         throws DeserializationError

Create a bundle from a stream containing JSON data..

Parameters:

stream - A JSON stream

Returns:

A bundle

Throws:

DeserializationError

toStream

public static void toStream(Bundle bundle,
                            OutputStream stream)
                     throws SerializationError

Write a bundle to a JSON stream.

Parameters:

bundle - the bundle

stream - the output stream

Throws:

SerializationError

bundleStream

public static com.tinkerpop.blueprints.CloseableIterable<Bundle> bundleStream(InputStream inputStream)
                                                                       throws DeserializationError

Throws:

DeserializationError

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Serialize a bundle to a JSON string.

Returns:

json string

hasGeneratedId

public boolean hasGeneratedId()

Check if this bundle as a generated ID.

Returns:

True if the ID has been synthesised.

depth

public int depth()

The depth of this bundle tree, i.e. the number of levels of relationships beneath this one.

Returns:

the number of levels

dependentsOnly

public Bundle dependentsOnly()

Return a bundle consisting of only dependent relations.

Returns:

a new bundle with non-dependent relations removed

generateIds

public Bundle generateIds(Collection<String> scopes)

Generate missing IDs for the subtree.

Parameters:

scopes - A set of parent scopes.

Returns:

A new bundle

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

diff

public String diff(Bundle target)

Return a JSON-Patch representation of the difference between this bundle and another. Metadata is ignored.

Parameters:

target - the target bundle

Returns:

a JSON-Patch, as a string