|
Neo4j | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.neo4j.cypher.javacompat.ExecutionResult
public class ExecutionResult
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.
Constructor Summary | |
---|---|
ExecutionResult(org.neo4j.cypher.ExecutionResult projection)
Constructor used by the Cypher framework. |
Method Summary | ||
---|---|---|
|
columnAs(String n)
Returns an iterator with the result objects from a single column of the result set. |
|
List<String> |
columns()
The exact names used to represent each column in the result set. |
|
String |
dumpToString()
Provides a textual representation of the query result. |
|
PlanDescription |
executionPlanDescription()
Returns a string representation of the query plan used to produce this result. |
|
QueryStatistics |
getQueryStatistics()
Returns statistics about this result. |
|
ResourceIterator<Map<String,Object>> |
iterator()
Returns an iterator over the return clause of the query. |
|
String |
toString()
|
|
void |
toString(PrintWriter writer)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ExecutionResult(org.neo4j.cypher.ExecutionResult projection)
ExecutionEngine.execute(String)
.
projection
- Method Detail |
---|
public <T> ResourceIterator<T> columnAs(String n)
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.
T
- desired type cast for the result objectsn
- exact name of the column, as it appeared in the original query
ClassCastException
- when the result object can not be cast to the requested type
NotFoundException
- when the column name does not appear in the original querypublic List<String> columns()
public String toString()
toString
in class Object
public String dumpToString()
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.
public QueryStatistics getQueryStatistics()
public PlanDescription executionPlanDescription()
public void toString(PrintWriter writer)
public ResourceIterator<Map<String,Object>> iterator()
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.
iterator
in interface Iterable<Map<String,Object>>
iterator
in interface ResourceIterable<Map<String,Object>>
|
Neo4j | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |