com.sap.cloud.sdk.datamodel.odatav4.core

Class StructuredPropertyCollectionQuery<ParentEntityT extends VdmEntity<?>,EntityT extends VdmObject<?>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.StructuredPropertyCollectionQuery<ParentEntityT,EntityT>

Type Parameters:

ParentEntityT - The generic navigation property entity source type.

EntityT - The generic navigation property entity target type.

public final class StructuredPropertyCollectionQuery<ParentEntityT extends VdmEntity<?>,EntityT extends VdmObject<?>>
extends Object

Implementation that represents read queries and holds their state at runtime. It allows for nested queries in a recursive manner. The implementation is the same for queries over single entities and collections of entities. In the VDM the available functionality is limited by the interfaces. In order to support a fluent creation of nested queries both the entity and the parent entity type are stored via generics. By implementing ProtocolQueryReadCollection the API doesn't differentiate between selections via referencing navigational properties and selections via sub-queries.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fieldName The structured property field name.
protected OrderExpression	orderBy

Method Summary

Modifier and Type	Method and Description
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	filter(FilterableBoolean<EntityT>... filters) Filter on properties of EntityT.
String	getFieldName() The structured property field name.
protected Iterable<FilterableBoolean<EntityT>>	getFilters() Get the filters modifier of the OData request.
protected OrderExpression	getOrderBy() Get the orderBy modifier of the OData request.
String	getQueryString() Compute the string representation of this query.
protected Number	getSkip() Get the skip modifier of the OData request.
protected Number	getTop() Get the top modifier of the OData request.
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	orderBy(FieldOrdering<EntityT>... ordering) Sort the set of returned entities by non-complex fields.
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	search(SearchExpression expression) Request modifier to return the set of entities corresponding to the specified boolean expression.
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	search(String search) Request modifier to return the set of entities that contain the specified value.
protected com.sap.cloud.sdk.datamodel.odatav4.core.AbstractStructuredPropertyQuery<ParentEntityT,EntityT>	select(Iterable<Property<EntityT>> fields) Query modifier to limit which field values of the entity EntityT get fetched and populated.
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	select(Property<EntityT>... fields)
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	skip(int skip) Determine the how many first N entities of the result set should be skipped.
StructuredPropertyCollectionQuery<ParentEntityT,EntityT>	top(int top) Limit the number of results of this request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.Expressions.FieldReference

asBoolean, asCollection, asDate, asDateTimeOffset, asDuration, asNumber, asString, asTimeOfDay, getExpression, of

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.FilterableComparisonAbsolute

equalTo, equalTo, notEqualTo, notEqualTo

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.FilterableComparisonRelative

greaterThan, greaterThan, greaterThanEqual, greaterThanEqual, lessThan, lessThan, lessThanEqual, lessThanEqual

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.Expressions.Operand

getExpression

Field Detail

fieldName

@Nonnull
protected final String fieldName

The structured property field name.

orderBy

protected OrderExpression orderBy

Method Detail

select

@SafeVarargs
 @Nonnull
public final StructuredPropertyCollectionQuery<ParentEntityT,EntityT> select(@Nonnull
                                                                                                    Property<EntityT>... fields)

getSkip

@Nullable
protected Number getSkip()

Get the skip modifier of the OData request.

Returns:

The skip number.

getTop

@Nullable
protected Number getTop()

Get the top modifier of the OData request.

Returns:

The skip number.

getFilters

@Nonnull
protected Iterable<FilterableBoolean<EntityT>> getFilters()

Get the filters modifier of the OData request.

Returns:

The filter list.

getOrderBy

@Nonnull
protected OrderExpression getOrderBy()

Get the orderBy modifier of the OData request.

Returns:

The map of field names and Orders.

filter

@SafeVarargs
 @Nonnull
public final StructuredPropertyCollectionQuery<ParentEntityT,EntityT> filter(@Nonnull
                                                                                                    FilterableBoolean<EntityT>... filters)

Filter on properties of EntityT.

Parameters:

filters - Filter expressions to be added to the request.

Returns:

This request object with the added filters.

top

@Nonnull
public StructuredPropertyCollectionQuery<ParentEntityT,EntityT> top(int top)

Limit the number of results of this request.

Parameters:

top - The maximum amount of elements this request shall return.

Returns:

This request with the top parameter set.

skip

@Nonnull
public StructuredPropertyCollectionQuery<ParentEntityT,EntityT> skip(int skip)

Determine the how many first N entities of the result set should be skipped. If this method is never called, then the full list will be returned from the first entity. If this method is called multiple times, then only the value of the last call will be used.

Parameters:

skip - The amount of elements this request will skip.

Returns:

This request with the skip parameter set.

orderBy

@SafeVarargs
 @Nonnull
 @Beta
public final StructuredPropertyCollectionQuery<ParentEntityT,EntityT> orderBy(@Nonnull
                                                                                                            FieldOrdering<EntityT>... ordering)

Sort the set of returned entities by non-complex fields.

Parameters:

ordering - Fields to sort by.

Returns:

This request with the orderBy parameter set.

search

@Nonnull
public StructuredPropertyCollectionQuery<ParentEntityT,EntityT> search(@Nonnull
                                                                                String search)

Request modifier to return the set of entities that contain the specified value. If this method is never called, then all the accessible entities will be returned.

Parameters:

search - A string value as the search criteria.

Returns:

The same fluent helper with this request modifier applied.

search

@Nonnull
public StructuredPropertyCollectionQuery<ParentEntityT,EntityT> search(@Nonnull
                                                                                SearchExpression expression)

Request modifier to return the set of entities corresponding to the specified boolean expression. If this method is never called, then all the accessible entities will be returned.

Parameters:

expression - SearchExpression as the search criteria

Returns:

The same fluent helper with this request modifier applied.

getQueryString

@Nonnull
public String getQueryString()

Compute the string representation of this query.

Returns:

A string representing the request query.

select

@Nonnull
protected final com.sap.cloud.sdk.datamodel.odatav4.core.AbstractStructuredPropertyQuery<ParentEntityT,EntityT> select(@Nonnull
                                                                                                                                Iterable<Property<EntityT>> fields)

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

Parameters:

fields - Properties of EntityT to be selected.

Returns:

This query object with the added selections.

getFieldName

@Nonnull
public String getFieldName()

The structured property field name.

Returns:

The field name this reference points towards.