QueryFunction (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.QueryFunction

public class QueryFunction
extends java.lang.Object

Represents a OData query function. Query functions are typically used within DataQuery.filter. QueryFunctionCall can be constructed using static calls on QueryFunction or, more conveniently, by chained calls on QueryValue.

Example using proxy classes (with QueryFunction static calls):

 public void queryFunctionExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .filter(QueryFunction.contains(QueryFunction.toLower(Customer.address),
             StringValue.of("king")));
     Customer__List customers = service.getCustomers(query);
     this.showCustomers(customers);
 }

Example using proxy classes (with QueryValue chained calls):

 public void queryValueFunctionExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .filter(Customer.address.toLower().contains("king"));
     Customer__List customers = service.getCustomers(query);
     this.showCustomers(customers);
 }

Field Summary

Fields
Modifier and Type Field and Description

static QueryFunctionMap functionMap

Fields
Modifier and Type	Field and Description
`static QueryFunctionMap`	`functionMap`

Constructor Summary

Constructors
Constructor and Description

QueryFunction()

Constructors
Constructor and Description
`QueryFunction()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static QueryValue`	`asType(DataType type)` See asType(DataType, DataValue).
`static QueryValue`	`asType(DataType type, DataValue value)` Return a deferred call of the OData 'cast' canonical function.
`static QueryValue`	`ceiling(DataValue value)` Return a deferred call of the OData 'ceiling' canonical function.
`static QueryValue`	`concat(DataValue left, DataValue right)` Return a deferred call of the OData 'concat' canonical function.
`static QueryFilter`	`contains(DataValue value, DataValue searchValue)` Return a deferred call of the OData 'contains' canonical function.
`static QueryValue`	`custom(java.lang.String name, DataValueList arguments)` Return a deferred call of a custom function.
`static QueryValue`	`date(DataValue value)` Return a deferred call of the OData 'date' canonical function.
`static QueryValue`	`day(DataValue value)` Return a deferred call of the OData 'day' canonical function.
`static QueryFilter`	`endsWith(DataValue value, DataValue suffix)` Return a deferred call of the OData 'endswith' canonical function.
`static QueryValue`	`floor(DataValue value)` Return a deferred call of the OData 'floor' canonical function.
`static QueryFunction`	`forCode(int code)` Lookup a query function by code.
`static QueryFunction`	`forName(java.lang.String name)` Lookup a query function by name.
`static QueryValue`	`fractionalSeconds(DataValue value)` Return a deferred call of the OData 'fractionalseconds' canonical function.
`static QueryValue`	`geoDistance(DataValue from, DataValue to)` Return a deferred call of the OData 'geo.distance' canonical function.
`static QueryFilter`	`geoIntersects(DataValue point, DataValue polygon)` Return a deferred call of the OData 'geo.intersects' canonical function.
`static QueryValue`	`geoLength(DataValue value)` Return a deferred call of the OData 'geo.length' canonical function.
`int`	`getCode()` Return function code.
`int`	`getMaxArity()` Return maximum arity (number of arguments).
`int`	`getMinArity()` Return minimum arity (number of arguments).
`java.lang.String`	`getName()` Return function name.
`static QueryValue`	`hour(DataValue value)` Return a deferred call of the OData 'hour' canonical function.
`static QueryValue`	`indexOf(DataValue value, DataValue searchValue)` Return a deferred call of the OData 'indexof' canonical function.
`static QueryFilter`	`isType(DataType type)` See isType(DataType, DataValue).
`static QueryFilter`	`isType(DataType type, DataValue value)` Return a deferred call of the OData 'isof' canonical function.
`static QueryValue`	`maxDateTime()` Return a deferred call of the OData 'maxdatetime' canonical function.
`static QueryValue`	`minDateTime()` Return a deferred call of the OData 'mindatetime' canonical function.
`static QueryValue`	`minute(DataValue value)` Return a deferred call of the OData 'minute' canonical function.
`static QueryValue`	`month(DataValue value)` Return a deferred call of the OData 'month' canonical function.
`static QueryValue`	`now()` Return a deferred call of the OData 'now' canonical function.
`static QueryValue`	`round(DataValue value)` Return a deferred call of the OData 'round' canonical function.
`static QueryValue`	`second(DataValue value)` Return a deferred call of the OData 'second' canonical function.
`void`	`setCode(int value)` Set function code.
`void`	`setMaxArity(int value)` Set maximum arity (number of arguments).
`void`	`setMinArity(int value)` Set minimum arity (number of arguments).
`void`	`setName(java.lang.String value)` Set function name.
`static QueryFilter`	`startsWith(DataValue value, DataValue prefix)` Return a deferred call of the OData 'startswith' canonical function.
`static QueryValue`	`stringLength(DataValue value)` Return a deferred call of the OData 'length' canonical function.
`static QueryValue`	`substring(DataValue value, DataValue start)` See substring(DataValue, DataValue, DataValue).
`static QueryValue`	`substring(DataValue value, DataValue start, DataValue length)` Return a deferred call of the OData 'substring' canonical function.
`static QueryValue`	`time(DataValue value)` Return a deferred call of the OData 'time' canonical function.
`static QueryValue`	`toLower(DataValue value)` Return a deferred call of the OData 'tolower' canonical function.
`java.lang.String`	`toString()`
`static QueryValue`	`totalOffsetMinutes(DataValue value)` Return a deferred call of the OData 'totaloffsetminutes' canonical function.
`static QueryValue`	`toUpper(DataValue value)` Return a deferred call of the OData 'toUpper' canonical function.
`static QueryValue`	`trim(DataValue value)` Return a deferred call of the OData 'trim' canonical function.
`static QueryValue`	`year(DataValue value)` Return a deferred call of the OData 'year' canonical function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - functionMap
```
public static final QueryFunctionMap functionMap
```
- Constructor Detail
  - QueryFunction
