Package com.syncleus.ferma

Class DelegatingFramedGraph<G extends org.apache.tinkerpop.gremlin.structure.Graph>

java.lang.Object

com.syncleus.ferma.DelegatingFramedGraph<G>

All Implemented Interfaces:

FramedGraph, WrappedFramedGraph<G>, AutoCloseable, org.apache.tinkerpop.gremlin.structure.util.wrapped.WrappedGraph<G>

public class DelegatingFramedGraph<G extends org.apache.tinkerpop.gremlin.structure.Graph>
extends Object
implements WrappedFramedGraph<G>

Constructor Summary

Constructors

Constructor	Description
DelegatingFramedGraph(G delegate)	Construct an untyped framed graph without annotation support
DelegatingFramedGraph(G delegate, boolean typeResolution, boolean annotationsSupported)	Construct a framed graph with the specified typeResolution and annotation support
DelegatingFramedGraph(G delegate, boolean typeResolution, Collection<? extends Class<?>> types)	Construct an framed graph with the specified type resolution and with annotation support
DelegatingFramedGraph(G delegate, FrameFactory builder, TypeResolver defaultResolver)	Construct a framed graph.
DelegatingFramedGraph(G delegate, ReflectionCache reflections, boolean typeResolution, boolean annotationsSupported)	Construct a framed graph with the specified typeResolution and annotation support
DelegatingFramedGraph(G delegate, TypeResolver defaultResolver)	Construct a framed graph without annotation support.
DelegatingFramedGraph(G delegate, String modelPackage)	Construct a Typed framed graph with the specified type resolution and with annotation support
DelegatingFramedGraph(G delegate, Collection<? extends Class<?>> types)	Construct a Typed framed graph with the specified type resolution and with annotation support

Method Summary

Modifier and Type	Method	Description
TEdge	addFramedEdge(VertexFrame source, VertexFrame destination, String label)	Add a edge to the graph using a frame type of TEdge.
<T> T	addFramedEdge(VertexFrame source, VertexFrame destination, String label, ClassInitializer<T> initializer, Object... keyValues)	Add a edge to the graph
<T> T	addFramedEdge(VertexFrame source, VertexFrame destination, String label, Class<T> kind)	Add a edge to the graph
TEdge	addFramedEdgeExplicit(VertexFrame source, VertexFrame destination, String label)	Add a edge to the graph using a frame type of TEdge.
<T> T	addFramedEdgeExplicit(VertexFrame source, VertexFrame destination, String label, ClassInitializer<T> initializer)	Add a edge to the graph This will bypass the default type resolution and use the untyped resolver instead.
<T> T	addFramedEdgeExplicit(VertexFrame source, VertexFrame destination, String label, Class<T> kind)	Add a edge to the graph This will bypass the default type resolution and use the untyped resolver instead.
TVertex	addFramedVertex()	Add a vertex to the graph using a frame type of TVertex.
<T> T	addFramedVertex(ClassInitializer<T> initializer, Object... keyValues)	Add a vertex to the graph
<T> T	addFramedVertex(Class<T> kind)	Add a vertex to the graph
TVertex	addFramedVertexExplicit()	Add a vertex to the graph using a frame type of TVertex.
<T> T	addFramedVertexExplicit(ClassInitializer<T> initializer)	Add a vertex to the graph This will bypass the default type resolution and use the untyped resolver instead.
<T> T	addFramedVertexExplicit(Class<T> kind)	Add a vertex to the graph This will bypass the default type resolution and use the untyped resolver instead.
void	close()	Close the delegate graph.
<T> Iterator<? extends T>	frame(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Element> pipeline, Class<T> kind)
<T> T	frameElement(org.apache.tinkerpop.gremlin.structure.Element e, Class<T> kind)
<T> T	frameElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e, Class<T> kind)
<T> Iterator<? extends T>	frameExplicit(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Element> pipeline, Class<T> kind)
<T> T	frameNewElement(org.apache.tinkerpop.gremlin.structure.Element e, ClassInitializer<T> initializer)
<T> T	frameNewElement(org.apache.tinkerpop.gremlin.structure.Element e, Class<T> kind)
<T> T	frameNewElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e, ClassInitializer<T> initializer)
<T> T	frameNewElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e, Class<T> kind)
G	getBaseGraph()
FrameFactory	getBuilder()
<T> Iterator<? extends T>	getFramedEdges(Class<T> kind)
<T> Iterator<? extends T>	getFramedEdges(String key, Object value, Class<T> kind)
<T> Iterator<? extends T>	getFramedEdgesExplicit(Class<T> kind)
<T> Iterator<? extends T>	getFramedEdgesExplicit(String key, Object value, Class<T> kind)
<T> T	getFramedVertex(Class<T> kind, Object id)
<T> T	getFramedVertexExplicit(Class<T> kind, Object id)
<T> Iterator<? extends T>	getFramedVertices(Class<T> kind)
<T> Iterator<? extends T>	getFramedVertices(String key, Object value, Class<T> kind)
<T> Iterator<? extends T>	getFramedVerticesExplicit(Class<T> kind)
<T> Iterator<? extends T>	getFramedVerticesExplicit(String key, Object value, Class<T> kind)
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	getRawTraversal()
TypeResolver	getTypeResolver()
<T extends Traversable<?,?>> T	traverse(Function<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource,org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?>> traverser)
WrappedTransaction	tx()

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             FrameFactory builder,
                             TypeResolver defaultResolver)

Construct a framed graph.

Parameters:

delegate - The graph to wrap.

builder - The builder that will construct frames.

defaultResolver - The type defaultResolver that will decide the final frame type.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate)

Construct an untyped framed graph without annotation support

Parameters:

delegate - The graph to wrap.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             TypeResolver defaultResolver)

Construct a framed graph without annotation support.

Parameters:

delegate - The graph to wrap.

defaultResolver - The type defaultResolver that will decide the final frame type.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             boolean typeResolution,
                             boolean annotationsSupported)

Construct a framed graph with the specified typeResolution and annotation support

Parameters:

delegate - The graph to wrap.

typeResolution - True if type resolution is to be automatically handled by default, false causes explicit typing by

annotationsSupported - True if annotated classes will be supported, false otherwise.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             ReflectionCache reflections,
                             boolean typeResolution,
                             boolean annotationsSupported)

Construct a framed graph with the specified typeResolution and annotation support

Parameters:

delegate - The graph to wrap.

reflections - A RefelctionCache used to determine reflection and hierarchy of classes.

typeResolution - True if type resolution is to be automatically handled by default, false causes explicit typing by

annotationsSupported - True if annotated classes will be supported, false otherwise.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             Collection<? extends Class<?>> types)

Construct a Typed framed graph with the specified type resolution and with annotation support

Parameters:

delegate - The graph to wrap.

types - The types to be consider for type resolution.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             String modelPackage)

Construct a Typed framed graph with the specified type resolution and with annotation support

Parameters:

delegate - The graph to wrap.

modelPackage - The package scanned for classes to be considered for type resolution.

DelegatingFramedGraph

public DelegatingFramedGraph(G delegate,
                             boolean typeResolution,
                             Collection<? extends Class<?>> types)

Construct an framed graph with the specified type resolution and with annotation support

Parameters:

delegate - The graph to wrap.

typeResolution - True if type resolution is to be automatically handled by default, false causes explicit typing by default.

types - The types to be consider for type resolution.

Method Detail

getBaseGraph

public G getBaseGraph()

Specified by:

getBaseGraph in interface org.apache.tinkerpop.gremlin.structure.util.wrapped.WrappedGraph<G extends org.apache.tinkerpop.gremlin.structure.Graph>

getBuilder

public FrameFactory getBuilder()

Specified by:

getBuilder in interface FramedGraph

close

public void close()
           throws IOException

Close the delegate graph.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FramedGraph

Throws:

IOException - Whenever an IO problem prevents the stream from closing.

frameElement

public <T> T frameElement(org.apache.tinkerpop.gremlin.structure.Element e,
                          Class<T> kind)

