Package hydra.tinkerpop.features

Class Features

java.lang.Object

hydra.tinkerpop.features.Features

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Features>

public class Features
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Features>

An interface that represents the capabilities of a Graph implementation. By default all methods of features return true and it is up to implementers to disable feature they don't support. Users should check features prior to using various functions of TinkerPop to help ensure code portability across implementations. For example, a common usage would be to check if a graph supports transactions prior to calling the commit method on Graph.tx(). As an additional notice to Graph Providers, feature methods will be used by the test suite to determine which tests will be ignored and which will be executed, therefore proper setting of these features is essential to maximizing the amount of testing performed by the suite. Further note, that these methods may be called by the TinkerPop core code to determine what operations may be appropriately executed which will have impact on features utilized by users.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
EdgeFeatures	edge	Gets the features related to edge operation.
static Name	EDGE	Name of the hydra.tinkerpop.features.Features.edge field.
GraphFeatures	graph	Gets the features related to graph operation.
static Name	GRAPH	Name of the hydra.tinkerpop.features.Features.graph field.
static Name	TYPE_	Name of the hydra.tinkerpop.features.Features type.
VertexFeatures	vertex	Gets the features related to vertex operation.
static Name	VERTEX	Name of the hydra.tinkerpop.features.Features.vertex field.

Constructor Summary

Constructors

Constructor	Description
Features(EdgeFeatures edge, GraphFeatures graph, VertexFeatures vertex)	Constructs an immutable Features.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Features other)
boolean	equals(java.lang.Object other)
int	hashCode()
Features	withEdge(EdgeFeatures edge)	Returns a copy of this Features with edge replaced.
Features	withGraph(GraphFeatures graph)	Returns a copy of this Features with graph replaced.
Features	withVertex(VertexFeatures vertex)	Returns a copy of this Features with vertex replaced.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_

public static final Name TYPE_

Name of the hydra.tinkerpop.features.Features type.

EDGE

public static final Name EDGE

Name of the hydra.tinkerpop.features.Features.edge field.

GRAPH

public static final Name GRAPH

Name of the hydra.tinkerpop.features.Features.graph field.

VERTEX

public static final Name VERTEX

Name of the hydra.tinkerpop.features.Features.vertex field.

edge

public final EdgeFeatures edge

Gets the features related to edge operation.

graph

public final GraphFeatures graph

Gets the features related to graph operation.

vertex

public final VertexFeatures vertex

Gets the features related to vertex operation.

Constructor Detail

Features

public Features(EdgeFeatures edge,
                GraphFeatures graph,
                VertexFeatures vertex)

Constructs an immutable Features.

Parameters:

edge - Gets the features related to edge operation.

graph - Gets the features related to graph operation.

vertex - Gets the features related to vertex operation.

Method Detail

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Features other)

Specified by:

compareTo in interface java.lang.Comparable<Features>

withEdge

public Features withEdge(EdgeFeatures edge)

Returns a copy of this Features with edge replaced.

withGraph

public Features withGraph(GraphFeatures graph)

Returns a copy of this Features with graph replaced.

withVertex

public Features withVertex(VertexFeatures vertex)

Returns a copy of this Features with vertex replaced.