```
public QueryFunction()
```
- Method Detail
  - asType
```
public static QueryValue asType(DataType type)
```
    See asType(DataType, DataValue).
    
    Parameters:
    
    type - Type parameter.
    
    Returns:
    
    (see linked method).
  - asType
```
public static QueryValue asType(DataType type,
                                DataValue value)
```
    Return a deferred call of the OData 'cast' canonical function.
    
    Parameters:
    
    type - A data type.
    
    value - (nullable) A data value, or null to refer to the "current instance".
    
    Returns:
    
    a deferred call of the OData 'cast' canonical function.
  - ceiling
```
public static QueryValue ceiling(DataValue value)
```
    Return a deferred call of the OData 'ceiling' canonical function.
    
    Parameters:
    
    value - A number value.
    
    Returns:
    
    a deferred call of the OData 'ceiling' canonical function.
  - concat
```
public static QueryValue concat(DataValue left,
                                DataValue right)
```
    Return a deferred call of the OData 'concat' canonical function.
    
    Parameters:
    
    left - Left string value.
    
    right - Right string value.
    
    Returns:
    
    a deferred call of the OData 'concat' canonical function.
  - contains
```
public static QueryFilter contains(DataValue value,
                                   DataValue searchValue)
```
    Return a deferred call of the OData 'contains' canonical function.
    
    Parameters:
    
    value - A string value.
    
    searchValue - To search for in value.
    
    Returns:
    
    a deferred call of the OData 'contains' canonical function.
  - custom
```
public static QueryValue custom(java.lang.String name,
                                DataValueList arguments)
```
    Return a deferred call of a custom function.
    
    Parameters:
    
    name - Custom function name.
    
    arguments - Custom function arguments.
    
    Returns:
    
    a deferred call of a custom function.
  - date
```
public static QueryValue date(DataValue value)
```
    Return a deferred call of the OData 'date' canonical function.
    
    Parameters:
    
    value - A value with date components.
    
    Returns:
    
    a deferred call of the OData 'date' canonical function.
  - day
```
public static QueryValue day(DataValue value)
```
    Return a deferred call of the OData 'day' canonical function.
    
    Parameters:
    
    value - A value with date components.
    
    Returns:
    
    a deferred call of the OData 'day' canonical function.
  - endsWith
```
public static QueryFilter endsWith(DataValue value,
                                   DataValue suffix)
```
    Return a deferred call of the OData 'endswith' canonical function.
    
    Parameters:
    
    value - A string value.
    
    suffix - Suffix to check for in value.
    
    Returns:
    
    a deferred call of the OData 'endswith' canonical function.
  - floor
```
public static QueryValue floor(DataValue value)
```
    Return a deferred call of the OData 'floor' canonical function.
    
    Parameters:
    
    value - A number value.
    
    Returns:
    
    a deferred call of the OData 'floor' canonical function.
  - forCode
