com.tinkerpop.frames

Class FramedGraph<T extends com.tinkerpop.blueprints.Graph>

java.lang.Object

com.tinkerpop.frames.FramedGraph<T>

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.util.wrappers.WrapperGraph<T>

Direct Known Subclasses:

FramedTransactionalGraph

public class FramedGraph<T extends com.tinkerpop.blueprints.Graph>
extends Object
implements com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.util.wrappers.WrapperGraph<T>

The primary class for interpreting/framing elements of a graph in terms of particulate annotated interfaces. This is a wrapper graph in that it requires an underlying graph from which to add functionality. The standard Blueprints graph methods are exposed along with extra methods to make framing easy.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected T	baseGraph

Constructor Summary

Constructors

Modifier	Constructor and Description
	FramedGraph(T baseGraph) Deprecated. Use FramedGraphFactory.
protected	FramedGraph(T baseGraph, FramedGraphConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Edge	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label)
<F> F	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label, Class<F> kind)
<F> F	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label, com.tinkerpop.blueprints.Direction direction, Class<F> kind) Deprecated. Use addEdge(Object, Vertex, Vertex, String, Class), in combination with InVertex and OutVertex.
com.tinkerpop.blueprints.Vertex	addVertex(Object id)
<F> F	addVertex(Object id, Class<F> kind) Add a vertex to the underlying graph and return it as a framed vertex.
<F> F	frame(com.tinkerpop.blueprints.Edge edge, Class<F> kind) A helper method for framing an edge.
<F> F	frame(com.tinkerpop.blueprints.Edge edge, com.tinkerpop.blueprints.Direction direction, Class<F> kind) Deprecated. Use frame(Edge, Class), in combination with InVertex and OutVertex.
<F> F	frame(com.tinkerpop.blueprints.Vertex vertex, Class<F> kind) A helper method for framing a vertex.
<F> Iterable<F>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges, Class<F> kind) A helper method for framing an iterable of edges.
<F> Iterable<F>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges, com.tinkerpop.blueprints.Direction direction, Class<F> kind) Deprecated. Use frameEdges(Iterable, Class), in combination with InVertex and OutVertex.
<F> Iterable<F>	frameVertices(Iterable<com.tinkerpop.blueprints.Vertex> vertices, Class<F> kind) A helper method for framing an iterable of vertices.
AnnotationHandler<?>	getAnnotationHandler(Class<? extends Annotation> annotationType) Deprecated. Use Modules via FramedGraphFactory.
Collection<AnnotationHandler<? extends Annotation>>	getAnnotationHandlers() Deprecated. Use Modules via FramedGraphFactory.
T	getBaseGraph()
com.tinkerpop.blueprints.Edge	getEdge(Object id)
<F> F	getEdge(Object id, Class<F> kind) Frame an edge according to a particular kind of annotated interface.
<F> F	getEdge(Object id, com.tinkerpop.blueprints.Direction direction, Class<F> kind) Deprecated. Use #getEdges(Object, Class), in combination with InVertex and OutVertex.
Iterable<com.tinkerpop.blueprints.Edge>	getEdges()
Iterable<com.tinkerpop.blueprints.Edge>	getEdges(String key, Object value)
<F> Iterable<F>	getEdges(String key, Object value, Class<F> kind) Frame edges according to a particular kind of annotated interface.
<F> Iterable<F>	getEdges(String key, Object value, com.tinkerpop.blueprints.Direction direction, Class<F> kind) Deprecated. Use getEdges(String, Object, Class), in combination with InVertex and OutVertex.
com.tinkerpop.blueprints.Features	getFeatures()
com.tinkerpop.blueprints.Vertex	getVertex(Object id)
<F> F	getVertex(Object id, Class<F> kind) Frame a vertex according to a particular kind of annotated interface.
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices()
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(String key, Object value)
<F> Iterable<F>	getVertices(String key, Object value, Class<F> kind) Frame vertices according to a particular kind of annotated interface.
boolean	hasAnnotationHandler(Class<? extends Annotation> annotationType) Deprecated. Use Modules via FramedGraphFactory.
FramedGraphQuery	query() Generate a query object that can be used to fine tune which edges/vertices are retrieved from the graph.
void	registerAnnotationHandler(AnnotationHandler<? extends Annotation> handler) Deprecated. Use Modules via FramedGraphFactory.
void	registerFrameInitializer(FrameInitializer frameInitializer) Deprecated. Use Modules via FramedGraphFactory.
void	removeEdge(com.tinkerpop.blueprints.Edge edge)
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex)
void	shutdown()
String	toString()
void	unregisterAnnotationHandler(Class<? extends Annotation> annotationType) Deprecated. Use Modules via FramedGraphFactory.

Methods inherited from class java.lang.Object

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

Field Detail

baseGraph

protected final T extends com.tinkerpop.blueprints.Graph baseGraph

Constructor Detail

FramedGraph

protected FramedGraph(T baseGraph,
           FramedGraphConfiguration config)

Parameters:

baseGraph - The original graph being framed.

config - The configuration for the framed graph.

