Neo4jGraph (Apache TinkerPop :: Neo4j Gremlin 3.4.2 API)

java.lang.Object
- org.apache.tinkerpop.gremlin.neo4j.structure.Neo4jGraph

All Implemented Interfaces:

AutoCloseable, Graph, Host, WrappedGraph<org.neo4j.tinkerpop.api.Neo4jGraphAPI>
```
public final class Neo4jGraph
extends Object
implements Graph, WrappedGraph<org.neo4j.tinkerpop.api.Neo4jGraphAPI>
```
Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Neo4jGraph.Neo4jGraphFeatures
- Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph
  Graph.Exceptions, Graph.Features, Graph.Hidden, Graph.OptIn, Graph.OptIns, Graph.OptOut, Graph.OptOuts, Graph.Variables

Nested Classes
Modifier and Type	Class and Description
`class`	`Neo4jGraph.Neo4jGraphFeatures`

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.neo4j.tinkerpop.api.Neo4jGraphAPI`	`baseGraph`
`static String`	`CONFIG_CONF`
`static String`	`CONFIG_DIRECTORY`
`static String`	`CONFIG_META_PROPERTIES`
`static String`	`CONFIG_MULTI_PROPERTIES`
`protected org.apache.commons.configuration.BaseConfiguration`	`configuration`
`protected Graph.Features`	`features`
`static org.slf4j.Logger`	`LOGGER`
`protected Neo4jTrait`	`trait`

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Neo4jGraph(org.apache.commons.configuration.Configuration configuration)`
`protected`	`Neo4jGraph(org.neo4j.tinkerpop.api.Neo4jGraphAPI baseGraph, org.apache.commons.configuration.Configuration configuration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vertex`	`addVertex(Object... keyValues)`
`void`	`close()` This implementation of `close` will also close the current transaction on the thread, but it is up to the caller to deal with dangling transactions in other threads prior to calling this method.
`GraphComputer`	`compute()`
`<C extends GraphComputer> C`	`compute(Class<C> graphComputerClass)`
`org.apache.commons.configuration.Configuration`	`configuration()`
`<S,E> GraphTraversal<S,E>`	`cypher(String query)` Execute the Cypher query and get the result set as a `GraphTraversal`.
`<S,E> GraphTraversal<S,E>`	`cypher(String query, Map<String,Object> parameters)` Execute the Cypher query with provided parameters and get the result set as a `GraphTraversal`.
`Iterator<Edge>`	`edges(Object... edgeIds)`
`Graph.Features`	`features()`
`org.neo4j.tinkerpop.api.Neo4jGraphAPI`	`getBaseGraph()`
`Neo4jTrait`	`getTrait()`
`static Neo4jGraph`	`open(org.apache.commons.configuration.Configuration configuration)` Open a new `Neo4jGraph` instance.
`static Neo4jGraph`	`open(org.neo4j.tinkerpop.api.Neo4jGraphAPI baseGraph)` Construct a Neo4jGraph instance using an existing Neo4j raw instance.
`static Neo4jGraph`	`open(String directory)` Construct a Neo4jGraph instance by specifying the directory to create the database in..
`String`	`toString()`
`Transaction`	`tx()`
`Graph.Variables`	`variables()`
`Iterator<Vertex>`	`vertices(Object... vertexIds)`

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

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host
getHostingVertex

- Field Detail
  - LOGGER
```
public static final org.slf4j.Logger LOGGER
```
  - features
```
protected Graph.Features features
```
  - baseGraph
```
protected org.neo4j.tinkerpop.api.Neo4jGraphAPI baseGraph
```
  - configuration
```
protected org.apache.commons.configuration.BaseConfiguration configuration
```
  - CONFIG_DIRECTORY