```
public static QueryFunction forCode(int code)
```
    Lookup a query function by code.
    
    See Also:
    
    constants.
    
    Parameters:
    
    code - Function code.
    
    Returns:
    
    Query function.
  - forName
```
public static QueryFunction forName(java.lang.String name)
```
    Lookup a query function by name.
    
    Throws:
    
    DataQueryException if name is not the name of a known query function.
    
    Parameters:
    
    name - Function name.
    
    Returns:
    
    Query function.
  - fractionalSeconds
```
public static QueryValue fractionalSeconds(DataValue value)
```
    Return a deferred call of the OData 'fractionalseconds' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'fractionalseconds' canonical function.
  - geoDistance
```
public static QueryValue geoDistance(DataValue from,
                                     DataValue to)
```
    Return a deferred call of the OData 'geo.distance' canonical function.
    
    Parameters:
    
    from - A starting point.
    
    to - An ending point.
    
    Returns:
    
    a deferred call of the OData 'geo.distance' canonical function.
  - geoIntersects
```
public static QueryFilter geoIntersects(DataValue point,
                                        DataValue polygon)
```
    Return a deferred call of the OData 'geo.intersects' canonical function.
    
    Parameters:
    
    point - A point.
    
    polygon - A polygon.
    
    Returns:
    
    a deferred call of the OData 'geo.intersects' canonical function.
  - geoLength
```
public static QueryValue geoLength(DataValue value)
```
    Return a deferred call of the OData 'geo.length' canonical function.
    
    Parameters:
    
    value - A line string or polygon.
    
    Returns:
    
    a deferred call of the OData 'geo.length' canonical function.
  - getCode
```
public int getCode()
```
    Return function code.
    
    See Also:
    
    QueryOperatorCode.
    
    Returns:
    
    Function code.
  - getMaxArity
```
public int getMaxArity()
```
    Return maximum arity (number of arguments).
    
    Returns:
    
    Maximum arity (number of arguments).
  - getMinArity
```
public int getMinArity()
```
    Return minimum arity (number of arguments).
    
    Returns:
    
    Minimum arity (number of arguments).
  - getName
```
public java.lang.String getName()
```
    Return function name.
    
    Returns:
    
    Function name.
  - hour
```
public static QueryValue hour(DataValue value)
```
    Return a deferred call of the OData 'hour' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'hour' canonical function.
  - indexOf
```
public static QueryValue indexOf(DataValue value,
                                 DataValue searchValue)
```
    Return a deferred call of the OData 'indexof' canonical function.
    
    Parameters:
    
    value - A string value.
    
    searchValue - To search for in value.
    
    Returns:
    
    a deferred call of the OData 'indexof' canonical function.
  - isType
```
public static QueryFilter isType(DataType type)
```
    See isType(DataType, DataValue).
    
    Parameters:
    
    type - Type parameter.
    
    Returns:
    
    (see linked method).
  - isType
```
public static QueryFilter isType(DataType type,
                                 DataValue value)
```
    Return a deferred call of the OData 'isof' canonical function.
    
    Parameters:
    
    type - A data type.
    
    value - (nullable) A data value, or null to refer to the "current instance".
    
    Returns:
    
    a deferred call of the OData 'isof' canonical function.
  - maxDateTime
```
public static QueryValue maxDateTime()
```
    Return a deferred call of the OData 'maxdatetime' canonical function.
    
    Returns:
    
    a deferred call of the OData 'maxdatetime' canonical function.
  - minDateTime
```
public static QueryValue minDateTime()
```
    Return a deferred call of the OData 'mindatetime' canonical function.
    
    Returns:
    
    a deferred call of the OData 'mindatetime' canonical function.
  - minute
```
public static QueryValue minute(DataValue value)
```
    Return a deferred call of the OData 'minute' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'minute' canonical function.
  - month
```
public static QueryValue month(DataValue value)
```
    Return a deferred call of the OData 'month' canonical function.
    
    Parameters:
    
    value - A value with date components.
    
    Returns:
    
    a deferred call of the OData 'month' canonical function.
  - now
```
public static QueryValue now()
```
    Return a deferred call of the OData 'now' canonical function.
    
    Returns:
    
    a deferred call of the OData 'now' canonical function.
  - round
