com.tinkerpop.blueprints

Class Features

java.lang.Object

com.tinkerpop.blueprints.Features

public class Features
extends Object

Features provides a listing of the features/qualities/quirks associated with any Graph implementation. This feature listing can be used to dynamically adjust code to the features of the graph implementation. For example, this feature listing is used extensively throughout the Blueprints TestSuite to validate behavior of the implementation.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	hasImplicitElements Does the graph return elements not explicitly created with addVertex or addEdge?
Boolean	ignoresSuppliedIds Does the graph ignore user provided ids in graph.addVertex(Object id)?
Boolean	isPersistent Does the graph persist the graph to disk after shutdown?
Boolean	isWrapper Does the graph implement WrapperGraph?
Boolean	supportsBooleanProperty Does the graph allows boolean to be used as a property value for a graph element?
Boolean	supportsDoubleProperty Does the graph allows double to be used as a property value for a graph element?
Boolean	supportsDuplicateEdges Does the graph allow for two edges with the same vertices and edge label to exist?
Boolean	supportsEdgeIndex Does the graph support the indexing of edges by their properties?
Boolean	supportsEdgeIteration Does the graph support graph.getEdges()?
Boolean	supportsEdgeKeyIndex Does the graph support key indexing on edges?
Boolean	supportsEdgeProperties Does the graph support setting and retrieving properties on edges?
Boolean	supportsEdgeRetrieval Does the graph support retrieving edges by id, i.e.
Boolean	supportsFloatProperty Does the graph allows float to be used as a property value for a graph element?
Boolean	supportsIndices Does the graph implement IndexableGraph?
Boolean	supportsIntegerProperty Does the graph allows integer to be used as a property value for a graph element?
Boolean	supportsKeyIndices Does the graph implement KeyIndexableGraph?
Boolean	supportsLongProperty Does the graph allows long to be used as a property value for a graph element?
Boolean	supportsMapProperty Does the graph allows map to be used as a property value for a graph element?
Boolean	supportsMixedListProperty Does the graph allows a mixed list (different data types within the same list) to be used as a property value for a graph element?
Boolean	supportsPrimitiveArrayProperty Does the graph allows a primitive array to be used as a property value for a graph element?
Boolean	supportsSelfLoops Does the graph allow an edge to have the same out/tail and in/head vertex?
Boolean	supportsSerializableObjectProperty Does the graph allow any serializable object to be used as a property value for a graph element?
Boolean	supportsStringProperty Graph allows string to be used as a property value for a graph element.
Boolean	supportsThreadedTransactions Does the graph implement ThreadedTransactionalGraph?
Boolean	supportsThreadIsolatedTransactions Does the graph support transactions managed such that multiple threads operating on the same graph instance can have isolated transactions?
Boolean	supportsTransactions Does the graph implement TransactionalGraph?
Boolean	supportsUniformListProperty Does the graph allows list (all objects with the list have the same data types) to be used as a property value for a graph element?
Boolean	supportsVertexIndex Does the graph support the indexing of vertices by their properties?
Boolean	supportsVertexIteration Does the graph support graph.getVertices()?
Boolean	supportsVertexKeyIndex Does the graph support key indexing on vertices?
Boolean	supportsVertexProperties Does the graph support setting and retrieving properties on vertices?

Constructor Summary

Constructors

Constructor and Description
Features()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCompliance() This method determines whether the full gamut of features have been set by the Graph implementation.
Features	copyFeatures() This method copies the features in this features object to another feature object.
boolean	supportsElementProperties() Checks whether the graph supports both vertex and edge properties
Map	toMap()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

supportsDuplicateEdges

public Boolean supportsDuplicateEdges

Does the graph allow for two edges with the same vertices and edge label to exist?

supportsSelfLoops

public Boolean supportsSelfLoops

Does the graph allow an edge to have the same out/tail and in/head vertex?

supportsSerializableObjectProperty

public Boolean supportsSerializableObjectProperty

Does the graph allow any serializable object to be used as a property value for a graph element?

supportsBooleanProperty

public Boolean supportsBooleanProperty

