com.tinkerpop.gremlin.structure.strategy

Class IdStrategy

java.lang.Object

com.tinkerpop.gremlin.structure.strategy.IdStrategy

All Implemented Interfaces:

GraphStrategy

public final class IdStrategy
extends java.lang.Object
implements GraphStrategy

A GraphStrategy implementation which enables mapper element IDs even for those graphs which don't otherwise support them.

For those graphs which support vertex indices but not edge indices (or vice versa), the strategy can be configured to use mapper IDs only for vertices or only for edges. ID generation is also configurable via ID Supplier functions.

If the IdStrategy is used in combination with a sequence of other strategies and when ID assignment is enabled for an element, calls to strategies following this one are not made. It is important to consider that aspect of its operation when doing strategy composition. Typically, the IdStrategy should be executed last in a sequence.

Author:

Joshua Shinavier (http://fortytwo.net), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdStrategy.Builder

Method Summary

Modifier and Type	Method and Description
static IdStrategy.Builder	build(java.lang.String idKey) Create the IdStrategy.Builder to create a IdStrategy.
java.util.function.UnaryOperator<TriFunction<java.lang.String,Vertex,java.lang.Object[],Edge>>	getAddEdgeStrategy(StrategyContext<StrategyVertex> ctx, GraphStrategy composingStrategy) Construct a TriFunction that enhances the features of Vertex.addEdge(String, com.tinkerpop.gremlin.structure.Vertex, Object...).
java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],Vertex>>	getAddVertexStrategy(StrategyContext<StrategyGraph> ctx, GraphStrategy composingStrategy) Construct a Function that enhances the features of Graph.addVertex(Object...).
java.util.function.UnaryOperator<java.util.function.Supplier<java.lang.Object>>	getEdgeIdStrategy(StrategyContext<StrategyEdge> ctx, GraphStrategy composingStrategy) Construct a Supplier that enhances the features of Element.id().
<V> java.util.function.UnaryOperator<java.util.function.BiFunction<java.lang.String,V,Property<V>>>	getEdgePropertyStrategy(StrategyContext<StrategyEdge> ctx, GraphStrategy composingStrategy) Construct a BiFunction that enhances the features of Element.property(String, Object).
java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],GraphTraversal<Edge,Edge>>>	getGraphEStrategy(StrategyContext<StrategyGraph> ctx, GraphStrategy composingStrategy) Construct a Function that enhances the features of Graph.E(java.lang.Object...).
java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],java.util.Iterator<Edge>>>	getGraphIteratorsEdgeIteratorStrategy(StrategyContext<StrategyGraph> ctx, GraphStrategy composingStrategy) Construct a Function that enhances the features of Graph.Iterators.edgeIterator(java.lang.Object...).
java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],java.util.Iterator<Vertex>>>	getGraphIteratorsVertexIteratorStrategy(StrategyContext<StrategyGraph> ctx, GraphStrategy composingStrategy) Construct a Function that enhances the features of Graph.Iterators.vertexIterator(java.lang.Object...).
java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],GraphTraversal<Vertex,Vertex>>>	getGraphVStrategy(StrategyContext<StrategyGraph> ctx, GraphStrategy composingStrategy) Construct a Function that enhances the features of Graph.V(java.lang.Object...).
java.lang.String	getIdKey() Gets the property name of the key used to lookup graph elements.
java.util.function.UnaryOperator<java.util.function.Supplier<java.lang.Object>>	getVertexIdStrategy(StrategyContext<StrategyVertex> ctx, GraphStrategy composingStrategy) Construct a Supplier that enhances the features of Element.id().
<V> java.util.function.UnaryOperator<java.util.function.BiFunction<java.lang.String,V,VertexProperty<V>>>	getVertexPropertyStrategy(StrategyContext<StrategyVertex> ctx, GraphStrategy composingStrategy) Construct a BiFunction that enhances the features of Vertex.property(String, Object).
boolean	isSupportsEdgeId()
boolean	isSupportsVertexId()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.gremlin.structure.strategy.GraphStrategy

getEdgeGetPropertyStrategy, getEdgeGraphStrategy, getEdgeIteratorsPropertyIteratorStrategy, getEdgeIteratorsValueIteratorStrategy, getEdgeIteratorsVertexIteratorStrategy, getEdgeKeysStrategy, getEdgeLabelStrategy, getEdgeValueStrategy, getGraphCloseStrategy, getPropertyKeyStrategy, getPropertyValueStrategy, getRemoveEdgeStrategy, getRemovePropertyStrategy, getRemoveVertexPropertyStrategy, getRemoveVertexStrategy, getVariableAsMapStrategy, getVariableGetStrategy, getVariableKeysStrategy, getVariableRemoveStrategy, getVariableSetStrategy, getVertexGetPropertyStrategy, getVertexGraphStrategy, getVertexIteratorsEdgeIteratorStrategy, getVertexIteratorsPropertyIteratorStrategy, getVertexIteratorsValueIteratorStrategy, getVertexIteratorsVertexIteratorStrategy, getVertexKeysStrategy, getVertexLabelStrategy, getVertexPropertyGetElementStrategy, getVertexPropertyGraphStrategy, getVertexPropertyIdStrategy, getVertexPropertyIteratorsPropertyIteratorStrategy, getVertexPropertyIteratorsValueIteratorStrategy, getVertexPropertyKeysStrategy, getVertexPropertyKeyStrategy, getVertexPropertyLabelStrategy, getVertexPropertyPropertyStrategy, getVertexPropertyValueStrategy, getVertexValueStrategy

Method Detail

getAddVertexStrategy

public java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],Vertex>> getAddVertexStrategy(StrategyContext<StrategyGraph> ctx,
                                                                                                                     GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Function that enhances the features of Graph.addVertex(Object...).

Specified by:

getAddVertexStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Function with Graph.addVertex(Object...) signature and returns an enhanced strategy Function with the same signature

getAddEdgeStrategy

public java.util.function.UnaryOperator<TriFunction<java.lang.String,Vertex,java.lang.Object[],Edge>> getAddEdgeStrategy(StrategyContext<StrategyVertex> ctx,
                                                                                                                         GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a TriFunction that enhances the features of Vertex.addEdge(String, com.tinkerpop.gremlin.structure.Vertex, Object...).

Specified by:

getAddEdgeStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a TriFunction with Vertex.addEdge(String, com.tinkerpop.gremlin.structure.Vertex, Object...) signature and returns an enhanced strategy Function with the same signature

getGraphIteratorsEdgeIteratorStrategy

public java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],java.util.Iterator<Edge>>> getGraphIteratorsEdgeIteratorStrategy(StrategyContext<StrategyGraph> ctx,
                                                                                                                                                        GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Function that enhances the features of Graph.Iterators.edgeIterator(java.lang.Object...).

Specified by:

getGraphIteratorsEdgeIteratorStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Function with Graph.Iterators.edgeIterator(java.lang.Object...) signature and returns an enhanced strategy Supplier with the same signature

getGraphIteratorsVertexIteratorStrategy

public java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],java.util.Iterator<Vertex>>> getGraphIteratorsVertexIteratorStrategy(StrategyContext<StrategyGraph> ctx,
                                                                                                                                                            GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Function that enhances the features of Graph.Iterators.vertexIterator(java.lang.Object...).

Specified by:

getGraphIteratorsVertexIteratorStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Function with Graph.Iterators.vertexIterator(java.lang.Object...) signature and returns an enhanced strategy Supplier with the same signature

getGraphEStrategy

public java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],GraphTraversal<Edge,Edge>>> getGraphEStrategy(StrategyContext<StrategyGraph> ctx,
                                                                                                                                     GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Function that enhances the features of Graph.E(java.lang.Object...).

Specified by:

getGraphEStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Function with Graph.E(java.lang.Object...) signature and returns an enhanced strategy Function with the same signature

getGraphVStrategy

public java.util.function.UnaryOperator<java.util.function.Function<java.lang.Object[],GraphTraversal<Vertex,Vertex>>> getGraphVStrategy(StrategyContext<StrategyGraph> ctx,
                                                                                                                                         GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Function that enhances the features of Graph.V(java.lang.Object...).

Specified by:

getGraphVStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Function with Graph.V(java.lang.Object...) signature and returns an enhanced strategy Function with the same signature

getVertexIdStrategy

public java.util.function.UnaryOperator<java.util.function.Supplier<java.lang.Object>> getVertexIdStrategy(StrategyContext<StrategyVertex> ctx,
                                                                                                           GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Supplier that enhances the features of Element.id().

Specified by:

getVertexIdStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Supplier with Element.id() signature and returns an enhanced strategy Supplier with the same signature

getEdgeIdStrategy

public java.util.function.UnaryOperator<java.util.function.Supplier<java.lang.Object>> getEdgeIdStrategy(StrategyContext<StrategyEdge> ctx,
                                                                                                         GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a Supplier that enhances the features of Element.id().

Specified by:

getEdgeIdStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a Supplier with Element.id() signature and returns an enhanced strategy Supplier with the same signature

getVertexPropertyStrategy

public <V> java.util.function.UnaryOperator<java.util.function.BiFunction<java.lang.String,V,VertexProperty<V>>> getVertexPropertyStrategy(StrategyContext<StrategyVertex> ctx,
                                                                                                                                           GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a BiFunction that enhances the features of Vertex.property(String, Object).

Specified by:

getVertexPropertyStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a BiFunction with Vertex.property(String, Object) signature and returns an enhanced strategy BiFunction with the same signature

getEdgePropertyStrategy

public <V> java.util.function.UnaryOperator<java.util.function.BiFunction<java.lang.String,V,Property<V>>> getEdgePropertyStrategy(StrategyContext<StrategyEdge> ctx,
                                                                                                                                   GraphStrategy composingStrategy)

Description copied from interface: GraphStrategy

Construct a BiFunction that enhances the features of Element.property(String, Object).

Specified by:

getEdgePropertyStrategy in interface GraphStrategy

Parameters:

ctx - the context within which this strategy function is called

composingStrategy - the strategy that composed this strategy function

Returns:

a Function that accepts a BiFunction with Element.property(String, Object) signature and returns an enhanced strategy BiFunction with the same signature

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIdKey

public java.lang.String getIdKey()

Gets the property name of the key used to lookup graph elements. Use this value to create an index in the underlying graph instance.

isSupportsVertexId

public boolean isSupportsVertexId()

isSupportsEdgeId

public boolean isSupportsEdgeId()

build

public static IdStrategy.Builder build(java.lang.String idKey)

Create the IdStrategy.Builder to create a IdStrategy.

Parameters:

idKey - The key to use for the index to lookup graph elements.