-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
PlanDescription.java
81 lines (72 loc) · 2.92 KB
/
PlanDescription.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/**
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.cypher.javacompat;
import org.neo4j.cypher.ProfilerStatisticsNotReadyException;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
/**
* 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.
*
*/
public interface PlanDescription
{
/**
* @return descriptive name for this kind of execution step
*/
public String getName();
/**
* 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)
*
* @return a map containing arguments that describe this execution step in more detail
*/
public Map<String, Object> getArguments();
/**
* Starting from this PlanDescription, retrieve children by successive calls to getChild() and
* return the final PlanDescription thus found
*
* @return PlanDescription of the final child retrieved
* @throws NoSuchElementException if no child could be retrieved
*/
public PlanDescription cd(String... names) throws NoSuchElementException;
/**
* @return first child PlanDescription found by searching all children that have the given name
* @throws java.util.NoSuchElementException if no matching child is found
*/
public PlanDescription getChild(String name) throws NoSuchElementException;
/**
* @return list of previous (child) execution step descriptions
*/
public List<PlanDescription> getChildren();
/**
* @return true, if ProfilerStatistics are available for this execution step
*/
public boolean hasProfilerStatistics();
/**
* @return profiler statistics for this execution step iff available
* @throws ProfilerStatisticsNotReadyException iff profiler statistics are not available
*/
public ProfilerStatistics getProfilerStatistics() throws ProfilerStatisticsNotReadyException;
}