```
public static final String CONFIG_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - CONFIG_CONF
```
public static final String CONFIG_CONF
```
    See Also:
    
    Constant Field Values
  - CONFIG_META_PROPERTIES
```
public static final String CONFIG_META_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - CONFIG_MULTI_PROPERTIES
```
public static final String CONFIG_MULTI_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - trait
```
protected Neo4jTrait trait
```
- Constructor Detail
  - Neo4jGraph
```
protected Neo4jGraph(org.neo4j.tinkerpop.api.Neo4jGraphAPI baseGraph,
                     org.apache.commons.configuration.Configuration configuration)
```
  - Neo4jGraph
```
protected Neo4jGraph(org.apache.commons.configuration.Configuration configuration)
```
- Method Detail
  - open
```
public static Neo4jGraph open(org.apache.commons.configuration.Configuration configuration)
```
    Open a new Neo4jGraph instance.
    
    Parameters:
    
    configuration - the configuration for the instance
    
    Returns:
    
    a newly opened Graph
  - open
```
public static Neo4jGraph open(String directory)
```
    Construct a Neo4jGraph instance by specifying the directory to create the database in..
  - open
```
public static Neo4jGraph open(org.neo4j.tinkerpop.api.Neo4jGraphAPI baseGraph)
```
    Construct a Neo4jGraph instance using an existing Neo4j raw instance.
  - addVertex
```
public Vertex addVertex(Object... keyValues)
```
    Specified by:
    
    addVertex in interface Graph
  - vertices
```
public Iterator<Vertex> vertices(Object... vertexIds)
```
    Specified by:
    
    vertices in interface Graph
  - edges
```
public Iterator<Edge> edges(Object... edgeIds)
```
    Specified by:
    
    edges in interface Graph
  - getTrait
```
public Neo4jTrait getTrait()
```
  - compute
```
public <C extends GraphComputer> C compute(Class<C> graphComputerClass)
```
    Specified by:
    
    compute in interface Graph
  - compute
```
public GraphComputer compute()
```
    Specified by:
    
    compute in interface Graph
  - tx
```
public Transaction tx()
```
    Specified by:
    
    tx in interface Graph
  - variables
```
public Graph.Variables variables()
```
    Specified by:
    
    variables in interface Graph
  - configuration
```
public org.apache.commons.configuration.Configuration configuration()
```
    Specified by:
    
    configuration in interface Graph
  - close
```
public void close()
           throws Exception
```
    This implementation of close will also close the current transaction on the thread, but it is up to the caller to deal with dangling transactions in other threads prior to calling this method.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Graph
    
    Throws:
    
    Exception
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - features
```
public Graph.Features features()
```
    Specified by:
    
    features in interface Graph
  - getBaseGraph
```
public org.neo4j.tinkerpop.api.Neo4jGraphAPI getBaseGraph()
```
    Specified by:
    
    getBaseGraph in interface WrappedGraph<org.neo4j.tinkerpop.api.Neo4jGraphAPI>
  - cypher
```
public <S,E> GraphTraversal<S,E> cypher(String query)
```
    Execute the Cypher query and get the result set as a GraphTraversal.
    
    Parameters:
    
    query - the Cypher query to execute
    
    Returns:
    
    a fluent Gremlin traversal
  - cypher
```
public <S,E> GraphTraversal<S,E> cypher(String query,
                                        Map<String,Object> parameters)
```
    Execute the Cypher query with provided parameters and get the result set as a GraphTraversal.
    
    Parameters:
    
    query - the Cypher query to execute
    
    parameters - the parameters of the Cypher query
    
    Returns:
    
    a fluent Gremlin traversal

Class Neo4jGraph

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

Field Detail

LOGGER

features

baseGraph

configuration

CONFIG_DIRECTORY

CONFIG_CONF

CONFIG_META_PROPERTIES

CONFIG_MULTI_PROPERTIES

trait

Constructor Detail

Neo4jGraph

Neo4jGraph

Method Detail

open

open

open

addVertex

vertices

edges

getTrait

compute

compute

tx

variables

configuration

close

toString

features

getBaseGraph

cypher

cypher