org.neo4j.graphdb

Interface ExecutionPlanDescription

public interface ExecutionPlanDescription

Instances describe single execution steps in a Cypher query execution plan Execution plans form a tree of execution steps. Each step is described by a ExecutionPlanDescription object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExecutionPlanDescription.ProfilerStatistics Instances describe statistics from the profiler of a particular step in the execution plan.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getArguments() Retrieve argument map for the associated execution step Valid arguments are all Java primitive values, Strings, Arrays of those, and Maps from Strings to valid arguments.
List<ExecutionPlanDescription>	getChildren() Retrieves the children of this execution step.
Set<String>	getIdentifiers()
String	getName() Retrieves the name of this execution step.
ExecutionPlanDescription.ProfilerStatistics	getProfilerStatistics() Retrieve the statistics collected from profiling this query.
boolean	hasProfilerStatistics() Signifies that the query was profiled, and that statistics from the profiling can be retrieved.

Method Detail

getName

String getName()

Retrieves the name of this execution step.

Returns:

descriptive name for this kind of execution step

getChildren

List<ExecutionPlanDescription> getChildren()

Retrieves the children of this execution step.

Returns:

list of previous (child) execution step descriptions

getArguments

Map<String,Object> getArguments()

Retrieve argument map for the associated execution step Valid arguments are all Java primitive values, Strings, Arrays of those, and Maps from Strings to valid arguments. Results are guaranteed to be trees (i.e. there are no cyclic dependencies among values)

Returns:

a map containing arguments that describe this execution step in more detail

getIdentifiers

Set<String> getIdentifiers()

Returns:

the set of identifiers used in this execution step

hasProfilerStatistics

boolean hasProfilerStatistics()

Signifies that the query was profiled, and that statistics from the profiling can be retrieved. The PROFILE directive in Cypher ensures the presence of profiler statistics in the plan description.

Returns:

true, if ExecutionPlanDescription.ProfilerStatistics are available for this execution step

getProfilerStatistics

ExecutionPlanDescription.ProfilerStatistics getProfilerStatistics()

Retrieve the statistics collected from profiling this query. If the query was not profiled, this method will throw NoSuchElementException.

Returns:

profiler statistics for this execution step iff available

Throws:

NoSuchElementException - iff profiler statistics are not available