Graph (Gremlin Core: The Primary Components of TinkerPop3 3.0.0.M7 API)

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

BatchGraph, EmptyGraph, StrategyGraph
```
public interface Graph
extends java.lang.AutoCloseable
```
A Graph is a container object for a collection of Vertex, Edge, VertexProperty, and Property objects.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Graph.Exceptions` Common exceptions to use with a graph.
`static interface`	`Graph.Features` An interface that represents the capabilities of a `Graph` implementation.
`static interface`	`Graph.Helper` Defines a method as a "helper method".
`static class`	`Graph.Hidden` This should only be used by vendors to create keys, labels, etc.
`static interface`	`Graph.Io` Provides access to functions related to reading and writing graph data.
`static interface`	`Graph.Iterators` An interface that provides access to iterators over `Vertex` objects and `Edge` objects of the graph without constructing a `Traversal` object.
`static interface`	`Graph.OptIn` Defines the test suite that the implementer has decided to support and represents publicly as "passing".
`static interface`	`Graph.OptIns` Holds a collection of `Graph.OptIn` enabling multiple `Graph.OptIn` to be applied to a single suite.
`static interface`	`Graph.OptOut` Defines a test in the suite that the implementer does not want to run.
`static interface`	`Graph.OptOuts` Holds a collection of `Graph.OptOut` enabling multiple `Graph.OptOut` to be applied to a single suite.
`static interface`	`Graph.Variables` Graph variables are a set of key/value pairs associated with the graph.The keys are String and the values are Objects.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String GRAPH

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`GRAPH`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Vertex`	`addVertex(java.lang.Object... keyValues)` Add a `Vertex` to the graph given an optional series of key/value pairs.
`default Vertex`	`addVertex(java.lang.String label)` Add a `Vertex` to the graph with provided vertex label.
`GraphComputer`	`compute(java.lang.Class... graphComputerClass)` Create an OLAP `GraphComputer` to execute a vertex program over this graph.
`org.apache.commons.configuration.Configuration`	`configuration()` Get the `Configuration` associated with the construction of this graph.
`default GraphTraversal<Edge,Edge>`	`E(java.lang.Object... edgeIds)` Starts a `GraphTraversal` over the edges in the graph.
`default Graph.Features`	`features()` Gets the `Graph.Features` exposed by the underlying `Graph` implementation.
`default Graph.Io`	`io()` Provide input/output methods for serializing graph data.
`Graph.Iterators`	`iterators()` Get the `Graph.Iterators` associated with this graph.
`default <T extends Traversal<S,S>,S> T`	`of(java.lang.Class<T> traversalClass)` Constructs a new domain specific `Traversal` for this graph.
`default StrategyGraph`	`strategy(GraphStrategy... strategies)` Constructs a `StrategyGraph` from one or more `GraphStrategy` objects.
`Transaction`	`tx()` Configure and control the transactions for those graphs that support this feature.
`default GraphTraversal<Vertex,Vertex>`	`V(java.lang.Object... vertexIds)` Starts a `GraphTraversal` over the vertices in the graph.
`Graph.Variables`	`variables()` A collection of global `Graph.Variables` associated with the graph.

Methods inherited from interface java.lang.AutoCloseable
close

- Field Detail
  - GRAPH
```
static final java.lang.String GRAPH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - addVertex
```
Vertex addVertex(java.lang.Object... keyValues)
```
    Add a Vertex to the graph given an optional series of key/value pairs. These key/values must be provided in an even number where the odd numbered arguments are String property keys and the even numbered arguments are the related property values.
    
    Parameters:
    
    keyValues - The key/value pairs to turn into vertex properties
    
    Returns:
    
    The newly created vertex
  - addVertex
```
default Vertex addVertex(java.lang.String label)
```
    Add a Vertex to the graph with provided vertex label.
    
    Parameters:
    
    label - the label of the vertex
    
    Returns:
    
    The newly created labeled vertex
  - V
```
default GraphTraversal<Vertex,Vertex> V(java.lang.Object... vertexIds)
```
    Starts a GraphTraversal over the vertices in the graph. If vertexIds are provided, then the traversal starts at those vertices, else all vertices in the graph.
    
    Parameters:
    
    vertexIds - the ids of the vertices to get (if none are provided, get all vertices)
    
    Returns:
    
    a graph traversal over the vertices of the graph
  - E
```
default GraphTraversal<Edge,Edge> E(java.lang.Object... edgeIds)
```
    Starts a GraphTraversal over the edges in the graph. If edgeIds are provided, then the traversal starts at those edges, else all edges in the graph.
    
    Parameters:
    
    edgeIds - the ids of the edges to get (if none are provided, get all edges)
    
    Returns:
    
    a graph traversal over the edges of the graph
  - of
```
default <T extends Traversal<S,S>,S> T of(java.lang.Class<T> traversalClass)
```
    Constructs a new domain specific Traversal for this graph.
    
    Parameters:
    
    traversalClass - the domain specific Traversal bound to this graph
  - compute
```
GraphComputer compute(java.lang.Class... graphComputerClass)
```
    Create an OLAP GraphComputer to execute a vertex program over this graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown. The provided arguments can be of either length 0 or 1. A graph can support multiple graph computers.
    
    Parameters:
    
    graphComputerClass - The graph computer class to use (if no argument, then a default is selected by the graph)
    
    Returns:
    
    A graph computer for processing this graph
  - tx
```
Transaction tx()
```
    Configure and control the transactions for those graphs that support this feature.
  - io
```
default Graph.Io io()
```
    Provide input/output methods for serializing graph data.
  - strategy
```
default StrategyGraph strategy(GraphStrategy... strategies)
```
    Constructs a StrategyGraph from one or more GraphStrategy objects. If more than one GraphStrategy is supplied they are folded into a single SequenceStrategy.
  - variables
```
Graph.Variables variables()
```
    A collection of global Graph.Variables associated with the graph. Variables are used for storing metadata about the graph.
    
    Returns:
    
    The variables associated with this graph
  - configuration
```
org.apache.commons.configuration.Configuration configuration()
```
    Get the Configuration associated with the construction of this graph. Whatever configuration was passed to GraphFactory.open(org.apache.commons.configuration.Configuration) is what should be returned by this method.
    
    Returns:
    
    the configuration used during graph construction.
  - iterators
```
Graph.Iterators iterators()
```
    Get the Graph.Iterators associated with this graph.
    
    Returns:
    
    the graph iterators of this graph
  - features
```
default Graph.Features features()
```
    Gets the Graph.Features exposed by the underlying Graph implementation.

Interface Graph

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Field Detail

GRAPH

Method Detail

addVertex

addVertex

V

E

of

compute

tx

io

strategy

variables

configuration

iterators

features