Class AggregateFunctionCall

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.NAryValueOperator

org.eclipse.rdf4j.query.algebra.AbstractNAryAggregateOperator

org.eclipse.rdf4j.query.algebra.AggregateFunctionCall

All Implemented Interfaces:

Serializable, Cloneable, AggregateOperator, QueryModelNode, ValueExpr, VariableScopeChange

@Experimental
public class AggregateFunctionCall
extends AbstractNAryAggregateOperator

Custom AggregateOperator function call that can be defined to take an argument and can apply distinct filtering on it.

Author:

Tomas Kovachev t.kovachev1996@gmail.com

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	iri

Fields inherited from class NAryValueOperator

args

Modifier and Type	Field	Description
protected List<ValueExpr>	args	The operator's arguments.

Constructor Summary

Constructors

Constructor	Description
AggregateFunctionCall(String iri, boolean distinct)
AggregateFunctionCall(List<ValueExpr> args, String iri, boolean distinct)

Method Summary

Modifier and Type	Method	Description
AggregateFunctionCall	clone()	Returns a (deep) clone of this query model node.
boolean	equals(Object o)	Returns true if this query model node and its children are recursively equal to o and its children.
String	getIRI()
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
int	hashCode()
void	setIRI(String uri)
<X extends Exception> void	visit(QueryModelVisitor<X> visitor)	Visits this node.

Methods inherited from class AbstractNAryAggregateOperator

isDistinct, setDistinct

Modifier and Type	Method	Description
boolean	isDistinct()
void	setDistinct(boolean distinct)

Methods inherited from class NAryValueOperator

addArgument, getArguments, replaceChildNode, setArguments, visitChildren

Modifier and Type	Method	Description
void	addArgument(ValueExpr arg)
List<ValueExpr>	getArguments()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setArguments(List<ValueExpr> args)
<X extends Exception> void	visitChildren(QueryModelVisitor<X> visitor)	Visits the children of this node.

Methods inherited from class AbstractQueryModelNode

getCardinality, getCostEstimate, getDoubleMetricActual, getDoubleMetricsActual, getHasNextCallCountActual, getHasNextTimeNanosActual, getHasNextTrueCountActual, getJoinLeftBindingsConsumedActual, getJoinRightBindingsConsumedActual, getJoinRightIteratorsCreatedActual, getLongMetricActual, getLongMetricsActual, getNextCallCountActual, getNextTimeNanosActual, getParentNode, getResultSizeActual, getResultSizeEstimate, getSourceRowsFilteredActual, getSourceRowsMatchedActual, getSourceRowsScannedActual, getStringMetricActual, getStringMetricsActual, getTotalTimeNanosActual, isCardinalitySet, isRuntimeTelemetryEnabled, isVariableScopeChange, nullEquals, replaceNodeInList, replaceWith, resetCardinality, setCardinality, setCostEstimate, setDoubleMetricActual, setHasNextCallCountActual, setHasNextTimeNanosActual, setHasNextTrueCountActual, setJoinLeftBindingsConsumedActual, setJoinRightBindingsConsumedActual, setJoinRightIteratorsCreatedActual, setLongMetricActual, setNextCallCountActual, setNextTimeNanosActual, setParentNode, setResultSizeActual, setResultSizeEstimate, setRuntimeTelemetryEnabled, setSourceRowsFilteredActual, setSourceRowsMatchedActual, setSourceRowsScannedActual, setStringMetricActual, setTotalTimeNanosActual, setVariableScopeChange, shouldCacheCardinality, toString