Does the graph allows boolean to be used as a property value for a graph element?

supportsDoubleProperty

public Boolean supportsDoubleProperty

Does the graph allows double to be used as a property value for a graph element?

supportsFloatProperty

public Boolean supportsFloatProperty

Does the graph allows float to be used as a property value for a graph element?

supportsIntegerProperty

public Boolean supportsIntegerProperty

Does the graph allows integer to be used as a property value for a graph element?

supportsPrimitiveArrayProperty

public Boolean supportsPrimitiveArrayProperty

Does the graph allows a primitive array to be used as a property value for a graph element?

supportsUniformListProperty

public Boolean supportsUniformListProperty

Does the graph allows list (all objects with the list have the same data types) to be used as a property value for a graph element?

supportsMixedListProperty

public Boolean supportsMixedListProperty

Does the graph allows a mixed list (different data types within the same list) to be used as a property value for a graph element?

supportsLongProperty

public Boolean supportsLongProperty

Does the graph allows long to be used as a property value for a graph element?

supportsMapProperty

public Boolean supportsMapProperty

Does the graph allows map to be used as a property value for a graph element?

supportsStringProperty

public Boolean supportsStringProperty

Graph allows string to be used as a property value for a graph element.

hasImplicitElements

public Boolean hasImplicitElements

Does the graph return elements not explicitly created with addVertex or addEdge?

ignoresSuppliedIds

public Boolean ignoresSuppliedIds

Does the graph ignore user provided ids in graph.addVertex(Object id)?

isPersistent

public Boolean isPersistent

Does the graph persist the graph to disk after shutdown?

isWrapper

public Boolean isWrapper

Does the graph implement WrapperGraph?

supportsIndices

public Boolean supportsIndices

Does the graph implement IndexableGraph?

supportsVertexIndex

public Boolean supportsVertexIndex

Does the graph support the indexing of vertices by their properties?

supportsEdgeIndex

public Boolean supportsEdgeIndex

Does the graph support the indexing of edges by their properties?

supportsKeyIndices

public Boolean supportsKeyIndices

Does the graph implement KeyIndexableGraph?

supportsVertexKeyIndex

public Boolean supportsVertexKeyIndex

Does the graph support key indexing on vertices?

supportsEdgeKeyIndex

public Boolean supportsEdgeKeyIndex

Does the graph support key indexing on edges?

supportsEdgeIteration

public Boolean supportsEdgeIteration

Does the graph support graph.getEdges()?

supportsVertexIteration

public Boolean supportsVertexIteration

Does the graph support graph.getVertices()?

supportsEdgeRetrieval

public Boolean supportsEdgeRetrieval

Does the graph support retrieving edges by id, i.e. graph.getEdge(Object id)?

supportsVertexProperties

public Boolean supportsVertexProperties

Does the graph support setting and retrieving properties on vertices?

supportsEdgeProperties

public Boolean supportsEdgeProperties

Does the graph support setting and retrieving properties on edges?

supportsTransactions

public Boolean supportsTransactions

Does the graph implement TransactionalGraph?

supportsThreadedTransactions

public Boolean supportsThreadedTransactions

Does the graph implement ThreadedTransactionalGraph?

supportsThreadIsolatedTransactions

public Boolean supportsThreadIsolatedTransactions

Does the graph support transactions managed such that multiple threads operating on the same graph instance can have isolated transactions?

Constructor Detail

Features

public Features()

Method Detail

supportsElementProperties

public boolean supportsElementProperties()

Checks whether the graph supports both vertex and edge properties

Returns:

whether the graph supports both vertex and edge properties

toString

public String toString()

Overrides:

toString in class Object

toMap

public Map toMap()

checkCompliance

public void checkCompliance()
                     throws IllegalStateException

This method determines whether the full gamut of features have been set by the Graph implementation. This is useful for implementers to ensure that they did not miss specifying a feature.

Throws:

IllegalStateException - thrown if a feature was not set

copyFeatures

public Features copyFeatures()

This method copies the features in this features object to another feature object.

Returns:

a feature object with a clone of the features in the prior.