Package org.eclipse.rdf4j.query.explanation

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

  • Field Details

  • Constructor Details

    • GenericPlanNode

      public GenericPlanNode()

    • GenericPlanNode

      public GenericPlanNode(String type)

  • Method Details

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

    • getHasNextCallCountActual

      public Long getHasNextCallCountActual()

    • setHasNextCallCountActual

      public void setHasNextCallCountActual(Long hasNextCallCountActual)

    • getHasNextTrueCountActual

      public Long getHasNextTrueCountActual()

    • setHasNextTrueCountActual

      public void setHasNextTrueCountActual(Long hasNextTrueCountActual)

    • getHasNextTimeNanosActual

      public Long getHasNextTimeNanosActual()

    • setHasNextTimeNanosActual

      public void setHasNextTimeNanosActual(Long hasNextTimeNanosActual)

    • getNextCallCountActual

      public Long getNextCallCountActual()

    • setNextCallCountActual

      public void setNextCallCountActual(Long nextCallCountActual)

    • getNextTimeNanosActual

      public Long getNextTimeNanosActual()

    • setNextTimeNanosActual

      public void setNextTimeNanosActual(Long nextTimeNanosActual)

    • getJoinRightIteratorsCreatedActual

      public Long getJoinRightIteratorsCreatedActual()

    • setJoinRightIteratorsCreatedActual

      public void setJoinRightIteratorsCreatedActual(Long joinRightIteratorsCreatedActual)

    • getJoinLeftBindingsConsumedActual

      public Long getJoinLeftBindingsConsumedActual()

    • setJoinLeftBindingsConsumedActual

      public void setJoinLeftBindingsConsumedActual(Long joinLeftBindingsConsumedActual)

    • getJoinRightBindingsConsumedActual

      public Long getJoinRightBindingsConsumedActual()

    • setJoinRightBindingsConsumedActual

      public void setJoinRightBindingsConsumedActual(Long joinRightBindingsConsumedActual)

    • getSourceRowsScannedActual

      public Long getSourceRowsScannedActual()

    • setSourceRowsScannedActual

      public void setSourceRowsScannedActual(Long sourceRowsScannedActual)

    • getSourceRowsMatchedActual

      public Long getSourceRowsMatchedActual()

    • setSourceRowsMatchedActual

      public void setSourceRowsMatchedActual(Long sourceRowsMatchedActual)

    • getSourceRowsFilteredActual

      public Long getSourceRowsFilteredActual()

    • setSourceRowsFilteredActual

      public void setSourceRowsFilteredActual(Long sourceRowsFilteredActual)

    • setRuntimeTelemetryEnabled

      public void setRuntimeTelemetryEnabled(boolean runtimeTelemetryEnabled)

    • setEstimateStabilityMetricsEnabled

      public void setEstimateStabilityMetricsEnabled(boolean estimateStabilityMetricsEnabled)

    • applyExplanationLevel

      public void applyExplanationLevel(Explanation.Level level)

    • getLongMetricsActual

      public Map<String,Long> getLongMetricsActual()

    • setLongMetricsActual

      public void setLongMetricsActual(Map<String,Long> longMetricsActual)

    • getLongMetricActual

      public Long getLongMetricActual(String metricName)

    • setLongMetricActual

      public void setLongMetricActual(String metricName, Long metricValue)

    • getDoubleMetricsActual

      public Map<String,Double> getDoubleMetricsActual()

    • setDoubleMetricsActual

      public void setDoubleMetricsActual(Map<String,Double> doubleMetricsActual)

    • getDoubleMetricActual

      public Double getDoubleMetricActual(String metricName)

    • setDoubleMetricActual

      public void setDoubleMetricActual(String metricName, Double metricValue)

    • getStringMetricsActual

      public Map<String,String> getStringMetricsActual()

    • setStringMetricsActual

      public void setStringMetricsActual(Map<String,String> stringMetricsActual)

    • getStringMetricActual

      public String getStringMetricActual(String metricName)

    • setStringMetricActual

      public void setStringMetricActual(String metricName, String metricValue)

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

    • setSelfTimeActual

      public void setSelfTimeActual(Double ignoredSelfTimeActual)
      Accepts selfTimeActual when deserializing JSON for compatibility with clients/servers that include this derived field.

    • 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.
      Overrides:
      toString in class Object
      Returns:
      an unparsable string

    • toDot

      public String toDot()

    • getID

      public String getID()