com.tinkerpop.frames.modules.javahandler

Interface JavaHandlerContext<C extends com.tinkerpop.blueprints.Element>

Type Parameters:

C -

public interface JavaHandlerContext<C extends com.tinkerpop.blueprints.Element>

By implementing this interface your Java handler implementation can access the underlying graph and the framed vertex/edge.

Author:

Bryn Cooke

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	frame(com.tinkerpop.blueprints.Edge edge) Frame an edge using the return type of the method
<T> T	frame(com.tinkerpop.blueprints.Edge edge, Class<T> kind) Frame an edge using an explicit kind of frame
<T> T	frame(com.tinkerpop.blueprints.Edge edge, com.tinkerpop.blueprints.Direction direction) Frame an edge using the return type of the method
<T> T	frame(com.tinkerpop.blueprints.Edge edge, com.tinkerpop.blueprints.Direction direction, Class<T> kind) Frame an edge using an explicit kind of frame
<T> T	frame(com.tinkerpop.blueprints.Vertex vertex) Frame a vertex using the return type of the method
<T> T	frame(com.tinkerpop.blueprints.Vertex vertex, Class<T> kind) Frame a vertex using an explicit kind of frame
<T> Iterable<T>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges) Frame some edges using the return type of the method
<T> Iterable<T>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges, Class<T> kind) Frame some edges using an explicit kind of frame
<T> Iterable<T>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges, com.tinkerpop.blueprints.Direction direction) Frame some edges using the return type of the method
<T> Iterable<T>	frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges, com.tinkerpop.blueprints.Direction direction, Class<T> kind) Frame some edges using an explicit kind of frame
<T> Iterable<T>	frameVertices(Iterable<com.tinkerpop.blueprints.Vertex> vertices) Frame some vertices using the return type of the method
<T> Iterable<T>	frameVertices(Iterable<com.tinkerpop.blueprints.Vertex> vertices, Class<T> kind) Frame some vertices using an explicit kind of frame
FramedGraph<?>	g()
<E> com.tinkerpop.gremlin.java.GremlinPipeline<C,E>	gremlin()
<E> com.tinkerpop.gremlin.java.GremlinPipeline<C,E>	gremlin(Object starts) Start a gremlin pipeline
C	it()

Method Detail

g

FramedGraph<?> g()

Returns:

The framed graph

it

C it()

Returns:

The element that was framed

gremlin

<E> com.tinkerpop.gremlin.java.GremlinPipeline<C,E> gremlin()

Returns:

A gremlin pipeline at the context element

gremlin

<E> com.tinkerpop.gremlin.java.GremlinPipeline<C,E> gremlin(Object starts)

Start a gremlin pipeline

Parameters:

starts -

Returns:

Start a gremlin pipeline at an element

frame

<T> T frame(com.tinkerpop.blueprints.Vertex vertex)

Frame a vertex using the return type of the method

Parameters:

vertex - The vertex to frame

Returns:

The framed vertex

frame

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

Frame a vertex using an explicit kind of frame

Parameters:

vertex - The vertex to frame

kind - The type of frame

Returns:

The framed vertex

frame

<T> T frame(com.tinkerpop.blueprints.Edge edge)

Frame an edge using the return type of the method

Parameters:

edge - The edge to frame

Returns:

The framed edge

frame

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

Frame an edge using an explicit kind of frame

Parameters:

edge - The edge to frame

kind - The type of frame

Returns:

The framed edge

frame

<T> T frame(com.tinkerpop.blueprints.Edge edge,
          com.tinkerpop.blueprints.Direction direction)

Frame an edge using the return type of the method

Parameters:

edge - The edge to frame

direction - The direction of the edge

Returns:

The framed edge

frame

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

Frame an edge using an explicit kind of frame

Parameters:

edge - The edge to frame

direction - The direction of the edge

kind - The type of frame

Returns:

The framed edge

frameVertices

<T> Iterable<T> frameVertices(Iterable<com.tinkerpop.blueprints.Vertex> vertices)

Frame some vertices using the return type of the method

Parameters:

vertices - The vertices to frame

Returns:

The framed vertices

frameVertices

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

Frame some vertices using an explicit kind of frame

Parameters:

vertices - The vertices to frame

kind - The kind of frame

Returns:

The framed vertices

frameEdges

<T> Iterable<T> frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges)

Frame some edges using the return type of the method

Parameters:

edges - the edges to frame

direction - The direction of the edges

Returns:

The framed edges

frameEdges

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

Frame some edges using an explicit kind of frame

Parameters:

edges - the edges to frame

direction - The direction of the edges

kind - The kind of frame

Returns:

The framed edges

frameEdges

<T> Iterable<T> frameEdges(Iterable<com.tinkerpop.blueprints.Edge> edges,
                         com.tinkerpop.blueprints.Direction direction)

Frame some edges using the return type of the method

Parameters:

edges - the edges to frame

direction - The direction of the edges

Returns:

The framed edges

frameEdges

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

Frame some edges using an explicit kind of frame

Parameters:

edges - the edges to frame

direction - The direction of the edges

kind - The kind of frame

Returns:

The framed edges