Class GenericPlanNode
- java.lang.Object
-
- org.eclipse.rdf4j.query.explanation.GenericPlanNode
-
@Experimental public class GenericPlanNode extends Object
This is an experimental feature. The interface may be changed, moved or potentially removed in a future release. The interface is used to implement query explanations (query plan)- Since:
- 3.2.0
-
-
Constructor Summary
Constructors Constructor Description GenericPlanNode()GenericPlanNode(String type)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPlans(GenericPlanNode... children)StringgetAlgorithm()Join nodes can use various algorithms for joining data.DoublegetCostEstimate()The cost estimate that the query planner calculated for this node.List<GenericPlanNode>getPlans()LonggetResultSizeActual()The actual number of results that this node produced while the query was executed.DoublegetResultSizeEstimate()The number of results that this node was estimated to produce.DoublegetSelfTimeActual()The time that this node used by itself (eg.BooleangetTimedOut()DoublegetTotalTimeActual()The total time in milliseconds that this node-tree (all children and so on) used while the query was executed.StringgetType()StringgetUUID()BooleanisNewScope()voidsetAlgorithm(String algorithm)voidsetCostEstimate(Double costEstimate)voidsetNewScope(boolean newScope)voidsetPlans(List<GenericPlanNode> plans)voidsetResultSizeActual(Long resultSizeActual)voidsetResultSizeEstimate(Double resultSizeEstimate)voidsetTimedOut(Boolean timedOut)voidsetTotalTimeActual(Double totalTimeActual)voidsetType(String type)StringtoDot()StringtoString()Human readable string.
-
-
-
Field Detail
-
UNKNOWN
public static final String UNKNOWN
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GenericPlanNode
public GenericPlanNode()
-
GenericPlanNode
public GenericPlanNode(String type)
-
-
Method Detail
-
getType
public String getType()
-
setType
public void setType(String type)
-
getPlans
public List<GenericPlanNode> getPlans()
-
setPlans
public void setPlans(List<GenericPlanNode> plans)
-
addPlans
public void addPlans(GenericPlanNode... children)
-
getCostEstimate
public Double getCostEstimate()
The cost estimate that the query planner calculated for this node. Value has no meaning outside of this explanation and is only used to compare and order the nodes in the query plan.- Returns:
- a cost estimate as a double value
-
setCostEstimate
public void setCostEstimate(Double costEstimate)
-
getResultSizeEstimate
public Double getResultSizeEstimate()
The number of results that this node was estimated to produce.- Returns:
- result size estimate
-
setResultSizeEstimate
public void setResultSizeEstimate(Double resultSizeEstimate)
-
getResultSizeActual
public Long getResultSizeActual()
The actual number of results that this node produced while the query was executed.- Returns:
- number of results that this query produced
-
setResultSizeActual
public void setResultSizeActual(Long resultSizeActual)
-
getTotalTimeActual
public Double getTotalTimeActual()
The total time in milliseconds that this node-tree (all children and so on) used while the query was executed.- Returns:
- time in milliseconds that was used to execute the query
-
setTotalTimeActual
public void setTotalTimeActual(Double totalTimeActual)
-
setTimedOut
public void setTimedOut(Boolean timedOut)
-
getTimedOut
public Boolean getTimedOut()
-
getSelfTimeActual
public Double getSelfTimeActual()
The time that this node used by itself (eg. totalTimeActual - sum of plans[0..n].totalTimeActual)
-
isNewScope
public Boolean isNewScope()
- Returns:
- true if this node introduces a new scope
-
setNewScope
public void setNewScope(boolean newScope)
-
getAlgorithm
public String getAlgorithm()
Join nodes can use various algorithms for joining data.- Returns:
- the name of the algorithm.
-
setAlgorithm
public void setAlgorithm(String algorithm)
-
toString
public String toString()
Human readable string. Do not attempt to parse this.
-
toDot
public String toDot()
-
getUUID
public String getUUID()
-
-