fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper

Class IdGraph<G extends IdGraph<G>>

java.lang.Object

fr.inria.atlanmod.neoemf.data.blueprints.internal.graph.wrapper.IdGraph<G>

Type Parameters:

G - the "self"-type of this graph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph, com.tinkerpop.blueprints.IndexableGraph, com.tinkerpop.blueprints.KeyIndexableGraph, com.tinkerpop.blueprints.TransactionalGraph, com.tinkerpop.blueprints.util.wrappers.WrapperGraph<com.tinkerpop.blueprints.KeyIndexableGraph>

Direct Known Subclasses:

ModelGraph

@ParametersAreNonnullByDefault
public class IdGraph<G extends IdGraph<G>>
extends Object
implements com.tinkerpop.blueprints.util.wrappers.WrapperGraph<com.tinkerpop.blueprints.KeyIndexableGraph>, com.tinkerpop.blueprints.KeyIndexableGraph, com.tinkerpop.blueprints.IndexableGraph, com.tinkerpop.blueprints.TransactionalGraph

A KeyIndexableGraph able to map the result of each method call to a dedicated implementation.

Re-implemented from com.tinkerpop.blueprints.util.wrappers.id.IdGraph.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

com.tinkerpop.blueprints.TransactionalGraph.Conclusion

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ID The property key used to identify Vertex and Edge instances.

Constructor Summary

Constructors

Constructor and Description
IdGraph(com.tinkerpop.blueprints.KeyIndexableGraph baseGraph, boolean supportVertexIds, boolean supportEdgeIds) Adds custom ID functionality to the given graph, supporting either custom vertex IDs, custom edge IDs, or both.

Method Summary

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Edge	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label)
<E extends com.tinkerpop.blueprints.Edge> E	addEdge(Object id, com.tinkerpop.blueprints.Vertex outVertex, com.tinkerpop.blueprints.Vertex inVertex, String label, BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc) Add an edge to the graph.
com.tinkerpop.blueprints.Vertex	addVertex(Object id)
<V extends com.tinkerpop.blueprints.Vertex> V	addVertex(Object id, BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc) Create a new vertex, add it to the graph, and return the newly created vertex.
void	commit()
<E extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<E>	createIndex(String indexName, Class<E> indexClass, com.tinkerpop.blueprints.Parameter... indexParameters)
<T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U>	createIndex(String indexName, Class<T> indexClass, BiFunction<T,G,U> mappingFunc) Generate an index with a particular name for a particular class.
<E extends com.tinkerpop.blueprints.Element> void	createKeyIndex(String key, Class<E> elementClass, com.tinkerpop.blueprints.Parameter... indexParameters)
void	dropIndex(String indexName)
<E extends com.tinkerpop.blueprints.Element> void	dropKeyIndex(String key, Class<E> elementClass)
com.tinkerpop.blueprints.KeyIndexableGraph	getBaseGraph()
com.tinkerpop.blueprints.Edge	getEdge(Object id)
<E extends com.tinkerpop.blueprints.Edge> Optional<E>	getEdge(Object id, BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc) Return the edge referenced by the provided object identifier.
Iterable<com.tinkerpop.blueprints.Edge>	getEdges()
<E extends com.tinkerpop.blueprints.Edge> Iterable<E>	getEdges(BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc) Return an iterable to all the edges in the graph.
Iterable<com.tinkerpop.blueprints.Edge>	getEdges(String key, Object value)
<E extends com.tinkerpop.blueprints.Edge> Iterable<E>	getEdges(String key, Object value, BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc) Return an iterable to all the edges in the graph that have a particular key/value property.
com.tinkerpop.blueprints.Features	getFeatures()
<E extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<E>	getIndex(String indexName, Class<E> indexClass)
<T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U>	getIndex(String indexName, Class<T> indexClass, BiFunction<T,G,U> mappingFunc) Get an index from the graph by its name and index class.
<E extends com.tinkerpop.blueprints.Element> Set<String>	getIndexedKeys(Class<E> elementClass)
Iterable<com.tinkerpop.blueprints.Index<? extends com.tinkerpop.blueprints.Element>>	getIndices()
<T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U>	getOrCreateIndex(String indexName, Class<T> indexClass, BiFunction<T,G,U> mappingFunc) Returns the index, from the graph, by its name and index class.
com.tinkerpop.blueprints.Vertex	getVertex(Object id)
<V extends com.tinkerpop.blueprints.Vertex> Optional<V>	getVertex(Object id, BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc) Return the vertex referenced by the provided object identifier.
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices()
<V extends com.tinkerpop.blueprints.Vertex> Iterable<V>	getVertices(BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc) Return an iterable to all the vertices in the graph.
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(String key, Object value)
<V extends com.tinkerpop.blueprints.Vertex> Iterable<V>	getVertices(String key, Object value, BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc) Return an iterable to all the vertices in the graph that have a particular key/value property.
boolean	isSupportEdgeIds() Returns true if this graph support custom edge IDs.
boolean	isSupportVertexIds() Returns true if this graph support custom vertex IDs.
IdGraphQuery<G>	query()
void	removeEdge(com.tinkerpop.blueprints.Edge edge)
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex)
void	rollback()
void	shutdown()
void	stopTransaction(com.tinkerpop.blueprints.TransactionalGraph.Conclusion conclusion) Deprecated. Follow the Blueprints API
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ID

