Package org.apache.olingo.server.core.uri

Class UriInfoImpl

java.lang.Object

org.apache.olingo.server.core.uri.UriInfoImpl

All Implemented Interfaces:

UriInfo, UriInfoAll, UriInfoBatch, UriInfoCrossjoin, UriInfoEntityId, UriInfoMetadata, UriInfoResource, UriInfoService

public class UriInfoImpl
extends Object
implements UriInfo

Constructor Summary

Constructors

Constructor	Description
UriInfoImpl()

Method Summary

Modifier and Type	Method	Description
UriInfoImpl	addAlias(AliasQueryOption alias)
UriInfoImpl	addCustomQueryOption(CustomQueryOption option)
UriInfoImpl	addEntitySetName(String entitySet)
UriInfoImpl	addResourcePart(UriResource uriPathInfo)
UriInfoAll	asUriInfoAll()	Convenience casting method.
UriInfoBatch	asUriInfoBatch()	Convenience casting method.
UriInfoCrossjoin	asUriInfoCrossjoin()	Convenience casting method.
UriInfoEntityId	asUriInfoEntityId()	Convenience casting method.
UriInfoMetadata	asUriInfoMetadata()	Convenience casting method.
UriInfoResource	asUriInfoResource()	Convenience casting method.
UriInfoService	asUriInfoService()	Convenience casting method.
List<AliasQueryOption>	getAliases()	Gets a list of all alias definitions which were in the URI (including aliases not used anywhere).
Map<String,AliasQueryOption>	getAliasMap()
ApplyOption	getApplyOption()
CountOption	getCountOption()
List<CustomQueryOption>	getCustomQueryOptions()
DeltaTokenOption	getDeltaTokenOption()
List<String>	getEntitySetNames()
EdmEntityType	getEntityTypeCast()	Behind $entity a optional type cast can be used in the URI.
ExpandOption	getExpandOption()
FilterOption	getFilterOption()
FormatOption	getFormatOption()
String	getFragment()
IdOption	getIdOption()
UriInfoKind	getKind()	See UriInfoKind for more details which kinds are allowed.
UriResource	getLastResourcePart()
OrderByOption	getOrderByOption()
SearchOption	getSearchOption()
SelectOption	getSelectOption()
SkipOption	getSkipOption()
SkipTokenOption	getSkipTokenOption()
List<SystemQueryOption>	getSystemQueryOptions()	Gets a list of all system query options which were in the URI.
TopOption	getTopOption()
List<UriResource>	getUriResourceParts()	The path segments behind the service root define which resources are requested by that URI.
String	getValueForAlias(String alias)
UriInfoImpl	setEntityTypeCast(EdmEntityType type)
UriInfoImpl	setFragment(String fragment)
UriInfoImpl	setKind(UriInfoKind kind)
UriInfoImpl	setQueryOption(QueryOption option)
UriInfoImpl	setSystemQueryOption(SystemQueryOption systemOption)	Adds system query option.

Methods inherited from class java.lang.Object

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

Constructor Details

UriInfoImpl

public UriInfoImpl()

Method Details

setKind

public UriInfoImpl setKind(UriInfoKind kind)

getKind

public UriInfoKind getKind()

Description copied from interface: UriInfo

See UriInfoKind for more details which kinds are allowed.

Specified by:

getKind in interface UriInfo

Returns:

the kind of this URI info object.

asUriInfoAll

public UriInfoAll asUriInfoAll()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoAll in interface UriInfo

Returns:

this as a UriInfoAll object

asUriInfoBatch

public UriInfoBatch asUriInfoBatch()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoBatch in interface UriInfo

Returns:

this as a UriInfoBatch object

asUriInfoCrossjoin

public UriInfoCrossjoin asUriInfoCrossjoin()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoCrossjoin in interface UriInfo

Returns:

this as a UriInfoCrossjoin object

asUriInfoEntityId

public UriInfoEntityId asUriInfoEntityId()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoEntityId in interface UriInfo

Returns:

this as a UriInfoEntityId object

asUriInfoService

public UriInfoService asUriInfoService()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoService in interface UriInfo

Returns:

this as a UriInfoService object

asUriInfoMetadata

public UriInfoMetadata asUriInfoMetadata()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoMetadata in interface UriInfo

Returns:

this as a UriInfoMetadata object

asUriInfoResource

public UriInfoResource asUriInfoResource()

Description copied from interface: UriInfo

Convenience casting method.

Specified by:

asUriInfoResource in interface UriInfo

Returns:

this as a UriInfoResource object

addEntitySetName

public UriInfoImpl addEntitySetName(String entitySet)

getEntitySetNames

public List<String> getEntitySetNames()

Specified by:

getEntitySetNames in interface UriInfoCrossjoin

Returns:

List of entity set names

setEntityTypeCast

public UriInfoImpl setEntityTypeCast(EdmEntityType type)

getEntityTypeCast

public EdmEntityType getEntityTypeCast()

Description copied from interface: UriInfoEntityId

Behind $entity a optional type cast can be used in the URI. For example: http://.../serviceroot/$entity/namespace.entitytype

Specified by:

getEntityTypeCast in interface UriInfoEntityId

Returns:

Type cast if found, otherwise null

addResourcePart

public UriInfoImpl addResourcePart(UriResource uriPathInfo)

getLastResourcePart

public UriResource getLastResourcePart()

getUriResourceParts

public List<UriResource> getUriResourceParts()

Description copied from interface: UriInfoResource

The path segments behind the service root define which resources are requested by that URI. This may be entities/functions/actions and more. Each segments information (name, key predicates, function parameters, ...) is stored within an resource object dedicated for that segment type.

