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>>, org.neo4j.graphdb.Resource, org.neo4j.graphdb.ResourceIterable<Map<String,Object>>, org.neo4j.graphdb.ResourceIterator<Map<String,Object>>, org.neo4j.graphdb.Result

Deprecated.

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

@Deprecated
public class ExecutionResult
extends Object
implements org.neo4j.graphdb.ResourceIterable<Map<String,Object>>, org.neo4j.graphdb.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.graphdb.Result

org.neo4j.graphdb.Result.ResultRow, org.neo4j.graphdb.Result.ResultVisitor<VisitationException extends Exception>

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

Modifier and Type	Method and Description
<VisitationException extends Exception> void	accept(org.neo4j.graphdb.Result.ResultVisitor<VisitationException> visitor) Deprecated.
void	close() Deprecated.
<T> org.neo4j.graphdb.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.
org.neo4j.graphdb.ExecutionPlanDescription	getExecutionPlanDescription() Deprecated.
Iterable<org.neo4j.graphdb.Notification>	getNotifications() Deprecated.
org.neo4j.graphdb.QueryExecutionType	getQueryExecutionType() Deprecated.
QueryStatistics	getQueryStatistics() Deprecated. Returns statistics about this result.
boolean	hasNext() Deprecated.
org.neo4j.graphdb.ResourceIterator<Map<String,Object>>	iterator() Deprecated. Returns an iterator over the return clause of the query.
Map<String,Object>	next() Deprecated.
void	remove() Deprecated.
String	resultAsString() Deprecated.
Stream<Map<String,Object>>	stream() Deprecated.
String	toString() Deprecated.
void	toString(PrintWriter writer) Deprecated.
void	writeAsStringTo(PrintWriter writer) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.neo4j.graphdb.ResourceIterator

map

Methods inherited from interface java.util.Iterator

forEachRemaining

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> org.neo4j.graphdb.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 org.neo4j.graphdb.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

org.neo4j.graphdb.NotFoundException - when the column name does not appear in the original query

getQueryExecutionType

public org.neo4j.graphdb.QueryExecutionType getQueryExecutionType()

Deprecated.

Specified by:

getQueryExecutionType in interface org.neo4j.graphdb.Result

columns

public List<String> columns()

Deprecated.

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

Specified by:

columns in interface org.neo4j.graphdb.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 org.neo4j.graphdb.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 org.neo4j.graphdb.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 org.neo4j.graphdb.ResourceIterable<Map<String,Object>>

Returns:

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

stream

public Stream<Map<String,Object>> stream()

Deprecated.

Specified by:

stream in interface org.neo4j.graphdb.ResourceIterable<Map<String,Object>>

Specified by:

stream in interface org.neo4j.graphdb.ResourceIterator<Map<String,Object>>

Returns:

this result as a Stream

hasNext

public boolean hasNext()

Deprecated.

Specified by:

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

Specified by:

hasNext in interface org.neo4j.graphdb.Result

next

public Map<String,Object> next()

Deprecated.

Specified by:

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

Specified by:

next in interface org.neo4j.graphdb.Result

close

public void close()

Deprecated.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.neo4j.graphdb.Resource

Specified by:

close in interface org.neo4j.graphdb.ResourceIterator<Map<String,Object>>

Specified by:

close in interface org.neo4j.graphdb.Result

getExecutionPlanDescription

public org.neo4j.graphdb.ExecutionPlanDescription getExecutionPlanDescription()

Deprecated.

Specified by:

getExecutionPlanDescription in interface org.neo4j.graphdb.Result

resultAsString

public String resultAsString()

Deprecated.

Specified by:

resultAsString in interface org.neo4j.graphdb.Result

writeAsStringTo

public void writeAsStringTo(PrintWriter writer)

Deprecated.

Specified by:

writeAsStringTo in interface org.neo4j.graphdb.Result

remove

public void remove()

Deprecated.

Specified by:

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

Specified by:

remove in interface org.neo4j.graphdb.Result

accept

public <VisitationException extends Exception> void accept(org.neo4j.graphdb.Result.ResultVisitor<VisitationException> visitor)
                                                    throws VisitationException extends Exception

Deprecated.

Specified by:

accept in interface org.neo4j.graphdb.Result

Throws:

VisitationException extends Exception

getNotifications

public Iterable<org.neo4j.graphdb.Notification> getNotifications()

Deprecated.

Specified by:

getNotifications in interface org.neo4j.graphdb.Result