Package org.apache.olingo.odata2.client.core.uri

Class EdmURIBuilderImpl

java.lang.Object

org.apache.olingo.odata2.client.core.uri.EdmURIBuilderImpl

All Implemented Interfaces:

EdmURIBuilder

public class EdmURIBuilderImpl
extends Object
implements EdmURIBuilder

This is a builder class that constructs URI with edm validations

Field Summary

Fields

Modifier and Type	Field	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 Summary

Constructors

Constructor	Description
EdmURIBuilderImpl(String serviceRoot)	Constructor.

Method Summary

Modifier and Type	Method	Description
EdmURIBuilder	addCustomQueryOption(String paramName, Object paramValue)
EdmURIBuilder	addQueryOption(String option, String value, boolean replace)
EdmURIBuilder	addQueryOption(QueryOption option, String value)
EdmURIBuilder	appendCountSegment()
EdmURIBuilder	appendEntitySetSegment(org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet)
EdmURIBuilder	appendFunctionImportParameters(Map<org.apache.olingo.odata2.api.edm.EdmParameter,Object> functionImportParams)
EdmURIBuilder	appendFunctionImportSegment(org.apache.olingo.odata2.api.edm.EdmFunctionImport functionImport)
EdmURIBuilder	appendKeySegment(Map<org.apache.olingo.odata2.api.edm.EdmProperty,Object> segmentValues)
EdmURIBuilder	appendKeySegment(org.apache.olingo.odata2.api.edm.EdmProperty property, Object value)
EdmURIBuilder	appendMetadataSegment()
EdmURIBuilder	appendNavigationSegment(org.apache.olingo.odata2.api.edm.EdmNavigationProperty property)
EdmURIBuilder	appendPropertySegment(org.apache.olingo.odata2.api.edm.EdmProperty property, String segmentValue)
EdmURIBuilder	appendValueSegment()
URI	build()
protected String	buildMultiKeySegment(Map<org.apache.olingo.odata2.api.edm.EdmProperty,Object> segmentValues, char separator)
EdmURIBuilder	expand(String... expandItems)
EdmURIBuilder	filter(String filter)
EdmURIBuilder	format(String format)
EdmURIBuilder	orderBy(String property)
EdmURIBuilder	replaceQueryOption(QueryOption option, String value)
EdmURIBuilder	select(String... selectItems)
EdmURIBuilder	skip(int skip)
EdmURIBuilder	top(int top)

Methods inherited from class java.lang.Object

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

Field Detail

segments

protected final List<Segment> segments

queryOptions

protected final Map<String,String> queryOptions

Insertion-order map of query options.

customQueryOptions

protected final Map<String,String> customQueryOptions

Insertion-order map of custom query options.

functionImportParameters

protected final Map<String,Object> functionImportParameters

Insertion-order map of function import parameters.

Constructor Detail

EdmURIBuilderImpl

public EdmURIBuilderImpl(String serviceRoot)

Constructor.

Parameters:

serviceRoot - absolute URL (schema, host and port included) representing the location of the root of the data service.

Method Detail

appendCountSegment

public EdmURIBuilder appendCountSegment()

Specified by:

appendCountSegment in interface EdmURIBuilder

appendValueSegment

public EdmURIBuilder appendValueSegment()

Specified by:

appendValueSegment in interface EdmURIBuilder

appendMetadataSegment

public EdmURIBuilder appendMetadataSegment()

Specified by:

appendMetadataSegment in interface EdmURIBuilder

format

public EdmURIBuilder format(String format)

Specified by:

format in interface EdmURIBuilder

appendEntitySetSegment

public EdmURIBuilder appendEntitySetSegment(org.apache.olingo.odata2.api.edm.EdmEntitySet entitySet)

Specified by:

appendEntitySetSegment in interface EdmURIBuilder

appendNavigationSegment

public EdmURIBuilder appendNavigationSegment(org.apache.olingo.odata2.api.edm.EdmNavigationProperty property)

Specified by:

appendNavigationSegment in interface EdmURIBuilder

appendKeySegment

public EdmURIBuilder appendKeySegment(org.apache.olingo.odata2.api.edm.EdmProperty property,
                                      Object value)

Specified by:

appendKeySegment in interface EdmURIBuilder

appendKeySegment

public EdmURIBuilder appendKeySegment(Map<org.apache.olingo.odata2.api.edm.EdmProperty,Object> segmentValues)

Specified by:

appendKeySegment in interface EdmURIBuilder

buildMultiKeySegment

protected String buildMultiKeySegment(Map<org.apache.olingo.odata2.api.edm.EdmProperty,Object> segmentValues,
                                      char separator)
                               throws org.apache.olingo.odata2.api.edm.EdmException

Throws:

org.apache.olingo.odata2.api.edm.EdmException

filter

public EdmURIBuilder filter(String filter)

Specified by:

filter in interface EdmURIBuilder

select

public EdmURIBuilder select(String... selectItems)

Specified by:

select in interface EdmURIBuilder

orderBy

public EdmURIBuilder orderBy(String property)

Specified by:

orderBy in interface EdmURIBuilder

top

public EdmURIBuilder top(int top)

Specified by:

top in interface EdmURIBuilder

skip

public EdmURIBuilder skip(int skip)

Specified by:

skip in interface EdmURIBuilder

build

public URI build()

Specified by:

build in interface EdmURIBuilder

addQueryOption

public EdmURIBuilder addQueryOption(QueryOption option,
                                    String value)

Specified by:

addQueryOption in interface EdmURIBuilder

replaceQueryOption

public EdmURIBuilder replaceQueryOption(QueryOption option,
                                        String value)

addQueryOption

public EdmURIBuilder addQueryOption(String option,
                                    String value,
                                    boolean replace)

appendPropertySegment

public EdmURIBuilder appendPropertySegment(org.apache.olingo.odata2.api.edm.EdmProperty property,
                                           String segmentValue)

Specified by:

appendPropertySegment in interface EdmURIBuilder

expand

public EdmURIBuilder expand(String... expandItems)

Specified by:

expand in interface EdmURIBuilder

addCustomQueryOption

public EdmURIBuilder addCustomQueryOption(String paramName,
                                          Object paramValue)

Specified by:

addCustomQueryOption in interface EdmURIBuilder

appendFunctionImportSegment

public EdmURIBuilder appendFunctionImportSegment(org.apache.olingo.odata2.api.edm.EdmFunctionImport functionImport)

Specified by:

appendFunctionImportSegment in interface EdmURIBuilder

appendFunctionImportParameters

public EdmURIBuilder appendFunctionImportParameters(Map<org.apache.olingo.odata2.api.edm.EdmParameter,Object> functionImportParams)

Specified by:

appendFunctionImportParameters in interface EdmURIBuilder