com.goldencode.graphdb

Class GraphDB

java.lang.Object

com.goldencode.graphdb.GraphDB

Direct Known Subclasses:

JanusGraphDB

public abstract class GraphDB
extends java.lang.Object

An abstract adapter to obtain connections and create indexes in a tinkerpop-compatible graph DB.

Field Summary

Fields

Modifier and Type	Field and Description
private static GraphDB	instance The singleton implementation of our graph DB.

Constructor Summary

Constructors

Constructor and Description
GraphDB()

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.tinkerpop.gremlin.structure.Graph	connectGraphDBImpl(org.apache.commons.configuration2.Configuration config) Obtain a graph DB with the connection details specified in the given Configuration.
static void	createIndex(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String[] keys, java.lang.Class<?>[] datatypes, boolean element, boolean uniq) Create a single-property index in the given graph DB.
static void	createIndex(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String[] keys, java.lang.Class<?>[] datatypes, boolean element, boolean uniq, boolean mixed) Create a single-property index in the given graph DB.
static void	createIndex(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String key, java.lang.Class<?> datatype, boolean element, boolean uniq) Create a single-property index in the given graph DB.
static void	createIndex(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String key, java.lang.Class<?> datatype, boolean element, boolean uniq, boolean mixed) Create a single-property index in the given graph DB.
protected abstract void	createIndexImpl(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String[] keys, java.lang.Class<?>[] datatypes, boolean element, boolean uniq, boolean mixed) Create a multy-property index in the given graph DB.
protected abstract void	createIndexImpl(org.apache.tinkerpop.gremlin.structure.Graph db, java.lang.String key, java.lang.Class<?> datatype, boolean element, boolean uniq, boolean mixed) Create a single-property index in the given graph DB.
static org.apache.tinkerpop.gremlin.structure.Graph	obtainGraphDB(org.apache.commons.configuration2.Configuration config) Obtain a graph DB with the connection details specified in the given Configuration.

Methods inherited from class java.lang.Object

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

Field Detail

instance

private static final GraphDB instance

The singleton implementation of our graph DB.

Constructor Detail

GraphDB

public GraphDB()

Method Detail

obtainGraphDB

public static org.apache.tinkerpop.gremlin.structure.Graph obtainGraphDB(org.apache.commons.configuration2.Configuration config)

Obtain a graph DB with the connection details specified in the given Configuration.

Parameters:

config - The connection details.

Returns:

A connected graph DB.

createIndex

public static void createIndex(org.apache.tinkerpop.gremlin.structure.Graph db,
                               java.lang.String key,
                               java.lang.Class<?> datatype,
                               boolean element,
                               boolean uniq)

Create a single-property index in the given graph DB.

Parameters:

db - The graph DB.

key - The property key name to be indexed. This will also be the index name.

datatype - The key's type.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

createIndex

public static void createIndex(org.apache.tinkerpop.gremlin.structure.Graph db,
                               java.lang.String key,
                               java.lang.Class<?> datatype,
                               boolean element,
                               boolean uniq,
                               boolean mixed)

Create a single-property index in the given graph DB.

Parameters:

db - The graph DB.

key - The property key name to be indexed. This will also be the index name.

datatype - The key's type.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

mixed - Flag indicating this index will be created in 'mixed' mode, using an external index.

createIndex

public static void createIndex(org.apache.tinkerpop.gremlin.structure.Graph db,
                               java.lang.String[] keys,
                               java.lang.Class<?>[] datatypes,
                               boolean element,
                               boolean uniq)

Create a single-property index in the given graph DB.

Parameters:

db - The graph DB.

keys - The property key names to be indexed. This will also be the index name.

datatypes - The keys' types.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

createIndex

public static void createIndex(org.apache.tinkerpop.gremlin.structure.Graph db,
                               java.lang.String[] keys,
                               java.lang.Class<?>[] datatypes,
                               boolean element,
                               boolean uniq,
                               boolean mixed)

Create a single-property index in the given graph DB.

Parameters:

db - The graph DB.

keys - The property key names to be indexed. This will also be the index name.

datatypes - The keys' types.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

mixed - Flag indicating this index will be created in 'mixed' mode, using an external index.

connectGraphDBImpl

protected abstract org.apache.tinkerpop.gremlin.structure.Graph connectGraphDBImpl(org.apache.commons.configuration2.Configuration config)

Obtain a graph DB with the connection details specified in the given Configuration.

Parameters:

config - The connection details.

Returns:

A connected graph DB.

createIndexImpl

protected abstract void createIndexImpl(org.apache.tinkerpop.gremlin.structure.Graph db,
                                        java.lang.String key,
                                        java.lang.Class<?> datatype,
                                        boolean element,
                                        boolean uniq,
                                        boolean mixed)

Create a single-property index in the given graph DB.

TODO: multiple properties and custom index backends.

Parameters:

db - The graph DB.

key - The property key name to be indexed. This will also be the index name.

datatype - The key's type.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

mixed - Flag indicating this index will be created in 'mixed' mode, using an external index.

createIndexImpl

protected abstract void createIndexImpl(org.apache.tinkerpop.gremlin.structure.Graph db,
                                        java.lang.String[] keys,
                                        java.lang.Class<?>[] datatypes,
                                        boolean element,
                                        boolean uniq,
                                        boolean mixed)

Create a multy-property index in the given graph DB.

Parameters:

db - The graph DB.

keys - The property key names to be indexed. This will also be the index name.

datatypes - The keys' types.

element - true if the vertex element should be indexed, otherwise the edge element will be indexed.

uniq - true if the index should enforce uniqueness of the given key.

mixed - Flag indicating this index will be created in 'mixed' mode, using an external index.