@Nonnull
protected static final String ID

The property key used to identify Vertex and Edge instances. NOTE: using "__id" instead of "_id" avoids collision with Rexster's "_id".

See Also:

Constant Field Values

Constructor Detail

IdGraph

public IdGraph(com.tinkerpop.blueprints.KeyIndexableGraph baseGraph,
               boolean supportVertexIds,
               boolean supportEdgeIds)

Adds custom ID functionality to the given graph, supporting either custom vertex IDs, custom edge IDs, or both.

Parameters:

baseGraph - the base graph which does not necessarily support custom IDs

supportVertexIds - whether to support custom vertex IDs

supportEdgeIds - whether to support custom edge IDs

Method Detail

isSupportVertexIds

public boolean isSupportVertexIds()

Returns true if this graph support custom vertex IDs.

Returns:

true if this graph support custom vertex IDs.

isSupportEdgeIds

public boolean isSupportEdgeIds()

Returns true if this graph support custom edge IDs.

Returns:

true if this graph support custom edge IDs.

getFeatures

@Nonnull
public com.tinkerpop.blueprints.Features getFeatures()

Specified by:

getFeatures in interface com.tinkerpop.blueprints.Graph

addVertex

@Nonnull
public com.tinkerpop.blueprints.Vertex addVertex(@Nullable
                                                           Object id)

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(Object id)

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

removeVertex

public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)

Specified by:

removeVertex in interface com.tinkerpop.blueprints.Graph

getVertices

@Nonnull
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices()

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getVertices

@Nonnull
public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(String key,
                                                                       Object value)

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

addEdge

@Nonnull
public com.tinkerpop.blueprints.Edge addEdge(@Nullable
                                                       Object id,
                                                       com.tinkerpop.blueprints.Vertex outVertex,
                                                       com.tinkerpop.blueprints.Vertex inVertex,
                                                       String label)

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

getEdge

public com.tinkerpop.blueprints.Edge getEdge(Object id)

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

removeEdge

public void removeEdge(com.tinkerpop.blueprints.Edge edge)

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

getEdges

@Nonnull
public Iterable<com.tinkerpop.blueprints.Edge> getEdges()

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getEdges

@Nonnull
public Iterable<com.tinkerpop.blueprints.Edge> getEdges(String key,
                                                                  Object value)

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

query

@Nonnull
public IdGraphQuery<G> query()

Specified by:

query in interface com.tinkerpop.blueprints.Graph

shutdown

public void shutdown()

Specified by:

shutdown in interface com.tinkerpop.blueprints.Graph

getBaseGraph

@Nonnull
public com.tinkerpop.blueprints.KeyIndexableGraph getBaseGraph()

Specified by:

getBaseGraph in interface com.tinkerpop.blueprints.util.wrappers.WrapperGraph<com.tinkerpop.blueprints.KeyIndexableGraph>

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

stopTransaction

@Deprecated
public void stopTransaction(com.tinkerpop.blueprints.TransactionalGraph.Conclusion conclusion)