Modifier and Type	Method	Description
double	getCardinality()
double	getCostEstimate()
double	getDoubleMetricActual(String metricName)
Map<String,Double>	getDoubleMetricsActual()
long	getHasNextCallCountActual()
long	getHasNextTimeNanosActual()
long	getHasNextTrueCountActual()
long	getJoinLeftBindingsConsumedActual()
long	getJoinRightBindingsConsumedActual()
long	getJoinRightIteratorsCreatedActual()
long	getLongMetricActual(String metricName)
Map<String,Long>	getLongMetricsActual()
long	getNextCallCountActual()
long	getNextTimeNanosActual()
QueryModelNode	getParentNode()	Gets the node's parent.
long	getResultSizeActual()
double	getResultSizeEstimate()	Returns the number of tuples that this QueryNode predicts will be outputted.
long	getSourceRowsFilteredActual()
long	getSourceRowsMatchedActual()
long	getSourceRowsScannedActual()
String	getStringMetricActual(String metricName)
Map<String,String>	getStringMetricsActual()
long	getTotalTimeNanosActual()
boolean	isCardinalitySet()
boolean	isRuntimeTelemetryEnabled()
boolean	isVariableScopeChange()	indicates if the node represents a variable scope change.
protected boolean	nullEquals(Object o1, Object o2)
protected <T extends QueryModelNode> boolean	replaceNodeInList(List<T> list, QueryModelNode current, QueryModelNode replacement)
void	replaceWith(QueryModelNode replacement)	Default implementation of QueryModelNode.replaceWith(QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.
void	resetCardinality()
void	setCardinality(double cardinality)
void	setCostEstimate(double costEstimate)
void	setDoubleMetricActual(String metricName, double metricValue)
void	setHasNextCallCountActual(long hasNextCallCountActual)
void	setHasNextTimeNanosActual(long hasNextTimeNanosActual)
void	setHasNextTrueCountActual(long hasNextTrueCountActual)
void	setJoinLeftBindingsConsumedActual(long joinLeftBindingsConsumedActual)
void	setJoinRightBindingsConsumedActual(long joinRightBindingsConsumedActual)
void	setJoinRightIteratorsCreatedActual(long joinRightIteratorsCreatedActual)
void	setLongMetricActual(String metricName, long metricValue)
void	setNextCallCountActual(long nextCallCountActual)
void	setNextTimeNanosActual(long nextTimeNanosActual)
void	setParentNode(QueryModelNode parent)	Sets the node's parent.
void	setResultSizeActual(long resultSizeActual)
void	setResultSizeEstimate(double resultSizeEstimate)
void	setRuntimeTelemetryEnabled(boolean runtimeTelemetryEnabled)
void	setSourceRowsFilteredActual(long sourceRowsFilteredActual)
void	setSourceRowsMatchedActual(long sourceRowsMatchedActual)
void	setSourceRowsScannedActual(long sourceRowsScannedActual)
void	setStringMetricActual(String metricName, String metricValue)
void	setTotalTimeNanosActual(long totalTimeNanosActual)
void	setVariableScopeChange(boolean isVariableScopeChange)	Set the value of VariableScopeChange.isVariableScopeChange() to true or false.
protected boolean	shouldCacheCardinality()
String	toString()	Returns an indented print of the node tree, starting from this node.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

iri

protected String iri

Constructor Details

AggregateFunctionCall

public AggregateFunctionCall(String iri,
 boolean distinct)

AggregateFunctionCall

public AggregateFunctionCall(List<ValueExpr> args,
 String iri,
 boolean distinct)

Method Details

getIRI

public String getIRI()

setIRI

public void setIRI(String uri)

visit

public <X extends Exception> void visit(QueryModelVisitor<X> visitor)
                                 throws X

Description copied from interface: QueryModelNode

Visits this node. The node reports itself to the visitor with the proper runtime type.

Throws:

X

getSignature

public String getSignature()

Description copied from class: AbstractQueryModelNode

Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.

Specified by:

getSignature in interface QueryModelNode

Overrides:

getSignature in class AbstractQueryModelNode

Returns:

The node's signature, e.g. SLICE (offset=10, limit=10).

equals

public boolean equals(Object o)

Description copied from interface: QueryModelNode

Returns true if this query model node and its children are recursively equal to o and its children.

Specified by:

equals in interface QueryModelNode

Overrides:

equals in class AbstractNAryAggregateOperator

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNAryAggregateOperator

clone

public AggregateFunctionCall clone()

Description copied from interface: QueryModelNode

Returns a (deep) clone of this query model node. This method recursively clones the entire node tree, starting from this nodes.

Specified by:

clone in interface AggregateOperator

Specified by:

clone in interface QueryModelNode

Specified by:

clone in interface ValueExpr

Overrides:

clone in class AbstractNAryAggregateOperator

Returns:

A deep clone of this query model node.