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

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

java.lang.Object

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

Type Parameters:

ParentEntityT - The generic navigation property entity source type.

EntityT - The generic navigation property entity target type.

public final class NavigationPropertyCollectionQuery<ParentEntityT extends VdmObject<?>,EntityT extends VdmEntity<?>>
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 StructuredQuery	delegateQuery

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

NULL

Method Summary

Modifier and Type	Method and Description
NavigationPropertyCollectionQuery<ParentEntityT,EntityT>	filter(FilterableBoolean<EntityT>... filters) Filter on properties of EntityT.
protected StructuredQuery	getDelegateQuery()
String	getFieldName() javadoc
NavigationPropertyCollectionQuery<ParentEntityT,EntityT>	orderBy(FieldOrdering<EntityT>... ordering) Sort the set of returned entities by non-complex fields.
NavigationPropertyCollectionQuery<ParentEntityT,EntityT>	search(SearchExpression expression) Request modifier to return the set of entities corresponding to the specified boolean expression.
NavigationPropertyCollectionQuery<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.
NavigationPropertyCollectionQuery<ParentEntityT,EntityT>	select(Property<EntityT>... fields)
NavigationPropertyCollectionQuery<ParentEntityT,EntityT>	skip(int skip) Determine the how many first N entities of the result set should be skipped.
NavigationPropertyCollectionQuery<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.FieldReference

getExpression, of

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

getExpression

Field Detail

delegateQuery

protected final StructuredQuery delegateQuery

Method Detail

select

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

filter

@SafeVarargs
 @Nonnull
public final NavigationPropertyCollectionQuery<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 NavigationPropertyCollectionQuery<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 NavigationPropertyCollectionQuery<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 NavigationPropertyCollectionQuery<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 NavigationPropertyCollectionQuery<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 request builder with this request modifier applied.

search

@Nonnull
public NavigationPropertyCollectionQuery<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 request builder with this request modifier applied.

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()

Description copied from interface: FieldReference

javadoc

Returns:

The field name this reference points towards.

getDelegateQuery

protected StructuredQuery getDelegateQuery()