org.neo4j.cypher.javacompat

Class ExecutionResult

java.lang.Object

org.neo4j.cypher.javacompat.ExecutionResult

All Implemented Interfaces:

AutoCloseable, Iterable<Map<String,Object>>, Iterator<Map<String,Object>>, Resource, ResourceIterable<Map<String,Object>>, ResourceIterator<Map<String,Object>>, Result

Deprecated.

See Result, and use GraphDatabaseService.execute(String, Map) instead.

@Deprecated
public class ExecutionResult
extends Object
implements ResourceIterable<Map<String,Object>>, Result

Holds Cypher query result sets, in tabular form. Each row of the result is a map of column name to result object. Each column name correlates directly with the terms used in the "return" clause of the Cypher query. The result objects could be Nodes, Relationships or java primitives. Either iterate directly over the ExecutionResult to retrieve each row of the result set, or use columnAs() to access a single column with result objects cast to a type.

Field Summary

Fields inherited from interface org.neo4j.graphdb.Resource

EMPTY

Constructor Summary

Constructors

Constructor and Description
ExecutionResult(org.neo4j.cypher.ExtendedExecutionResult projection) Deprecated. Constructor used by the Cypher framework.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Deprecated. Closes the result, freeing up any resources held by the result.
<T> ResourceIterator<T>	columnAs(String n) Deprecated. Returns an iterator with the result objects from a single column of the result set.
List<String>	columns() Deprecated. The exact names used to represent each column in the result set.
String	dumpToString() Deprecated. Provides a textual representation of the query result.
PlanDescription	executionPlanDescription() Deprecated. Returns a string representation of the query plan used to produce this result.
ExecutionPlanDescription	getExecutionPlanDescription() Deprecated. Returns a description of the query plan used to produce this result.
QueryExecutionType	getQueryExecutionType() Deprecated. Indicates what kind of query execution produced this result.
QueryStatistics	getQueryStatistics() Deprecated. Returns statistics about this result.
boolean	hasNext() Deprecated. Denotes there being more rows available in this result.
ResourceIterator<Map<String,Object>>	iterator() Deprecated. Returns an iterator over the return clause of the query.
Map<String,Object>	next() Deprecated. Returns the next row in this result.
void	remove() Deprecated. Removing rows from the result is not supported.
String	resultAsString() Deprecated. Provides a textual representation of the query result.
String	toString() Deprecated.
void	toString(PrintWriter writer) Deprecated.
void	writeAsStringTo(PrintWriter writer) Deprecated. Provides a textual representation of the query result to the provided PrintWriter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionResult

public ExecutionResult(org.neo4j.cypher.ExtendedExecutionResult projection)

Deprecated.

Constructor used by the Cypher framework. End-users should not create an ExecutionResult directly, but instead use the result returned from calling ExecutionEngine.execute(String).

Parameters:

projection - Execution result projection to use.

Method Detail

columnAs

public <T> ResourceIterator<T> columnAs(String n)

Deprecated.

Returns an iterator with the result objects from a single column of the result set. This method is best used for single column results.

To ensure that any resources, including transactions bound to it, are properly closed, the iterator must either be fully exhausted, or the close() method must be called.

Specified by:

columnAs in interface Result

Type Parameters:

T - desired type cast for the result objects

Parameters:

n - exact name of the column, as it appeared in the original query

Returns:

an iterator of the result objects, possibly empty

Throws:

ClassCastException - when the result object can not be cast to the requested type

NotFoundException - when the column name does not appear in the original query

getQueryExecutionType

public QueryExecutionType getQueryExecutionType()

Deprecated.

Description copied from interface: Result

Indicates what kind of query execution produced this result.

Specified by:

getQueryExecutionType in interface Result

Returns:

an object that indicates what kind of query was executed to produce this result.

columns

public List<String> columns()

Deprecated.

The exact names used to represent each column in the result set.

Specified by:

columns in interface Result

Returns:

List of the column names.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

dumpToString

