com.mware.ge.cypher.internal.javacompat

Class ExecutionResult

java.lang.Object

com.mware.ge.cypher.internal.javacompat.ExecutionResult

All Implemented Interfaces:

QueryResultProvider, Result, com.mware.ge.io.Resource, com.mware.ge.io.ResourceIterable<Map<String,Object>>, com.mware.ge.io.ResourceIterator<Map<String,Object>>, AutoCloseable, Iterable<Map<String,Object>>, Iterator<Map<String,Object>>

public class ExecutionResult
extends Object
implements com.mware.ge.io.ResourceIterable<Map<String,Object>>, Result, QueryResultProvider

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 com.mware.ge.cypher.Result

Result.ResultRow, Result.ResultVisitor<VisitationException extends Exception>

Field Summary

Fields inherited from interface com.mware.ge.io.Resource

EMPTY

Constructor Summary

Constructors

Constructor and Description
ExecutionResult(InternalExecutionResult projection) Constructor used by the Cypher framework.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.mware.ge.io.ResourceIterator

map

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ExecutionResult

public ExecutionResult(InternalExecutionResult projection)

Constructor used by the Cypher framework. End-users should not create an ExecutionResult directly, but instead use the result returned from calling QueryExecutionEngine.executeQuery(String, MapValue, GeCypherQueryContext) )}.

Parameters:

projection - Execution result projection to use.

Method Detail

columnAs

public <T> com.mware.ge.io.ResourceIterator<T> columnAs(String n)

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()

Specified by:

getQueryExecutionType in interface Result

columns

public List<String> columns()

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()

Overrides:

toString in class Object

dumpToString

public String dumpToString()

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()

Returns statistics about this result.

Specified by:

getQueryStatistics in interface Result

Returns:

statistics about this result

toString

public void toString(PrintWriter writer)

iterator

public com.mware.ge.io.ResourceIterator<Map<String,Object>> iterator()

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 com.mware.ge.io.ResourceIterable<Map<String,Object>>

Specified by:

iterator in interface Iterable<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()

Specified by:

stream in interface com.mware.ge.io.ResourceIterable<Map<String,Object>>

Specified by:

stream in interface com.mware.ge.io.ResourceIterator<Map<String,Object>>

Returns:

this result as a Stream

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Result

Specified by:

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

next

public Map<String,Object> next()

Specified by:

next in interface Result

Specified by:

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

close

public void close()

Specified by:

close in interface Result

Specified by:

close in interface com.mware.ge.io.Resource

Specified by:

close in interface com.mware.ge.io.ResourceIterator<Map<String,Object>>

Specified by:

close in interface AutoCloseable

getExecutionPlanDescription

public ExecutionPlanDescription getExecutionPlanDescription()

Specified by:

getExecutionPlanDescription in interface Result

resultAsString

public String resultAsString()

Specified by:

resultAsString in interface Result

writeAsStringTo

public void writeAsStringTo(PrintWriter writer)

Specified by:

writeAsStringTo in interface Result

remove

public void remove()

Specified by:

remove in interface Result

Specified by:

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

accept

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

Specified by:

accept in interface Result

Throws:

VisitationException extends Exception

getNotifications

public Iterable<Notification> getNotifications()

Specified by:

getNotifications in interface Result

internalExecutionResult

public InternalExecutionResult internalExecutionResult()

queryResult

public QueryResult queryResult()

Specified by:

queryResult in interface QueryResultProvider