BatchGraph (Apache TinkerPop 3.0.0.M8-incubating API)

java.lang.Object
- org.apache.tinkerpop.gremlin.structure.util.batch.BatchGraph<G>

All Implemented Interfaces:

AutoCloseable, Graph
```
public class BatchGraph<G extends Graph>
extends Object
implements Graph
```
BatchGraph is a wrapper that enables batch loading of a large number of edges and vertices by chunking the entire load into smaller batches and maintaining a sideEffects-efficient vertex cache so that the entire transactional state can be flushed after each chunk is loaded.
BatchGraph is ONLY meant for loading data and does not support any retrieval or removal operations. That is, BatchGraph only supports the following methods: - addVertex(Object...) for adding vertices - Vertex.addEdge(String, org.apache.tinkerpop.gremlin.structure.Vertex, Object...) for adding edges - Property getter, setter and removal methods for vertices and edges.
An important limitation of BatchGraph is that edge properties can only be set immediately after the edge has been added. If other vertices or edges have been created in the meantime, setting, getting or removing properties will throw exceptions. This is done to avoid caching of edges which would require a great amount of sideEffects.
BatchGraph can also automatically set the provided element ids as properties on the respective element. Use BatchGraph.Builder.vertexIdKey(String) and BatchGraph.Builder.edgeIdKey(String) to set the keys for the vertex and edge properties respectively. This allows to make the loaded baseGraph compatible for later operation with org.apache.tinkerpop.gremlin.structure.strategy.IdStrategy.
Note that BatchGraph itself is not a org.apache.tinkerpop.gremlin.structure.strategy.GraphStrategy because it requires that the Vertex implementation not hold on to the underlying Vertex reference and org.apache.tinkerpop.gremlin.structure.strategy.StrategyVertex does that by it's very nature. While it might be possible to work around this issue, it is likely better for performance to simply leave this as a "half-wrapper" implementation, instead of forcing it into a org.apache.tinkerpop.gremlin.structure.strategy.GraphStrategy.

Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BatchGraph.Builder<G extends Graph>
- Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
  Graph.Exceptions, Graph.Features, Graph.Helper, Graph.Hidden, Graph.Io, Graph.OptIn, Graph.OptIns, Graph.OptOut, Graph.OptOuts, Graph.Variables

Nested Classes
Modifier and Type	Class and Description
`static class`	`BatchGraph.Builder<G extends Graph>`

Field Summary

Fields
Modifier and Type Field and Description

static long DEFAULT_BUFFER_SIZE
Default buffer size is 10000.
- Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
  GRAPH

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BUFFER_SIZE` Default buffer size is 10000.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vertex`	`addVertex(Object... keyValues)` Add a `Vertex` to the graph given an optional series of key/value pairs.
`static <T extends Graph> BatchGraph.Builder`	`build(T g)`
`void`	`close()`
`GraphComputer`	`compute()`
`<C extends GraphComputer> C`	`compute(Class<C> graphComputerClass)` Declare the `GraphComputer` to use for OLAP operations on the graph.
`Configuration`	`configuration()` Get the `org.apache.commons.configuration.Configuration` associated with the construction of this graph.
`Iterator<Edge>`	`edges(Object... edgeIds)` Get the `Edge` objects in this graph with the provided edge ids.
`Graph.Features`	`features()` Gets the `Graph.Features` exposed by the underlying `Graph` implementation.
`Transaction`	`tx()` Configure and control the transactions for those graphs that support this feature.
`Graph.Variables`	`variables()` A collection of global `Graph.Variables` associated with the graph.
`Iterator<Vertex>`	`vertices(Object... vertexIds)` Get the `Vertex` objects in this graph with the provided vertex ids.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
addVertex, empty, io, traversal, traversal

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final long DEFAULT_BUFFER_SIZE
```
    Default buffer size is 10000.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addVertex
```
public Vertex addVertex(Object... keyValues)
```
    Description copied from interface: Graph
    
    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.
    
    Specified by:
    
    addVertex in interface Graph
    
    Parameters:
    
    keyValues - The key/value pairs to turn into vertex properties
    
    Returns:
    
    The newly created vertex
  - vertices
```
public Iterator<Vertex> vertices(Object... vertexIds)
```
    Description copied from interface: Graph
    
    Get the Vertex objects in this graph with the provided vertex ids. If no ids are provided, get all vertices.
    
    Specified by:
    
    vertices in interface Graph
    
    Parameters:
    
    vertexIds - the ids of the vertices to get
    
    Returns:
    
    an Iterator of vertices that match the provided vertex ids
  - edges
```
public Iterator<Edge> edges(Object... edgeIds)
```
    Description copied from interface: Graph
    
    Get the Edge objects in this graph with the provided edge ids. If no ids are provided, get all edges.
    
    Specified by:
    
    edges in interface Graph
    
    Parameters:
    
    edgeIds - the ids of the edges to get
    
    Returns:
    
    an Iterator of edges that match the provided edge ids
  - compute
```
public <C extends GraphComputer> C compute(Class<C> graphComputerClass)
```
    Description copied from interface: Graph
    
    Declare the GraphComputer to use for OLAP operations on the graph. If the graph does not support graph computer then an UnsupportedOperationException is thrown.
    
    Specified by:
    
    compute in interface Graph
    
    Parameters:
    
    graphComputerClass - The graph computer class to use.
    
    Returns:
    
    A graph computer for processing this graph
  - compute
```
public GraphComputer compute()
```
    Specified by:
    
    compute in interface Graph
  - tx
```
public Transaction tx()
```
    Description copied from interface: Graph
    
    Configure and control the transactions for those graphs that support this feature.
    
    Specified by:
    
    tx in interface Graph
  - variables
```
public Graph.Variables variables()
```
    Description copied from interface: Graph
    
    A collection of global Graph.Variables associated with the graph. Variables are used for storing metadata about the graph.
    
    Specified by:
    
    variables in interface Graph
    
    Returns:
    
    The variables associated with this graph
  - configuration
```
public Configuration configuration()
```
    Description copied from interface: Graph
    
    Get the org.apache.commons.configuration.Configuration associated with the construction of this graph. Whatever configuration was passed to org.apache.tinkerpop.gremlin.structure.util.GraphFactory#open(org.apache.commons.configuration.Configuration) is what should be returned by this method.
    
    Specified by:
    
    configuration in interface Graph
    
    Returns:
    
    the configuration used during graph construction.
  - features
```
public Graph.Features features()
```
    Description copied from interface: Graph
    
    Gets the Graph.Features exposed by the underlying Graph implementation.
    
    Specified by:
    
    features in interface Graph
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - build
```
public static <T extends Graph> BatchGraph.Builder build(T g)
```

Class BatchGraph<G extends Graph>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

Field Detail

DEFAULT_BUFFER_SIZE

Method Detail

addVertex

vertices

edges

compute

compute

tx

variables

configuration

features

close

build