com.sap.cloud.sdk.datamodel.odata.client.query

Class StructuredQuery

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.query.StructuredQuery

All Implemented Interfaces:

QuerySerializable

@Beta
public final class StructuredQuery
extends Object
implements QuerySerializable

StructuredQuery acts as a builder for OData 2.0 or 4.0 queries. It assists with assembling request parameters such as $select, $filter, .... This API does not differentiate between OData versions. Only leveraging features e.g. within filters that conform to the selected protocol version is the responsibility of the consumer.

Method Summary

Modifier and Type	Method and Description
static StructuredQuery	asNestedQueryOnProperty(String fieldName, ODataProtocol protocol) Create a nested query on a property.
StructuredQuery	filter(ValueBoolean... filters)
Collection<StructuredQuery>	getComplexSelectors()
String	getEncodedQueryString() Compute the encoded string representation of this query.
String	getEntityOrPropertyName() The structured property field name.
Collection<ValueBoolean>	getFilters()
OrderExpression	getOrderBy()
ODataProtocol	getProtocol()
String	getQueryString() Compute the string representation of this query
String	getSearch()
Collection<String>	getSimpleSelectors()
Number	getSkip()
Number	getTop()
boolean	isRoot()
static StructuredQuery	onEntity(String entityName, ODataProtocol protocol) Create a StructuredQuery for building up OData 2.0 or 4.0 queries.
StructuredQuery	orderBy(OrderExpression ordering)
StructuredQuery	orderBy(String field, Order order)
StructuredQuery	search(String search)
StructuredQuery	select(String... fields) Query modifier to limit which field values of the entity get fetched and populated.
StructuredQuery	select(StructuredQuery... subqueries) Query modifier to limit which complex and navigational properties will be expanded (and thus selected).
StructuredQuery	skip(Number skip)
StructuredQuery	top(Number top)

Methods inherited from class java.lang.Object

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

Method Detail

onEntity

@Nonnull
public static StructuredQuery onEntity(@Nonnull
                                                String entityName,
                                                @Nonnull
                                                ODataProtocol protocol)

Create a StructuredQuery for building up OData 2.0 or 4.0 queries.

Parameters:

entityName - The entity collection to be queried.

protocol - The ODataProtocol version this query should conform to.

Returns:

A new StructuredQuery object.

asNestedQueryOnProperty

@Nonnull
public static StructuredQuery asNestedQueryOnProperty(@Nonnull
                                                               String fieldName,
                                                               @Nonnull
                                                               ODataProtocol protocol)

Create a nested query on a property. This is an OData 4.0 specific feature.

Parameters:

fieldName - The property that is to be queried.

protocol - The ODataProtocol version this query should conform to.

Returns:

A new StructuredQuery object.

select

@Nonnull
public StructuredQuery select(@Nonnull
                                       String... fields)

Query modifier to limit which field values of the entity get fetched and populated.

Parameters:

fields - Properties to be selected.

Returns:

This query object with the added selections.

select

@Nonnull
public StructuredQuery select(@Nonnull
                                       StructuredQuery... subqueries)

Query modifier to limit which complex and navigational properties will be expanded (and thus selected). Such expansions are represented again through structured queries.

Parameters:

subqueries - Query objects on properties to be expanded. The getEntityOrPropertyName() will be th

Returns:

This query object with the added selections.

filter

@Nonnull
public final StructuredQuery filter(@Nonnull
                                             ValueBoolean... filters)

top

@Nonnull
public StructuredQuery top(@Nonnull
                                    Number top)

skip

@Nonnull
public StructuredQuery skip(@Nonnull
                                     Number skip)

orderBy

@Nonnull
public StructuredQuery orderBy(@Nonnull
                                        String field,
                                        @Nonnull
                                        Order order)

orderBy

@Nonnull
public StructuredQuery orderBy(@Nonnull
                                        OrderExpression ordering)

search

@Nonnull
public StructuredQuery search(@Nonnull
                                       String search)

getEncodedQueryString

@Nonnull
public String getEncodedQueryString()

Description copied from interface: QuerySerializable

Compute the encoded string representation of this query. The characters '%','/','$',' ','&','#','?','\','"' are encoded, Other special characters are not encoded

Specified by:

getEncodedQueryString in interface QuerySerializable

Returns:

A string representing the encoded request query.

getQueryString

@Nonnull
public String getQueryString()

Description copied from interface: QuerySerializable

Compute the string representation of this query

Specified by:

getQueryString in interface QuerySerializable

Returns:

A string representing the request query

getEntityOrPropertyName

@Nonnull
public String getEntityOrPropertyName()

The structured property field name.

isRoot

public boolean isRoot()

getProtocol

public ODataProtocol getProtocol()

getSimpleSelectors

@Nonnull
public Collection<String> getSimpleSelectors()

getComplexSelectors

@Nonnull
public Collection<StructuredQuery> getComplexSelectors()

getFilters

@Nonnull
public Collection<ValueBoolean> getFilters()

getOrderBy

@Nullable
public OrderExpression getOrderBy()

getTop

@Nullable
public Number getTop()

getSkip

@Nullable
public Number getSkip()

getSearch

@Nullable
public String getSearch()