iot.jcypher.query.api.returns

Class Aggregate

java.lang.Object

iot.jcypher.query.api.APIObject

iot.jcypher.query.api.returns.Aggregate

Direct Known Subclasses:

AggregateDistinct

public class Aggregate
extends APIObject

Field Summary

Fields inherited from class iot.jcypher.query.api.APIObject

astNode

Method Summary

Methods

Modifier and Type	Method and Description
RElement<RElement<?>>	avg(JcProperty property) JCYPHER calculate the average of numeric values e.g. ...aggregate().
RElement<RElement<?>>	max(JcProperty property) JCYPHER find the largest value in a collection of numeric values e.g. ...aggregate().
RElement<RElement<?>>	min(JcProperty property) JCYPHER find the smallest value in a collection of numeric values e.g. ...aggregate().
Percentile	percentileCont(Number percentile) JCYPHER calculate: Given a series of values, which value is located at a certain percentile (percent rank); uses a linear interpolation method, calculating a weighted average between two values, if the desired percentile lies between them.
Percentile	percentileDisc(Number percentile) JCYPHER calculate: Given a series of values, which value is located at (or nearest to) a certain percentile (percent rank); takes the percentile (between 0.0 and 1.0) e.g. ...aggregate().
RElement<RElement<?>>	stdev(JcProperty property) JCYPHER calculate the standard deviation for a given value over a group; uses a standard two-pass method, with N - 1 as the denominator, and should be used when taking a sample of the population for an unbiased estimate.
RElement<RElement<?>>	stdevp(JcProperty property) JCYPHER calculate the standard deviation for a given value over a group; uses a standard two-pass method, with N - 1 as the denominator, and should be used when taking a sample of an entire population.
RElement<RElement<?>>	sum(JcProperty property) JCYPHER sum all the numeric values which are encountered.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sum

public RElement<RElement<?>> sum(JcProperty property)

JCYPHER

sum all the numeric values which are encountered. NULLs are silently dropped

e.g. ...aggregate().sum(n.property("amount"))

avg

public RElement<RElement<?>> avg(JcProperty property)

JCYPHER

calculate the average of numeric values

e.g. ...aggregate().avg(n.property("amount"))

stdev

public RElement<RElement<?>> stdev(JcProperty property)

JCYPHER

calculate the standard deviation for a given value over a group;
uses a standard two-pass method, with N - 1 as the denominator, and should be used when taking a sample of the population for an unbiased estimate.

e.g. ...aggregate().stdev(n.property("age"))

stdevp

public RElement<RElement<?>> stdevp(JcProperty property)

JCYPHER

calculate the standard deviation for a given value over a group;
uses a standard two-pass method, with N - 1 as the denominator, and should be used when taking a sample of an entire population.

e.g. ...aggregate().stdevp(n.property("age"))

max

public RElement<RElement<?>> max(JcProperty property)

JCYPHER

find the largest value in a collection of numeric values

e.g. ...aggregate().max(n.property("amount"))

min

public RElement<RElement<?>> min(JcProperty property)

JCYPHER

find the smallest value in a collection of numeric values

e.g. ...aggregate().min(n.property("amount"))

percentileDisc

public Percentile percentileDisc(Number percentile)

JCYPHER

calculate: Given a series of values, which value is located at (or nearest to) a certain percentile (percent rank);

takes the percentile (between 0.0 and 1.0)

e.g. ...aggregate().percentileDisc(0.5)...

percentileCont

public Percentile percentileCont(Number percentile)

JCYPHER

calculate: Given a series of values, which value is located at a certain percentile (percent rank);

uses a linear interpolation method, calculating a weighted average between two values,
if the desired percentile lies between them.;

takes the percentile (between 0.0 and 1.0)

e.g. ...aggregate().percentileCont(0.5)...