For example: the URI http://.../serviceroot/entitySet(1)/Adresse will have 2 ResourceParts:
- The first one of type UriResourceEntitySet containing the name of the entity set and also the key predicate information.
- The second one of type UriResourceComplexProperty containing the name of the accessed complex property

Specified by:

getUriResourceParts in interface UriInfoResource

Returns:

List of resource parts.

setQueryOption

public UriInfoImpl setQueryOption(QueryOption option)

setSystemQueryOption

public UriInfoImpl setSystemQueryOption(SystemQueryOption systemOption)

Adds system query option.

Parameters:

systemOption - the option to be added

Returns:

this object for method chaining

Throws:

ODataRuntimeException - if an unsupported option is provided or an option of this kind has been added before

getExpandOption

public ExpandOption getExpandOption()

Specified by:

getExpandOption in interface UriInfoCrossjoin

Specified by:

getExpandOption in interface UriInfoEntityId

Specified by:

getExpandOption in interface UriInfoResource

Returns:

Object containing information of the $expand option

getFilterOption

public FilterOption getFilterOption()

Specified by:

getFilterOption in interface UriInfoCrossjoin

Specified by:

getFilterOption in interface UriInfoResource

Returns:

Object containing information of the $filter option

getFormatOption

public FormatOption getFormatOption()

Specified by:

getFormatOption in interface UriInfoAll

Specified by:

getFormatOption in interface UriInfoCrossjoin

Specified by:

getFormatOption in interface UriInfoEntityId

Specified by:

getFormatOption in interface UriInfoMetadata

Specified by:

getFormatOption in interface UriInfoResource

Returns:

Object containing information of the $format option

getIdOption

public IdOption getIdOption()

Specified by:

getIdOption in interface UriInfoEntityId

Specified by:

getIdOption in interface UriInfoResource

Returns:

Object containing information of the $id option

getCountOption

public CountOption getCountOption()

Specified by:

getCountOption in interface UriInfoAll

Specified by:

getCountOption in interface UriInfoCrossjoin

Specified by:

getCountOption in interface UriInfoResource

Returns:

Object containing information of the $count option

getOrderByOption

public OrderByOption getOrderByOption()

Specified by:

getOrderByOption in interface UriInfoCrossjoin

Specified by:

getOrderByOption in interface UriInfoResource

Returns:

Object containing information of the $orderby option

getSearchOption

public SearchOption getSearchOption()

Specified by:

getSearchOption in interface UriInfoAll

Specified by:

getSearchOption in interface UriInfoCrossjoin

Specified by:

getSearchOption in interface UriInfoResource

Returns:

Object containing information of the $search option

getSelectOption

public SelectOption getSelectOption()

Specified by:

getSelectOption in interface UriInfoCrossjoin

Specified by:

getSelectOption in interface UriInfoEntityId

Specified by:

getSelectOption in interface UriInfoResource

Returns:

Object containing information of the $select option

getSkipOption

public SkipOption getSkipOption()

Specified by:

getSkipOption in interface UriInfoAll

Specified by:

getSkipOption in interface UriInfoCrossjoin

Specified by:

getSkipOption in interface UriInfoResource

Returns:

Object containing information of the $skip option

getSkipTokenOption

public SkipTokenOption getSkipTokenOption()

Specified by:

getSkipTokenOption in interface UriInfoAll

Specified by:

getSkipTokenOption in interface UriInfoCrossjoin

Specified by:

getSkipTokenOption in interface UriInfoResource

Returns:

Object containing information of the $skiptoken option

getTopOption

public TopOption getTopOption()

Specified by:

getTopOption in interface UriInfoAll

Specified by:

getTopOption in interface UriInfoCrossjoin

Specified by:

getTopOption in interface UriInfoResource

Returns:

Object containing information of the $top option

getApplyOption

public ApplyOption getApplyOption()

Specified by:

getApplyOption in interface UriInfoResource

Returns:

information about the $apply option

getSystemQueryOptions

public List<SystemQueryOption> getSystemQueryOptions()

Description copied from interface: UriInfo

Gets a list of all system query options which were in the URI.

Specified by:

getSystemQueryOptions in interface UriInfo

Returns:

a list of all system query options used

addAlias

public UriInfoImpl addAlias(AliasQueryOption alias)

getValueForAlias

public String getValueForAlias(String alias)

Specified by:

getValueForAlias in interface UriInfoResource

Returns:

the value for the given alias or null if no value is defined

getAliasMap

public Map<String,AliasQueryOption> getAliasMap()

getAliases

public List<AliasQueryOption> getAliases()

Description copied from interface: UriInfo

Gets a list of all alias definitions which were in the URI (including aliases not used anywhere).

Specified by:

getAliases in interface UriInfo

Returns:

a list of all alias definitions

addCustomQueryOption

public UriInfoImpl addCustomQueryOption(CustomQueryOption option)

getCustomQueryOptions

public List<CustomQueryOption> getCustomQueryOptions()

Specified by:

getCustomQueryOptions in interface UriInfoAll

Specified by:

getCustomQueryOptions in interface UriInfoEntityId

Specified by:

getCustomQueryOptions in interface UriInfoResource

Returns:

List of custom query options used in the URI (without alias definitions)

setFragment

public UriInfoImpl setFragment(String fragment)

getFragment

public String getFragment()

Specified by:

getFragment in interface UriInfoMetadata

Returns:

Object containing information of the URI fragment

getDeltaTokenOption

public DeltaTokenOption getDeltaTokenOption()

Specified by:

getDeltaTokenOption in interface UriInfoAll

Specified by:

getDeltaTokenOption in interface UriInfoCrossjoin

Specified by:

getDeltaTokenOption in interface UriInfoResource

Returns:

Object containing information of the $deltatoken option