org.janusgraph.core

Interface JanusGraphIndexQuery

All Known Implementing Classes:

IndexQueryBuilder

public interface JanusGraphIndexQuery

A GraphQuery that queries for graph elements directly against a particular indexing backend and hence allows this query mechanism to exploit the full range of features and functionality of the indexing backend. However, the results returned by this query will not be adjusted to the modifications in a transaction. If there are no changes in a transaction, this won't matter. If there are, the results of this query may not be consistent with the transactional state.

Author:

Matthias Broecheler ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JanusGraphIndexQuery.Result<V extends org.apache.tinkerpop.gremlin.structure.Element> Container of a query result with its score.

Method Summary

Modifier and Type	Method and Description
JanusGraphIndexQuery	addParameter(Parameter para) Adds the given parameter to the list of parameters of this query.
JanusGraphIndexQuery	addParameters(Iterable<Parameter> paras) Adds the given parameters to the list of parameters of this query.
JanusGraphIndexQuery	addParameters(Parameter... paras) Adds the given parameters to the list of parameters of this query.
Iterable<JanusGraphIndexQuery.Result<JanusGraphEdge>>	edges() Deprecated. use edgeStream() instead.
Stream<JanusGraphIndexQuery.Result<JanusGraphEdge>>	edgeStream() Returns all edges that match the query in the indexing backend.
Long	edgeTotals() Returns total edges that match the query in the indexing backend ignoring limit and offset.
JanusGraphIndexQuery	limit(int limit) Specifies the maximum number of elements to return
JanusGraphIndexQuery	offset(int offset) Specifies the offset of the query.
JanusGraphIndexQuery	orderBy(String key, org.apache.tinkerpop.gremlin.process.traversal.Order order) Orders the element results of this query according to their property for the given key in the given order (increasing/decreasing).
Iterable<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>>	properties() Deprecated. use propertyStream() instead.
Stream<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>>	propertyStream() Returns all properties that match the query in the indexing backend.
Long	propertyTotals() Returns total properties that match the query in the indexing backend ignoring limit and offset.
JanusGraphIndexQuery	setElementIdentifier(String identifier) Sets the element identifier string that is used by this query builder as the token to identifier key references in the query string.
Stream<JanusGraphIndexQuery.Result<JanusGraphVertex>>	vertexStream() Returns all vertices that match the query in the indexing backend.
Long	vertexTotals() Returns total vertices that match the query in the indexing backend ignoring limit and offset.
Iterable<JanusGraphIndexQuery.Result<JanusGraphVertex>>	vertices() Deprecated. use vertexStream() instead.

Method Detail

limit

JanusGraphIndexQuery limit(int limit)

Specifies the maximum number of elements to return

Parameters:

limit -

Returns:

offset

JanusGraphIndexQuery offset(int offset)

Specifies the offset of the query. Query results will be retrieved starting at the given offset.

Parameters:

offset -

Returns:

orderBy

JanusGraphIndexQuery orderBy(String key,
                             org.apache.tinkerpop.gremlin.process.traversal.Order order)

Orders the element results of this query according to their property for the given key in the given order (increasing/decreasing).

Parameters:

key - The key of the properties on which to order

order - the ordering direction

Returns:

addParameter

JanusGraphIndexQuery addParameter(Parameter para)

Adds the given parameter to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.

Parameters:

para -

Returns:

addParameters

JanusGraphIndexQuery addParameters(Iterable<Parameter> paras)

Adds the given parameters to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.

Parameters:

paras -

Returns:

addParameters

JanusGraphIndexQuery addParameters(Parameter... paras)

Adds the given parameters to the list of parameters of this query. Parameters are passed right through to the indexing backend to modify the query behavior.

Parameters:

paras -

Returns:

setElementIdentifier

JanusGraphIndexQuery setElementIdentifier(String identifier)

Sets the element identifier string that is used by this query builder as the token to identifier key references in the query string.

For example, in the query 'v.name: Tom' the element identifier is 'v.'

Parameters:

identifier - The element identifier which must not be blank

Returns:

This query builder

vertices

@Deprecated
Iterable<JanusGraphIndexQuery.Result<JanusGraphVertex>> vertices()

Deprecated. use vertexStream() instead.

Returns all vertices that match the query in the indexing backend.

Returns:

vertexStream

Stream<JanusGraphIndexQuery.Result<JanusGraphVertex>> vertexStream()

Returns all vertices that match the query in the indexing backend.

Returns:

edges

@Deprecated
Iterable<JanusGraphIndexQuery.Result<JanusGraphEdge>> edges()

Deprecated. use edgeStream() instead.

Returns all edges that match the query in the indexing backend.

Returns:

edgeStream

Stream<JanusGraphIndexQuery.Result<JanusGraphEdge>> edgeStream()

Returns all edges that match the query in the indexing backend.

Returns:

properties

@Deprecated
Iterable<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>> properties()

Deprecated. use propertyStream() instead.

Returns all properties that match the query in the indexing backend.

Returns:

propertyStream

Stream<JanusGraphIndexQuery.Result<JanusGraphVertexProperty>> propertyStream()

Returns all properties that match the query in the indexing backend.

Returns:

vertexTotals

Long vertexTotals()

Returns total vertices that match the query in the indexing backend ignoring limit and offset.

Returns:

edgeTotals

Long edgeTotals()

Returns total edges that match the query in the indexing backend ignoring limit and offset.

Returns:

propertyTotals

Long propertyTotals()

Returns total properties that match the query in the indexing backend ignoring limit and offset.

Returns: