public class URIBuilderImpl extends Object implements URIBuilder
Modifier and Type | Field and Description |
---|---|
protected Map<String,String> |
customQueryOptions
Insertion-order map of custom query options.
|
protected Map<String,Object> |
functionImportParameters
Insertion-order map of function import parameters.
|
protected Map<String,String> |
queryOptions
Insertion-order map of query options.
|
protected List<Segment> |
segments |
Constructor and Description |
---|
URIBuilderImpl(String serviceRoot)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
URIBuilder |
addCustomQueryOption(String paramName,
Object paramValue)
Adds custom query option
|
URIBuilder |
addQueryOption(QueryOption option,
String value)
Adds the specified query option to the URI.
|
URIBuilder |
appendCountSegment()
Appends count segment to the URI.
|
URIBuilder |
appendEntitySetSegment(String entitySet)
Appends EntitySet segment to the URI.
|
URIBuilder |
appendFunctionImportParameters(Map<String,Object> functionImportParams)
Appends function import parameters to the uri
|
URIBuilder |
appendFunctionImportSegment(String functionImport)
Appends function import to the uri
|
URIBuilder |
appendKeySegment(Map<String,Object> segmentValues)
Appends key segment to the URI, for multiple keys.
|
URIBuilder |
appendKeySegment(Object value)
Appends key segment to the URI.
|
URIBuilder |
appendMetadataSegment()
Appends metadata segment to the URI.
|
URIBuilder |
appendNavigationSegment(String navigationProperty)
Appends navigation segment to the URI.
|
URIBuilder |
appendPropertySegment(String segmentValue)
Appends property segment to the URI.
|
URIBuilder |
appendValueSegment()
Appends value segment to the URI.
|
URI |
build()
Build OData URI.
|
URIBuilder |
expand(String... expandItems)
Adds expand query option.
|
URIBuilder |
filter(String filter)
Adds filter query option.
|
URIBuilder |
format(String format)
Adds format query option.
|
URIBuilder |
orderBy(String order)
Adds orderby query option.
|
URIBuilder |
replaceQueryOption(QueryOption option,
String value) |
URIBuilder |
select(String... selectItems)
Adds select query option.
|
URIBuilder |
skip(int skip)
Adds skip query option.
|
URIBuilder |
top(int top)
Adds top query option.
|
protected final Map<String,String> customQueryOptions
public URIBuilderImpl(String serviceRoot)
serviceRoot
- absolute URL (schema, host and port included) representing the location of the root of the data
service.public URIBuilder appendCountSegment()
URIBuilder
appendCountSegment
in interface URIBuilder
public URIBuilder appendMetadataSegment()
URIBuilder
appendMetadataSegment
in interface URIBuilder
public URIBuilder format(String format)
URIBuilder
format
in interface URIBuilder
format
- media type acceptable in a response.QueryOption.FORMAT
public URIBuilder appendValueSegment()
URIBuilder
appendValueSegment
in interface URIBuilder
public URIBuilder addQueryOption(QueryOption option, String value)
URIBuilder
addQueryOption
in interface URIBuilder
option
- query option.value
- query option value.public URIBuilder filter(String filter)
URIBuilder
filter
in interface URIBuilder
filter
- filter string.QueryOption.FILTER
public URIBuilder top(int top)
URIBuilder
top
in interface URIBuilder
top
- maximum number of entities to be returned.QueryOption.TOP
public URIBuilder skip(int skip)
URIBuilder
skip
in interface URIBuilder
skip
- number of entities to be skipped into the response.QueryOption.SKIP
public URIBuilder addCustomQueryOption(String paramName, Object paramValue)
URIBuilder
addCustomQueryOption
in interface URIBuilder
paramName
- parameter nameparamValue
- parameter valuepublic URI build()
URIBuilder
build
in interface URIBuilder
public URIBuilder appendEntitySetSegment(String entitySet)
URIBuilder
appendEntitySetSegment
in interface URIBuilder
entitySet
- String entity set.public URIBuilder appendNavigationSegment(String navigationProperty)
URIBuilder
appendNavigationSegment
in interface URIBuilder
navigationProperty
- String navigation property.public URIBuilder appendKeySegment(Object value)
URIBuilder
appendKeySegment
in interface URIBuilder
value
- segment value.public URIBuilder appendKeySegment(Map<String,Object> segmentValues)
URIBuilder
appendKeySegment
in interface URIBuilder
segmentValues
- segment values.public URIBuilder appendPropertySegment(String segmentValue)
URIBuilder
appendPropertySegment
in interface URIBuilder
segmentValue
- String segment value.public URIBuilder expand(String... expandItems)
URIBuilder
expand
in interface URIBuilder
expandItems
- items to be expanded in-lineQueryOption.EXPAND
public URIBuilder select(String... selectItems)
URIBuilder
select
in interface URIBuilder
selectItems
- select itemsQueryOption.SELECT
public URIBuilder orderBy(String order)
URIBuilder
orderBy
in interface URIBuilder
order
- order string.QueryOption.ORDERBY
public URIBuilder replaceQueryOption(QueryOption option, String value)
option
- value
- public URIBuilder appendFunctionImportSegment(String functionImport)
URIBuilder
appendFunctionImportSegment
in interface URIBuilder
public URIBuilder appendFunctionImportParameters(Map<String,Object> functionImportParams)
URIBuilder
appendFunctionImportParameters
in interface URIBuilder
Copyright © 2013-2019 The Apache Software Foundation. All Rights Reserved.