Deprecated. Follow the Blueprints API

This is a no-op if the base graph is not an instance of TransactionalGraph.

Specified by:

stopTransaction in interface com.tinkerpop.blueprints.TransactionalGraph

commit

public void commit()

Specified by:

commit in interface com.tinkerpop.blueprints.TransactionalGraph

rollback

public void rollback()

Specified by:

rollback in interface com.tinkerpop.blueprints.TransactionalGraph

dropKeyIndex

public <E extends com.tinkerpop.blueprints.Element> void dropKeyIndex(String key,
                                                                      Class<E> elementClass)

Specified by:

dropKeyIndex in interface com.tinkerpop.blueprints.KeyIndexableGraph

createKeyIndex

public <E extends com.tinkerpop.blueprints.Element> void createKeyIndex(String key,
                                                                        Class<E> elementClass,
                                                                        com.tinkerpop.blueprints.Parameter... indexParameters)

Specified by:

createKeyIndex in interface com.tinkerpop.blueprints.KeyIndexableGraph

getIndexedKeys

@Nonnull
public <E extends com.tinkerpop.blueprints.Element> Set<String> getIndexedKeys(Class<E> elementClass)

Specified by:

getIndexedKeys in interface com.tinkerpop.blueprints.KeyIndexableGraph

createIndex

@Nonnull
public <E extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<E> createIndex(String indexName,
                                                                                                            Class<E> indexClass,
                                                                                                            com.tinkerpop.blueprints.Parameter... indexParameters)

Specified by:

createIndex in interface com.tinkerpop.blueprints.IndexableGraph

getIndex

public <E extends com.tinkerpop.blueprints.Element> com.tinkerpop.blueprints.Index<E> getIndex(String indexName,
                                                                                               Class<E> indexClass)

Specified by:

getIndex in interface com.tinkerpop.blueprints.IndexableGraph

getIndices

@Nonnull
public Iterable<com.tinkerpop.blueprints.Index<? extends com.tinkerpop.blueprints.Element>> getIndices()

Specified by:

getIndices in interface com.tinkerpop.blueprints.IndexableGraph

dropIndex

public void dropIndex(String indexName)

Specified by:

dropIndex in interface com.tinkerpop.blueprints.IndexableGraph

addVertex

@Nonnull
public <V extends com.tinkerpop.blueprints.Vertex> V addVertex(@Nullable
                                                                         Object id,
                                                                         BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc)

Create a new vertex, add it to the graph, and return the newly created vertex.

Type Parameters:

V - the type of the vertex after mapping

Parameters:

id - the identifier of the vertex

mappingFunc - the function to create a new dedicated vertex from another

Returns:

the newly created vertex

See Also:

addVertex(Object)

getVertex

@Nonnull
public <V extends com.tinkerpop.blueprints.Vertex> Optional<V> getVertex(Object id,
                                                                                   BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc)

Return the vertex referenced by the provided object identifier.

Type Parameters:

V - the type of the vertex after mapping

Parameters:

id - the identifier of the vertex

mappingFunc - the function to create a new dedicated vertex from another

Returns:

an Optional containing the vertex referenced by the provided identifier

See Also:

getVertex(Object)

getVertices

@Nonnull
public <V extends com.tinkerpop.blueprints.Vertex> Iterable<V> getVertices(BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc)

Return an iterable to all the vertices in the graph.

Type Parameters:

V - the type of the vertex after mapping

Parameters:

mappingFunc - the function to create a new dedicated vertex from another

Returns:

an iterable reference to all vertices in the graph

See Also:

getVertices()

getVertices

@Nonnull
public <V extends com.tinkerpop.blueprints.Vertex> Iterable<V> getVertices(String key,
                                                                                     Object value,
                                                                                     BiFunction<com.tinkerpop.blueprints.Vertex,G,V> mappingFunc)

Return an iterable to all the vertices in the graph that have a particular key/value property.

Type Parameters:

V - the type of the vertex after mapping

Parameters:

key - the key of vertex

value - the value of the vertex

mappingFunc - the function to create a new dedicated vertex from another

Returns:

an iterable of vertices with provided key and value

See Also:

getVertices(String, Object)

