Neo4j Community

org.neo4j.cypher.javacompat
Interface PlanDescription


public interface PlanDescription

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 PlanDescription object.


Method Summary
 PlanDescription cd(String... names)
          Starting from this PlanDescription, retrieve children by successive calls to getChild() and return the final PlanDescription thus found
 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.
 PlanDescription getChild(String name)
           
 List<PlanDescription> getChildren()
           
 String getName()
           
 ProfilerStatistics getProfilerStatistics()
           
 boolean hasProfilerStatistics()
           
 

Method Detail

getName

String getName()
Returns:
descriptive name for this kind of execution step

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

cd

PlanDescription cd(String... names)
                   throws NoSuchElementException
Starting from this PlanDescription, retrieve children by successive calls to getChild() and return the final PlanDescription thus found

Returns:
PlanDescription of the final child retrieved
Throws:
NoSuchElementException - if no child could be retrieved

getChild

PlanDescription getChild(String name)
                         throws NoSuchElementException
Returns:
first child PlanDescription found by searching all children that have the given name
Throws:
NoSuchElementException - if no matching child is found

getChildren

List<PlanDescription> getChildren()
Returns:
list of previous (child) execution step descriptions

hasProfilerStatistics

boolean hasProfilerStatistics()
Returns:
true, if ProfilerStatistics are available for this execution step

getProfilerStatistics

ProfilerStatistics getProfilerStatistics()
                                         throws org.neo4j.cypher.ProfilerStatisticsNotReadyException
Returns:
profiler statistics for this execution step iff available
Throws:
org.neo4j.cypher.ProfilerStatisticsNotReadyException - iff profiler statistics are not available

Neo4j Community

Copyright © 2002-2014 The Neo4j Graph Database Project. All Rights Reserved.