Specified by:

frameElement in interface FramedGraph

frameNewElement

public <T> T frameNewElement(org.apache.tinkerpop.gremlin.structure.Element e,
                             ClassInitializer<T> initializer)

Specified by:

frameNewElement in interface FramedGraph

frameNewElement

public <T> T frameNewElement(org.apache.tinkerpop.gremlin.structure.Element e,
                             Class<T> kind)

Specified by:

frameNewElement in interface FramedGraph

frame

public <T> Iterator<? extends T> frame(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Element> pipeline,
                                       Class<T> kind)

Specified by:

frame in interface FramedGraph

frameElementExplicit

public <T> T frameElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e,
                                  Class<T> kind)

Specified by:

frameElementExplicit in interface FramedGraph

frameNewElementExplicit

public <T> T frameNewElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e,
                                     ClassInitializer<T> initializer)

Specified by:

frameNewElementExplicit in interface FramedGraph

frameNewElementExplicit

public <T> T frameNewElementExplicit(org.apache.tinkerpop.gremlin.structure.Element e,
                                     Class<T> kind)

Specified by:

frameNewElementExplicit in interface FramedGraph

frameExplicit

public <T> Iterator<? extends T> frameExplicit(Iterator<? extends org.apache.tinkerpop.gremlin.structure.Element> pipeline,
                                               Class<T> kind)

Specified by:

frameExplicit in interface FramedGraph

addFramedVertex

public <T> T addFramedVertex(ClassInitializer<T> initializer,
                             Object... keyValues)

Description copied from interface: FramedGraph

Add a vertex to the graph

Specified by:

addFramedVertex in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

initializer - the initializer for the frame which defines its type and may initialize properties

keyValues - the recommended object identifier

Returns:

The framed vertex.

addFramedVertex

public <T> T addFramedVertex(Class<T> kind)

Description copied from interface: FramedGraph

Add a vertex to the graph

Specified by:

addFramedVertex in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

kind - The kind of the frame.

Returns:

The framed vertex.

addFramedVertexExplicit

public <T> T addFramedVertexExplicit(ClassInitializer<T> initializer)

Description copied from interface: FramedGraph

Add a vertex to the graph This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedVertexExplicit in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

initializer - the initializer for the frame which defines its type and may initialize properties

Returns:

The framed vertex.

addFramedVertexExplicit

public <T> T addFramedVertexExplicit(Class<T> kind)

Description copied from interface: FramedGraph

Add a vertex to the graph This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedVertexExplicit in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

kind - The kind of the frame.

Returns:

The framed vertex.

addFramedVertex

public TVertex addFramedVertex()

Description copied from interface: FramedGraph

Add a vertex to the graph using a frame type of TVertex.

Specified by:

addFramedVertex in interface FramedGraph

Returns:

The framed vertex.

addFramedVertexExplicit

public TVertex addFramedVertexExplicit()

Description copied from interface: FramedGraph

Add a vertex to the graph using a frame type of TVertex. This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedVertexExplicit in interface FramedGraph

Returns:

The framed vertex.

addFramedEdge

public <T> T addFramedEdge(VertexFrame source,
                           VertexFrame destination,
                           String label,
                           ClassInitializer<T> initializer,
                           Object... keyValues)

Description copied from interface: FramedGraph

Add a edge to the graph

Specified by:

addFramedEdge in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

source - the source vertex

destination - the destination vertex

label - the label.

initializer - the initializer for the frame which defines its type and may initialize properties

keyValues - the recommended object identifier

Returns:

The framed edge.

addFramedEdge

public <T> T addFramedEdge(VertexFrame source,
                           VertexFrame destination,
                           String label,
                           Class<T> kind)

Description copied from interface: FramedGraph

Add a edge to the graph

Specified by:

addFramedEdge in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

source - The source vertex

destination - the destination vertex

label - the label.

kind - The kind of the frame.

Returns:

The framed edge.

addFramedEdgeExplicit

public <T> T addFramedEdgeExplicit(VertexFrame source,
                                   VertexFrame destination,
                                   String label,
                                   ClassInitializer<T> initializer)