addEdge

@Nonnull
public <E extends com.tinkerpop.blueprints.Edge> E addEdge(@Nullable
                                                                     Object id,
                                                                     com.tinkerpop.blueprints.Vertex outVertex,
                                                                     com.tinkerpop.blueprints.Vertex inVertex,
                                                                     String label,
                                                                     BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc)

Add an edge to the graph. The added edges requires a recommended identifier, a tail vertex, an head vertex, and a label.

Type Parameters:

E - the type of the edge after mapping

Parameters:

id - the identifier of the edge

outVertex - the vertex on the tail of the edge

inVertex - the vertex on the head of the edge

label - the label associated with the edge

mappingFunc - the function to create a new dedicated edge from another

Returns:

the newly created edge

See Also:

addEdge(Object, Vertex, Vertex, String)

getEdge

@Nonnull
public <E extends com.tinkerpop.blueprints.Edge> Optional<E> getEdge(Object id,
                                                                               BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc)

Return the edge referenced by the provided object identifier.

Type Parameters:

E - the type of the edge after mapping

Parameters:

id - the identifier of the edge to retrieved from the graph

mappingFunc - the function to create a new dedicated edge from another

Returns:

an Optional containing the edge referenced by the provided identifier

See Also:

getEdge(Object)

getEdges

@Nonnull
public <E extends com.tinkerpop.blueprints.Edge> Iterable<E> getEdges(BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc)

Return an iterable to all the edges in the graph.

Type Parameters:

E - the type of the edge after mapping

Parameters:

mappingFunc - the function to create a new dedicated edge from another

Returns:

an iterable reference to all edges in the graph

See Also:

getEdges()

getEdges

@Nonnull
public <E extends com.tinkerpop.blueprints.Edge> Iterable<E> getEdges(String key,
                                                                                Object value,
                                                                                BiFunction<com.tinkerpop.blueprints.Edge,G,E> mappingFunc)

Return an iterable to all the edges in the graph that have a particular key/value property.

Type Parameters:

E - the type of the edge after mapping

Parameters:

key - the key of the edge

value - the value of the edge

mappingFunc - the function to create a new dedicated edge from another

Returns:

an iterable of edges with provided key and value

See Also:

getEdges(String, Object)

createIndex

@Nonnull
public <T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U> createIndex(String indexName,
                                                                                                                        Class<T> indexClass,
                                                                                                                        BiFunction<T,G,U> mappingFunc)

Generate an index with a particular name for a particular class.

Type Parameters:

T - the element class that this index is indexing (can be base class)

U - the type of the edge indexed element mapping

Parameters:

indexName - the name of the manual index

indexClass - the element class that this index is indexing (can be base class)

mappingFunc - the function to create a new dedicated element from another

Returns:

the index created

See Also:

createIndex(String, Class, Parameter[])

getIndex

@Nullable
public <T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U> getIndex(String indexName,
                                                                                                                      Class<T> indexClass,
                                                                                                                      BiFunction<T,G,U> mappingFunc)

Get an index from the graph by its name and index class. An index is unique up to name.

Type Parameters:

T - the class of the elements being indexed (can be base class)

U - the type of the edge indexed element mapping

Parameters:

indexName - the name of the index to retrieve

indexClass - the class of the elements being indexed (can be base class)

mappingFunc - the function to create a new dedicated element from another

Returns:

the retrieved index

See Also:

getIndex(String, Class)

getOrCreateIndex

@Nonnull
public <T extends com.tinkerpop.blueprints.Element,U extends T> com.tinkerpop.blueprints.Index<U> getOrCreateIndex(String indexName,
                                                                                                                             Class<T> indexClass,
                                                                                                                             BiFunction<T,G,U> mappingFunc)

Returns the index, from the graph, by its name and index class. An index is unique up to name. If no such index exists, it will be created.

Type Parameters:

T - the element class that this index is indexing (can be base class)

U - the type of the edge indexed element mapping

Parameters:

indexName - the name of the manual index

indexClass - the element class that this index is indexing (can be base class)

mappingFunc - the function to create a new dedicated element from another

Returns:

the index

See Also:

getIndex(String, Class, BiFunction), createIndex(String, Class, BiFunction)