com.sap.cloud.server.odata

Class AggregateExpression

java.lang.Object

com.sap.cloud.server.odata.AggregateExpression

public class AggregateExpression
extends java.lang.Object

Encapsulates an OData aggregate expression item.

Constructor Summary

Constructors

Constructor and Description
AggregateExpression()

Method Summary

Modifier and Type	Method and Description
static AggregateExpression	count(java.lang.String alias) Creates a $count aggregate expression item.
static AggregateExpression	create(DataValue value, AggregateMethod method, java.lang.String alias) Creates an aggregate expression item.
static AggregateExpression	createWithNavigationPath(DataValue value, AggregateMethod method, java.lang.String alias, PropertyPath navigationPath) Creates an aggregate expression item.
AggregateExpression	from(PropertyPath propertyPath, AggregateMethod method) Adds a 'from' clause to the aggregate expression.
AggregateFromList	getAggregateFromList() Return the items in the "from" clause of the aggregate item.
java.lang.String	getAlias() Return (nullable) The alias of the aggregate transformation item.
AggregateMethod	getMethod() Return (nullable) The method of the aggregate transformation item.
PropertyPath	getNavigationPath() Return (nullable) The navigation path to be applied for the aggregate expression.
DataValue	getValue() Return (nullable) The value of the aggregate transformation item.
boolean	isCount() Return true if the aggregate transformation item represents a $count item.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateExpression

public AggregateExpression()

Method Detail

count

public static AggregateExpression count(java.lang.String alias)

Creates a $count aggregate expression item.

Parameters:

alias - The alias for the aggregate item.

Returns:

The aggregate transformation value.

create

public static AggregateExpression create(DataValue value,
                                         AggregateMethod method,
                                         java.lang.String alias)

Creates an aggregate expression item.

Parameters:

value - (nullable) The value to be aggregated.

method - (nullable) The aggregate method to be used for aggregating.

alias - (nullable) The alias for the returned result property.

Returns:

The aggregate transformation value.

createWithNavigationPath

public static AggregateExpression createWithNavigationPath(DataValue value,
                                                           AggregateMethod method,
                                                           java.lang.String alias,
                                                           PropertyPath navigationPath)

Creates an aggregate expression item.

Parameters:

value - (nullable) The value to be aggregated.

method - (nullable) The aggregate method to be used for aggregating.

alias - (nullable) The alias for the returned result property.

navigationPath - (nullable) The path of the related entities to apply the aggregate transformation on.

Returns:

The aggregate transformation value.

from

public AggregateExpression from(PropertyPath propertyPath,
                                AggregateMethod method)

Adds a 'from' clause to the aggregate expression.

Parameters:

propertyPath - The property path for the 'from' clause.

method - (nullable) The aggregate method for the 'from' clause.

Returns:

The aggregate expression value.

getAggregateFromList

public AggregateFromList getAggregateFromList()

Return the items in the "from" clause of the aggregate item.

Returns:

The items in the "from" clause of the aggregate item.

getAlias

public java.lang.String getAlias()

Return (nullable) The alias of the aggregate transformation item.

Returns:

(nullable) The alias of the aggregate transformation item.

getMethod

public AggregateMethod getMethod()

Return (nullable) The method of the aggregate transformation item.

Returns:

(nullable) The method of the aggregate transformation item.

getNavigationPath

public PropertyPath getNavigationPath()

Return (nullable) The navigation path to be applied for the aggregate expression. All the paths will be evaluated relative to this path.

Returns:

(nullable) The navigation path to be applied for the aggregate expression. All the paths will be evaluated relative to this path.

getValue

public DataValue getValue()

Return (nullable) The value of the aggregate transformation item.

Returns:

(nullable) The value of the aggregate transformation item.

isCount

public boolean isCount()

Return true if the aggregate transformation item represents a $count item.

Returns:

True if the aggregate transformation item represents a $count item.