com.sap.cloud.sdk.odatav2.connectivity

Class ODataQueryBuilder

java.lang.Object

com.sap.cloud.sdk.odatav2.connectivity.ODataQueryBuilder

All Implemented Interfaces:

IQueryBuilder

public final class ODataQueryBuilder
extends Object
implements IQueryBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ODataQueryBuilder.ODataQueryResolver

Field Summary

Fields

Modifier and Type	Field and Description
static char	QUERY_PARAM_SEPARATOR

Method Summary

Modifier and Type	Method and Description
ODataQuery	build() Builds an OData query from this builder.
ODataQueryBuilder	enableMetadataCache() Enables caching of the metadata of an OData V2 data source.
ODataQueryBuilder	enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey) Enables caching of the metadata of an OData V2 data source.
ODataQueryBuilder	expand(String... expands) Selects navigation properties to expand.
ODataQueryBuilder	filter(FilterExpression filter) Adds a Filter expression to the OData query.
ODataQueryBuilder	inlineCount() Sets $inlinecount=allpages as a query parameter.
ODataQueryBuilder	keys(Map<String,Object> keys) Set Keys for the entity set being queried
ODataQueryBuilder	navigateTo(String navigation) Adds navigation Property to the URL.
ODataQueryBuilder	param(String key, Object value) Adds a query parameter to the OData request.
ODataQueryBuilder	select(List<String> selects) Selects properties to read.
ODataQueryBuilder	select(String... selects) Selects properties to read.
ODataQueryBuilder	skip(Integer n) Sets skip value.
ODataQueryBuilder	top(Integer n) Sets top value.
ODataQueryBuilder	useMetadata(boolean useMetadata)
ODataQueryBuilder	withCacheRefresh() Replaces the existing metadata in the cache with the latest version from the OData V2 data source.
static ODataQueryBuilder	withEntity(String servicePath, String entity) Creates an ODataQueryBuilder with the given service and entity name.
ODataQueryBuilder	withHeader(String key, String value) Adds a header to the query request.
ODataQueryBuilder	withHeader(String key, String value, boolean passInAllRequests) Adds a header to the query request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.
ODataQueryBuilder	withMetadata(URL metadataFilePath) Gets the metadata from the specified path.
ODataQueryBuilder	withoutMetadata() Used to tell the framework to not get the metadata before the actual query.

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_PARAM_SEPARATOR

public static final char QUERY_PARAM_SEPARATOR

See Also:

Constant Field Values

Method Detail

withEntity

public static ODataQueryBuilder withEntity(String servicePath,
                                           String entity)

Creates an ODataQueryBuilder with the given service and entity name.

Parameters:

serviceName - name of the odata service where the developer wants to execute a query operation.

entitySetName - name of the entity set, on which the developer wants to execute a query operation.

Returns:

ODataQueryBuilder

select

public ODataQueryBuilder select(String... selects)

Selects properties to read.

Specified by:

select in interface IQueryBuilder

Parameters:

selects - The list of properties to be read.

Returns:

ODataQueryBuilder

select

public ODataQueryBuilder select(List<String> selects)

Selects properties to read.

Specified by:

select in interface IQueryBuilder

Parameters:

selects - of type List- The list of properties to be read.

Returns:

ODataQueryBuilder

enableMetadataCache

public ODataQueryBuilder enableMetadataCache()

Enables caching of the metadata of an OData V2 data source. If your application is running on a tenant, then the tenant ID along with the metadata URL is used to form the cache key.

Specified by:

enableMetadataCache in interface IQueryBuilder

Returns:

ODataQueryBuilder

enableMetadataCache

public ODataQueryBuilder enableMetadataCache(com.sap.cloud.sdk.cloudplatform.cache.CacheKey cacheKey)

Enables caching of the metadata of an OData V2 data source.

Specified by:

enableMetadataCache in interface IQueryBuilder

Parameters:

key - Cache key containing the ID of the tenant where the application runs. You can also include the user name in the cache key.

Returns:

ODataQueryBuilder

withCacheRefresh

public ODataQueryBuilder withCacheRefresh()

Replaces the existing metadata in the cache with the latest version from the OData V2 data source.

Specified by:

withCacheRefresh in interface IQueryBuilder

Returns:

ODataQueryBuilder

withMetadata

public ODataQueryBuilder withMetadata(URL metadataFilePath)

Gets the metadata from the specified path.

Specified by:

withMetadata in interface IQueryBuilder

Parameters:

metadataFilePath - URL pointing to the metadata information

Returns:

ODataQueryBuilder A builder for forming the Create

withHeader

public ODataQueryBuilder withHeader(String key,
                                    String value)

Adds a header to the query request.

Specified by:

withHeader in interface IQueryBuilder

Parameters:

key - name of the header

value - value of the header

Returns:

ODataQueryBuilder

withHeader

public ODataQueryBuilder withHeader(String key,
                                    String value,
                                    boolean passInAllRequests)

Adds a header to the query request and optionally to the metadata request as well depending on the value of the passInAllRequests parameter.

Specified by:

withHeader in interface IQueryBuilder

Parameters:

key - name of the header

value - value of the header

passInAllRequests - boolean indicating whether the header is to be passed in all the requests to the backend like $metadata call etc. made as part of the Query Request call.

Returns:

ODataQueryBuilder

inlineCount

public ODataQueryBuilder inlineCount()

Sets $inlinecount=allpages as a query parameter.

Specified by:

inlineCount in interface IQueryBuilder

Returns:

ODataQueryBuilder

expand

public ODataQueryBuilder expand(String... expands)

Selects navigation properties to expand.

Specified by:

expand in interface IQueryBuilder

Parameters:

expands - List of navigation properties to expand

Returns:

ODataQueryBuilder

top

public ODataQueryBuilder top(Integer n)

Sets top value.

Specified by:

top in interface IQueryBuilder

Parameters:

n - the top value required

Returns:

ODataQueryBuilder

skip

public ODataQueryBuilder skip(Integer n)

Sets skip value.

Specified by:

skip in interface IQueryBuilder

Parameters:

n - the skip value required

Returns:

ODataQueryBuilder

filter

public final ODataQueryBuilder filter(FilterExpression filter)

Adds a Filter expression to the OData query.

Specified by:

filter in interface IQueryBuilder

Parameters:

filter - Object of FilterExpression that represents an OData filter expression.

Returns:

ODataQueryBuilder

param

public ODataQueryBuilder param(String key,
                               Object value)

Adds a query parameter to the OData request.

Specified by:

param in interface IQueryBuilder

Parameters:

key -

value -

Returns:

ODataQueryBuilder

withoutMetadata

public ODataQueryBuilder withoutMetadata()

Used to tell the framework to not get the metadata before the actual query. This is not honoured if keys are set or if filter is set because the framework uses metadata for these use cases.

Specified by:

withoutMetadata in interface IQueryBuilder

Returns:

keys

public ODataQueryBuilder keys(Map<String,Object> keys)

Set Keys for the entity set being queried

Specified by:

keys in interface IQueryBuilder

Parameters:

keys -

Returns:

useMetadata

public ODataQueryBuilder useMetadata(boolean useMetadata)

Specified by:

useMetadata in interface IQueryBuilder

build

public ODataQuery build()

Builds an OData query from this builder.

Specified by:

build in interface IQueryBuilder

Returns:

ODataQuery

navigateTo

public ODataQueryBuilder navigateTo(String navigation)

Description copied from interface: IQueryBuilder

Adds navigation Property to the URL.

Specified by:

navigateTo in interface IQueryBuilder

Returns:

IQueryBuilder