public String dumpToString()

Deprecated.

Provides a textual representation of the query result.

The execution result represented by this object will be consumed in its entirety after this method is called. Calling any of the other iterating methods on it should not be expected to return any results.

Returns:

Returns the execution result

getQueryStatistics

public QueryStatistics getQueryStatistics()

Deprecated.

Returns statistics about this result.

Specified by:

getQueryStatistics in interface Result

Returns:

statistics about this result

executionPlanDescription

public PlanDescription executionPlanDescription()

Deprecated.

Returns a string representation of the query plan used to produce this result.

Returns:

a string representation of the query plan used to produce this result.

toString

public void toString(PrintWriter writer)

Deprecated.

iterator

public ResourceIterator<Map<String,Object>> iterator()

Deprecated.

Returns an iterator over the return clause of the query. The format is a map that has as keys the names of the columns or their explicit names (set via 'as') and the value is the calculated value. Each iterator item is one row of the query result.

To ensure that any resources, including transactions bound to it, are properly closed, the iterator must either be fully exhausted, or the close() method must be called.

Specified by:

iterator in interface Iterable<Map<String,Object>>

Specified by:

iterator in interface ResourceIterable<Map<String,Object>>

Returns:

An iterator over the result of the query as a map from projected column name to value

hasNext

public boolean hasNext()

Deprecated.

Description copied from interface: Result

Denotes there being more rows available in this result. These rows must either be consumed, by invoking Result.next(), or the result has to be closed.

Specified by:

hasNext in interface Iterator<Map<String,Object>>

Specified by:

hasNext in interface Result

Returns:

true if there is more rows available in this result, false otherwise.

next

public Map<String,Object> next()

Deprecated.

Description copied from interface: Result

Returns the next row in this result.

Specified by:

next in interface Iterator<Map<String,Object>>

Specified by:

next in interface Result

Returns:

the next row in this result.

close

public void close()

Deprecated.

Description copied from interface: Result

Closes the result, freeing up any resources held by the result. This is an idempotent operation, invoking it multiple times has the same effect as invoking it exactly once. It is thus safe (and even encouraged, for style and simplicity) to invoke this method even after consuming all rows in the result through the next-method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Resource

Specified by:

close in interface ResourceIterator<Map<String,Object>>

Specified by:

close in interface Result

getExecutionPlanDescription

public ExecutionPlanDescription getExecutionPlanDescription()

Deprecated.

Description copied from interface: Result

Returns a description of the query plan used to produce this result. Retrieving a description of the execution plan that was executed is always possible, regardless of whether the query requested a plan or not. For implementing a client with the ability to present the plan to the user, it is useful to be able to tell if the query requested a description of the plan or not. For these purposes the QueryExecutionType.requestedExecutionPlanDescription()-method is used. Being able to invoke this method, regardless of whether the user requested the plan or not is useful for purposes of debugging queries in applications.

Specified by:

getExecutionPlanDescription in interface Result

Returns:

a description of the query plan used to produce this result.

resultAsString

public String resultAsString()

Deprecated.

Description copied from interface: Result

Provides a textual representation of the query result.

The execution result represented by this object will be consumed in its entirety after this method is called. Calling any of the other iterating methods on it should not be expected to return any results.

Specified by:

resultAsString in interface Result

Returns:

the execution result formatted as a string

writeAsStringTo

public void writeAsStringTo(PrintWriter writer)

Deprecated.

Description copied from interface: Result

Provides a textual representation of the query result to the provided PrintWriter.

The execution result represented by this object will be consumed in its entirety after this method is called. Calling any of the other iterating methods on it should not be expected to return any results.

Specified by:

writeAsStringTo in interface Result

Parameters:

writer - the PrintWriter to receive the textual representation of the query result.

remove

public void remove()

Deprecated.

Description copied from interface: Result

Removing rows from the result is not supported.

Specified by:

remove in interface Iterator<Map<String,Object>>

Specified by:

remove in interface Result