config.getConfiguredGraph() - The graph being framed after module configuration.

FramedGraph

public FramedGraph(T baseGraph)

Deprecated. Use FramedGraphFactory.

Construct a FramedGraph that will frame the elements of the underlying graph.

Parameters:

baseGraph - the graph whose elements to frame

Method Detail

frame

public <F> F frame(com.tinkerpop.blueprints.Vertex vertex,
          Class<F> kind)

A helper method for framing a vertex. Note that all framed vertices implement VertexFrame to allow access to the underlying element

Type Parameters:

F - the default type of the annotated interface

Parameters:

vertex - the vertex to frame

kind - the default annotated interface to frame the vertex as

Returns:

a proxy objects backed by a vertex and interpreted from the perspective of the annotate interface or null if the vertex parameter was null

frame

public <F> F frame(com.tinkerpop.blueprints.Edge edge,
          com.tinkerpop.blueprints.Direction direction,
          Class<F> kind)

Deprecated. Use frame(Edge, Class), in combination with InVertex and OutVertex.

A helper method for framing an edge. Note that all framed edges implement EdgeFrame to allow access to the underlying element

Type Parameters:

F - the default type of the annotated interface

Parameters:

edge - the edge to frame

direction - the direction of the edges

kind - the default annotated interface to frame the edges as

Returns:

a proxy objects backed by an edge and interpreted from the perspective of the annotate interface or null if the edge paramenter was null

frame

public <F> F frame(com.tinkerpop.blueprints.Edge edge,
          Class<F> kind)

A helper method for framing an edge. Note that all framed edges implement EdgeFrame to allow access to the underlying element.

Type Parameters:

F - the default type of the annotated interface

Parameters:

edge - the edge to frame

kind - the default annotated interface to frame the edges as

Returns:

a proxy objects backed by an edge and interpreted from the perspective of the annotate interface or null if the edge paramenter was null

frameVertices

public <F> Iterable<F> frameVertices(Iterable<com.tinkerpop.blueprints.Vertex> vertices,
                            Class<F> kind)

A helper method for framing an iterable of vertices.

Type Parameters:

F - the default type of the annotated interface

Parameters:

vertices - the vertices to frame

kind - the default annotated interface to frame the vertices as

Returns:

an iterable of proxy objects backed by a vertex and interpreted from the perspective of the annotate interface

frameEdges

public <F> Iterable<F> frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges,
                         com.tinkerpop.blueprints.Direction direction,
                         Class<F> kind)

Deprecated. Use frameEdges(Iterable, Class), in combination with InVertex and OutVertex.

A helper method for framing an iterable of edges.

Type Parameters:

F - the default type of the annotated interface

Parameters:

edges - the edges to frame

direction - the direction of the edges

kind - the default annotated interface to frame the edges as

Returns:

an iterable of proxy objects backed by an edge and interpreted from the perspective of the annotate interface

frameEdges

public <F> Iterable<F> frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges,
                         Class<F> kind)

A helper method for framing an iterable of edges.

Type Parameters:

F - the default type of the annotated interface

Parameters:

edges - the edges to frame

direction - the direction of the edges

kind - the default annotated interface to frame the edges as

Returns:

an iterable of proxy objects backed by an edge and interpreted from the perspective of the annotate interface

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(Object id)

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

getVertex

public <F> F getVertex(Object id,
              Class<F> kind)

Frame a vertex according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

id - the id of the vertex

kind - the default annotated interface to frame the vertex as

Returns:

a proxy object backed by the vertex and interpreted from the perspective of the annotate interface

addVertex

public com.tinkerpop.blueprints.Vertex addVertex(Object id)

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

addVertex

public <F> F addVertex(Object id,
              Class<F> kind)

Add a vertex to the underlying graph and return it as a framed vertex.

Type Parameters:

F - the default type of the annotated interface

Parameters:

id - the id of the newly created vertex

kind - the default annotated interface to frame the vertex as

Returns:

a proxy object backed by the vertex and interpreted from the perspective of the annotate interface

getEdge

public com.tinkerpop.blueprints.Edge getEdge(Object id)

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

getEdge

public <F> F getEdge(Object id,
            com.tinkerpop.blueprints.Direction direction,
            Class<F> kind)

Deprecated. Use #getEdges(Object, Class), in combination with InVertex and OutVertex.

Frame an edge according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

id - the id of the edge

direction - the direction of the edge

kind - the default annotated interface to frame the edge as

Returns:

a proxy object backed by the edge and interpreted from the perspective of the annotate interface

getEdge

public <F> F getEdge(Object id,
            Class<F> kind)

Frame an edge according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

id - the id of the edge

direction - the direction of the edge

kind - the default annotated interface to frame the edge as

Returns:

a proxy object backed by the edge and interpreted from the perspective of the annotate interface

addEdge

public com.tinkerpop.blueprints.Edge addEdge(Object id,
                                    com.tinkerpop.blueprints.Vertex outVertex,
                                    com.tinkerpop.blueprints.Vertex inVertex,
                                    String label)

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

addEdge

public <F> F addEdge(Object id,
            com.tinkerpop.blueprints.Vertex outVertex,
            com.tinkerpop.blueprints.Vertex inVertex,
            String label,
            com.tinkerpop.blueprints.Direction direction,
            Class<F> kind)

Deprecated. Use addEdge(Object, Vertex, Vertex, String, Class), in combination with InVertex and OutVertex.

Add an edge to the underlying graph and return it as a framed edge.

Type Parameters:

F - the default type of the annotated interface

Parameters:

id - the id of the newly created edge

outVertex - the outgoing vertex

inVertex - the incoming vertex

label - the label of the edge

direction - the direction of the edge

kind - the default annotated interface to frame the edge as

Returns:

a proxy object backed by the edge and interpreted from the perspective of the annotate interface

addEdge

public <F> F addEdge(Object id,
            com.tinkerpop.blueprints.Vertex outVertex,
            com.tinkerpop.blueprints.Vertex inVertex,
            String label,
            Class<F> kind)

removeVertex

public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)

Specified by:

removeVertex in interface com.tinkerpop.blueprints.Graph

removeEdge

public void removeEdge(com.tinkerpop.blueprints.Edge edge)

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

getVertices

public Iterable<com.tinkerpop.blueprints.Vertex> getVertices()

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getVertices

public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(String key,
                                                    Object value)

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getVertices

public <F> Iterable<F> getVertices(String key,
                          Object value,
                          Class<F> kind)

Frame vertices according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

key - the key of the vertices to get

value - the value of the vertices to get

kind - the default annotated interface to frame the vertices as

Returns:

an iterable of proxy objects backed by the vertices and interpreted from the perspective of the annotate interface

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges()

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges(String key,
                                               Object value)

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getEdges

public <F> Iterable<F> getEdges(String key,
                       Object value,
                       com.tinkerpop.blueprints.Direction direction,
                       Class<F> kind)

Deprecated. Use getEdges(String, Object, Class), in combination with InVertex and OutVertex.

Frame edges according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

key - the key of the edges to get

value - the value of the edges to get

direction - the direction of the edges

kind - the default annotated interface to frame the edges as

Returns:

an iterable of proxy objects backed by the edges and interpreted from the perspective of the annotate interface

getEdges

public <F> Iterable<F> getEdges(String key,
                       Object value,
                       Class<F> kind)

Frame edges according to a particular kind of annotated interface.

Type Parameters:

F - the default type of the annotated interface

Parameters:

key - the key of the edges to get

value - the value of the edges to get

direction - the direction of the edges

kind - the default annotated interface to frame the edges as

Returns:

an iterable of proxy objects backed by the edges and interpreted from the perspective of the annotate interface

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Specified by:

getFeatures in interface com.tinkerpop.blueprints.Graph

shutdown

public void shutdown()

Specified by:

shutdown in interface com.tinkerpop.blueprints.Graph

getBaseGraph

public T getBaseGraph()

Specified by:

getBaseGraph in interface com.tinkerpop.blueprints.util.wrappers.WrapperGraph<T extends com.tinkerpop.blueprints.Graph>

toString

public String toString()

Overrides:

toString in class Object

registerAnnotationHandler

public void registerAnnotationHandler(AnnotationHandler<? extends Annotation> handler)

Deprecated. Use Modules via FramedGraphFactory.

The method used to register a new annotation handler for every new annotation a new annotation handler has to be registered in the framed graph

Parameters:

handler - the annotation handler

getAnnotationHandler

public AnnotationHandler<?> getAnnotationHandler(Class<? extends Annotation> annotationType)

Deprecated. Use Modules via FramedGraphFactory.

Parameters:

annotationType - the type of annotation handled by the annotation handler

Returns:

the annotation handler associated with the specified type

hasAnnotationHandler

public boolean hasAnnotationHandler(Class<? extends Annotation> annotationType)

Deprecated. Use Modules via FramedGraphFactory.

Parameters:

annotationType - the type of annotation handled by the annotation handler

Returns:

a boolean indicating if the framedGraph has registered an annotation handler for the specified type

unregisterAnnotationHandler

public void unregisterAnnotationHandler(Class<? extends Annotation> annotationType)

Deprecated. Use Modules via FramedGraphFactory.

Parameters:

annotationType - the type of the annotation handler to remove

getAnnotationHandlers

public Collection<AnnotationHandler<? extends Annotation>> getAnnotationHandlers()

Deprecated. Use Modules via FramedGraphFactory.

Returns:

registerFrameInitializer

public void registerFrameInitializer(FrameInitializer frameInitializer)

Deprecated. Use Modules via FramedGraphFactory.

Register a FrameInitializer that will be called whenever a new vertex or edge is added to the graph. The initializer may mutate the vertex (or graph) before returning the framed element to the user.

Parameters:

frameInitializer - the frame initializer

query

public FramedGraphQuery query()

Generate a query object that can be used to fine tune which edges/vertices are retrieved from the graph.

Specified by:

query in interface com.tinkerpop.blueprints.Graph

Returns:

a graph query object with methods for constraining which data is pulled from the underlying graph