org.apache.olingo.client.api.uri.v4

Interface URIBuilder

All Superinterfaces:

CommonURIBuilder<URIBuilder>

public interface URIBuilder
extends CommonURIBuilder<URIBuilder>

Method Summary

Methods

Modifier and Type	Method and Description
URIBuilder	appendAllSegment() Appends all segment to the URI.
URIBuilder	appendCrossjoinSegment(String... segmentValues) Appends cross join segment to the URI.
URIBuilder	appendEntityIdSegment(String segmentValue) Appends entity-id segment to the URI.
URIBuilder	appendKeySegment(EdmEnumType enumType, String memberName) Appends enum key segment to the URI.
URIBuilder	appendKeySegment(Map<String,org.apache.commons.lang3.tuple.Pair<EdmEnumType,String>> enumValues, Map<String,Object> segmentValues) Appends key segment to the URI, for multiple keys.
URIBuilder	appendRefSegment() Appends ref segment to the URI.
URIBuilder	appendSingletonSegment(String segmentValue) Appends Singleton segment to the URI.
URIBuilder	count(boolean value) Appends count query option.
URIBuilder	expandWithOptions(String expandItem, Map<QueryOption,Object> options) The set of expanded entities can be refined through the application of expand options, expressed as a semicolon-separated list of system query options, enclosed in parentheses, see [OData-URL].
URIBuilder	expandWithSelect(String expandItem, String... selectItems) Properties of related entities can be specified by including the $select query option within the $expand.
URIBuilder	id(String idValue) Adds id query option.
URIBuilder	search(String expression) Appends search query option.
URIBuilder	search(URISearch search) Appends search query option.

Methods inherited from interface org.apache.olingo.client.api.uri.CommonURIBuilder

addParameterAlias, addQueryOption, addQueryOption, appendBatchSegment, appendDerivedEntityTypeSegment, appendEntitySetSegment, appendKeySegment, appendKeySegment, appendMetadataSegment, appendNavigationSegment, appendOperationCallSegment, appendPropertySegment, appendValueSegment, build, count, expand, filter, filter, format, orderBy, replaceQueryOption, select, skip, skipToken, top

Method Detail

appendKeySegment

URIBuilder appendKeySegment(EdmEnumType enumType,
                          String memberName)

Appends enum key segment to the URI.

Parameters:

enumType - enum type

memberName - enum member name

Returns:

current URIBuilder instance

appendKeySegment

URIBuilder appendKeySegment(Map<String,org.apache.commons.lang3.tuple.Pair<EdmEnumType,String>> enumValues,
                          Map<String,Object> segmentValues)

Appends key segment to the URI, for multiple keys.

Parameters:

enumValues - enum segment values.

segmentValues - segment values.

Returns:

current URIBuilder instance

appendSingletonSegment

URIBuilder appendSingletonSegment(String segmentValue)

Appends Singleton segment to the URI.

Parameters:

segmentValue - segment value.

Returns:

current URIBuilder instance

appendEntityIdSegment

URIBuilder appendEntityIdSegment(String segmentValue)

Appends entity-id segment to the URI.

Parameters:

segmentValue - segment value

Returns:

current URIBuilder instance

appendRefSegment

URIBuilder appendRefSegment()

Appends ref segment to the URI.

Returns:

current URIBuilder instance

appendCrossjoinSegment

URIBuilder appendCrossjoinSegment(String... segmentValues)

Appends cross join segment to the URI.

Parameters:

segmentValues - segment values.

Returns:

current URIBuilder instance

appendAllSegment

URIBuilder appendAllSegment()

Appends all segment to the URI.

Returns:

current URIBuilder instance

id

URIBuilder id(String idValue)

Adds id query option.

Parameters:

idValue - opaque token.

Returns:

current URIBuilder instance

See Also:

QueryOption.ID

count

URIBuilder count(boolean value)

Appends count query option.

Parameters:

value - true or false

Returns:

current URIBuilder instance

See Also:

QueryOption.COUNT

search

URIBuilder search(URISearch search)

Appends search query option.

Parameters:

search - search expression

Returns:

current URIBuilder instance

See Also:

QueryOption.SEARCH

search

URIBuilder search(String expression)

Appends search query option.

Parameters:

expression - search expression

Returns:

current URIBuilder instance

See Also:

QueryOption.SEARCH

expandWithOptions

URIBuilder expandWithOptions(String expandItem,
                           Map<QueryOption,Object> options)

The set of expanded entities can be refined through the application of expand options, expressed as a semicolon-separated list of system query options, enclosed in parentheses, see [OData-URL].

Parameters:

expandItem - item to be expanded.

options - System query options. Allowed query options are: $filter, $select, $orderby, $skip, $top, $count, $search, $expand, and $levels.

Returns:

current URIBuilder instance.

See Also:

QueryOption.EXPAND

expandWithSelect

URIBuilder expandWithSelect(String expandItem,
                          String... selectItems)

Properties of related entities can be specified by including the $select query option within the $expand.
http://host/service/Products?$expand=Category($select=Name)

Parameters:

expandItem - related entity name.

selectItems - properties to be selected.

Returns:

current URIBuilder instance.

See Also:

QueryOption.EXPAND, QueryOption.SELECT