com.tinkerpop.blueprints.util.wrappers.id

Class IdVertexIndex

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.id.IdVertexIndex

All Implemented Interfaces:

Index<Vertex>

public class IdVertexIndex
extends Object
implements Index<Vertex>

Author:

Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
IdVertexIndex(Index<Vertex> baseIndex, IdGraph idGraph)

Method Summary

Methods

Modifier and Type	Method and Description
long	count(String key, Object value) Get a count of elements with a particular key/value pair.
CloseableIterable<Vertex>	get(String key, Object value) Get all elements that are indexed by the provided key/value.
Class<Vertex>	getIndexClass() Get the class that this index is indexing.
String	getIndexName() Get the name of the index.
void	put(String key, Object value, Vertex element) Index an element by a key and a value.
CloseableIterable<Vertex>	query(String key, Object query) Get all the elements that are indexed by the provided key and specified query object.
void	remove(String key, Object value, Vertex element) Remove an element indexed by a particular key/value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdVertexIndex

public IdVertexIndex(Index<Vertex> baseIndex,
             IdGraph idGraph)

Method Detail

getIndexName

public String getIndexName()

Description copied from interface: Index

Get the name of the index.

Specified by:

getIndexName in interface Index<Vertex>

Returns:

the name of the index

getIndexClass

public Class<Vertex> getIndexClass()

Description copied from interface: Index

Get the class that this index is indexing.

Specified by:

getIndexClass in interface Index<Vertex>

Returns:

the class this index is indexing

put

public void put(String key,
       Object value,
       Vertex element)

Description copied from interface: Index

Index an element by a key and a value.

Specified by:

put in interface Index<Vertex>

Parameters:

key - the key to index the element by

value - the value to index the element by

element - the element to index

get

public CloseableIterable<Vertex> get(String key,
                            Object value)

Description copied from interface: Index

Get all elements that are indexed by the provided key/value.

Specified by:

get in interface Index<Vertex>

Parameters:

key - the key of the indexed elements

value - the value of the indexed elements

Returns:

an iterable of elements that have a particular key/value in the index

query

public CloseableIterable<Vertex> query(String key,
                              Object query)

Description copied from interface: Index

Get all the elements that are indexed by the provided key and specified query object. This is useful for graph implementations that support complex query capabilities. If querying is not supported, simply throw an UnsupportedOperationException.

Specified by:

query in interface Index<Vertex>

Parameters:

key - the key of the indexed elements

query - the query object for the indexed elements' keys

Returns:

an iterable of elements that have a particular key/value in the index that match the query object

count

public long count(String key,
         Object value)

Description copied from interface: Index

Get a count of elements with a particular key/value pair. The semantics are the same as the get method.

Specified by:

count in interface Index<Vertex>

Parameters:

key - denoting the sub-index to search

value - the value to search for

Returns:

the collection of elements that meet that criteria

remove

public void remove(String key,
          Object value,
          Vertex element)

Description copied from interface: Index

Remove an element indexed by a particular key/value.

Specified by:

remove in interface Index<Vertex>

Parameters:

key - the key of the indexed element

value - the value of the indexed element

element - the element to remove given the key/value pair