com.sap.cloud.server.odata

Class QueryFilter

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.QueryFilter

public class QueryFilter
extends DataValue

Encapsulates the boolean value of an OData logical operator. Used to wrap the results of logical QueryOperator in a type-safe manner.

See Also:

DataQuery.queryFilter, DataQuery.filter.

Example using proxy classes:

 public void queryWithFilterExample() {
     NorthwindService service = this.getService();
     DataQuery query = new DataQuery()
         .select(Customer.customerID, Customer.companyName, Customer.contactName)
         .filter(Customer.country.equal("Germany")
             .and(Customer.contactName.greaterEqual("N")));
     Customer__List customers = service.getCustomers(query);
     this.showCustomers(customers);
 }
 

Example using dynamic API:

 public void queryWithFilterExample() {
     DataService service = this.getService();
     EntitySet customersEntitySet = service.getEntitySet("Customers");
     EntityType customerEntityType = customersEntitySet.getEntityType();
     Property customerIDProperty = customerEntityType.getProperty("CustomerID");
     Property companyNameProperty = customerEntityType.getProperty("CompanyName");
     Property contactNameProperty = customerEntityType.getProperty("ContactName");
     Property countryProperty = customerEntityType.getProperty("Country");
     DataQuery query = new DataQuery()
         .select(customerIDProperty, companyNameProperty, contactNameProperty)
         .from(customersEntitySet)
         .filter(countryProperty.equal("Germany")
             .and(contactNameProperty.greaterEqual("N")));
     EntityValueList customers = service.executeQuery(query).getEntityList();
     this.showCustomers(customers);
 }
 

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
QueryFilter()

Method Summary

Modifier and Type	Method and Description
QueryFilter	and(DataValue filter) Return an application of the OData 'and' logical operator to this and filter.
DataValue	find(Property property, int operatorCode) Return (nullable) A top-level comparison value for the specified property and operator.
static QueryFilter	from(DataValue value) Construct a query filter by wrapping a boolean value, so it can be used by DataQuery.queryFilter or DataQuery.where.
DataType	getDataType() Return data type with a DataType.code of DataType.QUERY_FILTER.
DataValue	getValue() Return the wrapped value which is expected to resolve to a boolean value during query execution.
QueryFilter	not() Return an application of the OData 'not' logical operator to this.
QueryFilter	or(DataValue filter) Return an application of the OData 'or' logical operator to this and filter.
void	setValue(DataValue value) Set the wrapped value which is expected to resolve to a boolean value during query execution.
java.lang.String	toString() Convert this data value to a string.

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFilter

public QueryFilter()

Method Detail

and

public QueryFilter and(DataValue filter)

Return an application of the OData 'and' logical operator to this and filter. This is a convenience wrapper for QueryOperator.and which allows method chaining.

Parameters:

filter - To be and'ed with this.

Returns:

An application of the OData 'and' logical operator to this and filter.

find

public DataValue find(Property property,
                      int operatorCode)

Return (nullable) A top-level comparison value for the specified property and operator. Otherwise null. If this filter contains a top-level (possibly and'ed) condition for the specified property and operator, then return the comparison value.

See Also:

QueryOperatorCode.

Parameters:

property - Property to match.

operatorCode - Operator to match.

Returns:

(nullable) A top-level comparison value for the specified property and operator. Otherwise `null`.

from

public static QueryFilter from(DataValue value)

Construct a query filter by wrapping a boolean value, so it can be used by DataQuery.queryFilter or DataQuery.where.

Parameters:

value - A boolean value.

Returns:

A new query filter.

getDataType

public DataType getDataType()

Return data type with a DataType.code of DataType.QUERY_FILTER.

Specified by:

getDataType in class DataValue

Returns:

Data type with a DataType.code of DataType.QUERY_FILTER.

getValue

public DataValue getValue()

Return the wrapped value which is expected to resolve to a boolean value during query execution.

Returns:

The wrapped value which is expected to resolve to a boolean value during query execution.

not

public QueryFilter not()

Return an application of the OData 'not' logical operator to this. This is a convenience wrapper for QueryOperator.not which allows method chaining.

Returns:

An application of the OData 'not' logical operator to this.

or

public QueryFilter or(DataValue filter)

Return an application of the OData 'or' logical operator to this and filter. This is a convenience wrapper for QueryOperator.or which allows method chaining.

Parameters:

filter - To be or'ed with this.

Returns:

An application of the OData 'or' logical operator to this and filter.

setValue

public void setValue(DataValue value)

Set the wrapped value which is expected to resolve to a boolean value during query execution.

Parameters:

value - The wrapped value which is expected to resolve to a boolean value during query execution.

toString

public java.lang.String toString()

Convert this data value to a string. If the QueryFilter.dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

Specified by:

toString in class DataValue

Returns:

Lexical representation of this data value.