Description copied from interface: FramedGraph

Add a edge to the graph This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedEdgeExplicit in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

source - The source vertex

destination - the destination vertex

label - the label.

initializer - the initializer for the frame which defines its type and may initialize properties

Returns:

The framed edge.

addFramedEdgeExplicit

public <T> T addFramedEdgeExplicit(VertexFrame source,
                                   VertexFrame destination,
                                   String label,
                                   Class<T> kind)

Description copied from interface: FramedGraph

Add a edge to the graph This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedEdgeExplicit in interface FramedGraph

Type Parameters:

T - The type used to frame the element.

Parameters:

source - The source vertex

destination - the destination vertex

label - the label.

kind - The kind of the frame.

Returns:

The framed edge.

addFramedEdge

public TEdge addFramedEdge(VertexFrame source,
                           VertexFrame destination,
                           String label)

Description copied from interface: FramedGraph

Add a edge to the graph using a frame type of TEdge.

Specified by:

addFramedEdge in interface FramedGraph

Parameters:

source - The source vertex

destination - the destination vertex

label - the label.

Returns:

The framed edge.

addFramedEdgeExplicit

public TEdge addFramedEdgeExplicit(VertexFrame source,
                                   VertexFrame destination,
                                   String label)

Description copied from interface: FramedGraph

Add a edge to the graph using a frame type of TEdge. This will bypass the default type resolution and use the untyped resolver instead. This method is useful for speeding up a look up when type resolution isn't required.

Specified by:

addFramedEdgeExplicit in interface FramedGraph

Parameters:

source - The source vertex

destination - the destination vertex

label - the label.

Returns:

The framed edge.

traverse

public <T extends Traversable<?,?>> T traverse(Function<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource,org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<?,?>> traverser)

Specified by:

traverse in interface FramedGraph

getRawTraversal

public org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource getRawTraversal()

Specified by:

getRawTraversal in interface FramedGraph

getFramedVertex

public <T> T getFramedVertex(Class<T> kind,
                             Object id)

Specified by:

getFramedVertex in interface FramedGraph

getFramedVertexExplicit

public <T> T getFramedVertexExplicit(Class<T> kind,
                                     Object id)

Specified by:

getFramedVertexExplicit in interface FramedGraph

getFramedVertices

public <T> Iterator<? extends T> getFramedVertices(Class<T> kind)

Specified by:

getFramedVertices in interface FramedGraph

getFramedVertices

public <T> Iterator<? extends T> getFramedVertices(String key,
                                                   Object value,
                                                   Class<T> kind)

Specified by:

getFramedVertices in interface FramedGraph

getFramedVerticesExplicit

public <T> Iterator<? extends T> getFramedVerticesExplicit(Class<T> kind)

Specified by:

getFramedVerticesExplicit in interface FramedGraph

getFramedVerticesExplicit

public <T> Iterator<? extends T> getFramedVerticesExplicit(String key,
                                                           Object value,
                                                           Class<T> kind)

Specified by:

getFramedVerticesExplicit in interface FramedGraph

getFramedEdges

public <T> Iterator<? extends T> getFramedEdges(Class<T> kind)

Specified by:

getFramedEdges in interface FramedGraph

getFramedEdges

public <T> Iterator<? extends T> getFramedEdges(String key,
                                                Object value,
                                                Class<T> kind)

Specified by:

getFramedEdges in interface FramedGraph

getFramedEdgesExplicit

public <T> Iterator<? extends T> getFramedEdgesExplicit(Class<T> kind)

Specified by:

getFramedEdgesExplicit in interface FramedGraph

getFramedEdgesExplicit

public <T> Iterator<? extends T> getFramedEdgesExplicit(String key,
                                                        Object value,
                                                        Class<T> kind)

Specified by:

getFramedEdgesExplicit in interface FramedGraph

getTypeResolver

public TypeResolver getTypeResolver()

Specified by:

getTypeResolver in interface FramedGraph

tx

public WrappedTransaction tx()

Specified by:

tx in interface FramedGraph