```
public static QueryValue round(DataValue value)
```
    Return a deferred call of the OData 'round' canonical function.
    
    Parameters:
    
    value - A number value.
    
    Returns:
    
    a deferred call of the OData 'round' canonical function.
  - second
```
public static QueryValue second(DataValue value)
```
    Return a deferred call of the OData 'second' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'second' canonical function.
  - setCode
```
public void setCode(int value)
```
    Set function code.
    
    See Also:
    
    QueryOperatorCode.
    
    Parameters:
    
    value - Function code.
  - setMaxArity
```
public void setMaxArity(int value)
```
    Set maximum arity (number of arguments).
    
    Parameters:
    
    value - Maximum arity (number of arguments).
  - setMinArity
```
public void setMinArity(int value)
```
    Set minimum arity (number of arguments).
    
    Parameters:
    
    value - Minimum arity (number of arguments).
  - setName
```
public void setName(java.lang.String value)
```
    Set function name.
    
    Parameters:
    
    value - Function name.
  - startsWith
```
public static QueryFilter startsWith(DataValue value,
                                     DataValue prefix)
```
    Return a deferred call of the OData 'startswith' canonical function.
    
    Parameters:
    
    value - A string value.
    
    prefix - Prefix to check for in value.
    
    Returns:
    
    a deferred call of the OData 'startswith' canonical function.
  - stringLength
```
public static QueryValue stringLength(DataValue value)
```
    Return a deferred call of the OData 'length' canonical function.
    
    Parameters:
    
    value - A string value.
    
    Returns:
    
    a deferred call of the OData 'length' canonical function.
  - substring
```
public static QueryValue substring(DataValue value,
                                   DataValue start)
```
    See substring(DataValue, DataValue, DataValue).
    
    Parameters:
    
    value - Value parameter.
    
    start - Start parameter.
    
    Returns:
    
    (see linked method).
  - substring
```
public static QueryValue substring(DataValue value,
                                   DataValue start,
                                   DataValue length)
```
    Return a deferred call of the OData 'substring' canonical function.
    
    Parameters:
    
    value - A string value.
    
    start - A starting index.
    
    length - (nullable) A substring length.
    
    Returns:
    
    a deferred call of the OData 'substring' canonical function.
  - time
```
public static QueryValue time(DataValue value)
```
    Return a deferred call of the OData 'time' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'time' canonical function.
  - toLower
```
public static QueryValue toLower(DataValue value)
```
    Return a deferred call of the OData 'tolower' canonical function.
    
    Parameters:
    
    value - A string value.
    
    Returns:
    
    a deferred call of the OData 'tolower' canonical function.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toUpper
```
public static QueryValue toUpper(DataValue value)
```
    Return a deferred call of the OData 'toUpper' canonical function.
    
    Parameters:
    
    value - A string value.
    
    Returns:
    
    a deferred call of the OData 'toUpper' canonical function.
  - totalOffsetMinutes
```
public static QueryValue totalOffsetMinutes(DataValue value)
```
    Return a deferred call of the OData 'totaloffsetminutes' canonical function.
    
    Parameters:
    
    value - A value with time components.
    
    Returns:
    
    a deferred call of the OData 'totaloffsetminutes' canonical function.
  - trim
```
public static QueryValue trim(DataValue value)
```
    Return a deferred call of the OData 'trim' canonical function.
    
    Parameters:
    
    value - A string value.
    
    Returns:
    
    a deferred call of the OData 'trim' canonical function.
  - year
```
public static QueryValue year(DataValue value)
```
    Return a deferred call of the OData 'year' canonical function.
    
    Parameters:
    
    value - A value with date components.
    
    Returns:
    
    a deferred call of the OData 'year' canonical function.

Class QueryFunction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

functionMap

Constructor Detail

QueryFunction

Method Detail

asType

asType

ceiling

concat

contains

custom

date

day

endsWith

floor

forCode

forName

fractionalSeconds

geoDistance

geoIntersects

geoLength

getCode

getMaxArity

getMinArity

getName

hour

indexOf

isType

isType

maxDateTime

minDateTime

minute

month

now

round

second

setCode

setMaxArity

setMinArity

setName

startsWith

stringLength

substring

substring

time

toLower

toString

toUpper

totalOffsetMinutes

trim

year