eu.ehri.project.persistence

Class Serializer

java.lang.Object

eu.ehri.project.persistence.Serializer

public final class Serializer
extends Object

Class containing static methods to convert between FramedVertex instances, EntityBundles, and raw data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Serializer.Builder Builder for serializers with non-default options.

Constructor Summary

Constructors

Constructor and Description
Serializer(com.tinkerpop.frames.FramedGraph<?> graph) Basic constructor.
Serializer(Serializer.Builder builder)

Method Summary

Modifier and Type	Method and Description
<T extends Entity> Bundle	entityToBundle(T item) Convert an Entity into a Bundle that includes its @Fetch'd relations.
<T extends Entity> Map<String,Object>	entityToData(T item) Convert a vertex frame to a raw bundle of data.
<T extends Entity> String	entityToJson(T item) Serialise a vertex frame to JSON.
List<String>	getIncludedProperties() Get the list of included properties for this serializer.
<T extends Entity> void	traverseSubtree(T item, TraversalCallback cb) Run a callback every time a node in a subtree is encountered, excepting the top-level node.
Bundle	vertexToBundle(com.tinkerpop.blueprints.Vertex item) Convert a Vertex into a Bundle that includes its @Fetch'd relations.
Map<String,Object>	vertexToData(com.tinkerpop.blueprints.Vertex item) Convert a vertex to a raw bundle of data.
String	vertexToJson(com.tinkerpop.blueprints.Vertex item) Serialise a vertex to JSON.
Serializer	withCache() Return a serializer that caches recently-serialized items.
Serializer	withDependentOnly(boolean dependentOnly)
Serializer	withDepth(int depth) Create a new serializer from this one, with the given depth.
Serializer	withIncludedProperties(List<String> includeProps) Create a new serializer from this one, with extra included properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

Serializer

public Serializer(com.tinkerpop.frames.FramedGraph<?> graph)

Basic constructor.

Serializer

public Serializer(Serializer.Builder builder)

Method Detail

withIncludedProperties

public Serializer withIncludedProperties(List<String> includeProps)

Create a new serializer from this one, with extra included properties.

Parameters:

includeProps - a set of properties to include.

Returns:

a new serializer.

withDepth

public Serializer withDepth(int depth)

Create a new serializer from this one, with the given depth.

Parameters:

depth - the maximum depth of traversal

Returns:

a new serializer

withDependentOnly

public Serializer withDependentOnly(boolean dependentOnly)

getIncludedProperties

public List<String> getIncludedProperties()

Get the list of included properties for this serializer.

Returns:

a list of property-name strings

withCache

public Serializer withCache()

Return a serializer that caches recently-serialized items.

Returns:

a new serializer

entityToData

public <T extends Entity> Map<String,Object> entityToData(T item)
                                                   throws SerializationError

Convert a vertex frame to a raw bundle of data.

Parameters:

item - The framed item

Returns:

A map of data

Throws:

SerializationError

vertexToData

public Map<String,Object> vertexToData(com.tinkerpop.blueprints.Vertex item)
                                throws SerializationError

Convert a vertex to a raw bundle of data.

Parameters:

item - The item vertex

Returns:

A map of data

Throws:

SerializationError

entityToBundle

public <T extends Entity> Bundle entityToBundle(T item)
                                         throws SerializationError

Convert an Entity into a Bundle that includes its @Fetch'd relations.

Parameters:

item - The framed item

Returns:

A data bundle

Throws:

SerializationError

vertexToBundle

public Bundle vertexToBundle(com.tinkerpop.blueprints.Vertex item)
                      throws SerializationError

Convert a Vertex into a Bundle that includes its @Fetch'd relations.

Parameters:

item - The item vertex

Returns:

A data bundle

Throws:

SerializationError

entityToJson

public <T extends Entity> String entityToJson(T item)
                                       throws SerializationError

Serialise a vertex frame to JSON.

Parameters:

item - The framed item

Returns:

A JSON string

Throws:

SerializationError

vertexToJson

public String vertexToJson(com.tinkerpop.blueprints.Vertex item)
                    throws SerializationError

Serialise a vertex to JSON.

Parameters:

item - The item vertex

Returns:

A JSON string

Throws:

SerializationError

traverseSubtree

public <T extends Entity> void traverseSubtree(T item,
                                               TraversalCallback cb)

Run a callback every time a node in a subtree is encountered, excepting the top-level node.

Parameters:

item - The item

cb - A callback object