Package org.apache.olingo.odata2.api.uri
Interface UriInfo
-
- All Superinterfaces:
DeleteUriInfo,GetComplexPropertyUriInfo,GetEntityCountUriInfo,GetEntityLinkCountUriInfo,GetEntityLinkUriInfo,GetEntitySetCountUriInfo,GetEntitySetLinksCountUriInfo,GetEntitySetLinksUriInfo,GetEntitySetUriInfo,GetEntityUriInfo,GetFunctionImportUriInfo,GetMediaResourceUriInfo,GetMetadataUriInfo,GetServiceDocumentUriInfo,GetSimplePropertyUriInfo,PostUriInfo,PutMergePatchUriInfo
public interface UriInfo extends GetServiceDocumentUriInfo, GetEntitySetUriInfo, GetEntityUriInfo, GetComplexPropertyUriInfo, GetSimplePropertyUriInfo, GetEntityLinkUriInfo, GetEntitySetLinksUriInfo, GetMetadataUriInfo, GetFunctionImportUriInfo, GetEntitySetCountUriInfo, GetEntityCountUriInfo, GetMediaResourceUriInfo, GetEntityLinkCountUriInfo, GetEntitySetLinksCountUriInfo, PutMergePatchUriInfo, PostUriInfo, DeleteUriInfo
Structured parts of the request URI - the result of URI parsing. @org.apache.olingo.odata2.DoNotImplement- See Also:
UriParser
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancomposeWhere()StringgetCallback()List<ClientCallback>getClientCallbacks()Map<String,String>getCustomQueryOptions()Gets the custom query options as Map from option names to their corresponding String values, or an empty list if no custom query options are given in the URI.EdmEntityContainergetEntityContainer()Gets the target entity container.List<ArrayList<NavigationPropertySegment>>getExpand()Gets the value of the $expand system query option as a list of lists of navigation-property segments, or an empty list if not used.FilterExpressiongetFilter()Gets the value of the $filter system query option as root object of the expression tree built during URI parsing.StringgetFormat()Gets the value of the $format system query option.EdmFunctionImportgetFunctionImport()Gets the function import.Map<String,EdmLiteral>getFunctionImportParameters()Gets the parameters of a function import as Map from parameter names to their corresponding typed values, or an empty list if no function import is used or no parameters are given in the URI.Map<String,List<String>>getHeaders()InlineCountgetInlineCount()Gets the value of the $inlinecount system query option.List<KeyPredicate>getKeyPredicates()Gets the key predicates used to select a single entity out of the start entity set, or an empty list if not used.List<NavigationSegment>getNavigationSegments()Gets the navigation segments, or an empty list if no navigation has been used.OrderByExpressiongetOrderBy()Gets the value of the $orderby system query option as root object of the expression tree built during URI parsing.List<EdmProperty>getPropertyPath()Gets the path used to select a (simple or complex) property of an entity, or an empty list if no property is accessed.List<SelectItem>getSelect()Gets the value of the $select system query option as a list of select items, or an empty list if not used.IntegergetSkip()Gets the value of the $skip system query option.StringgetSkipToken()Gets the value of the $skiptoken system query option.EdmEntitySetgetStartEntitySet()Gets the start entity set - identical to the target entity set if no navigation has been used.EdmEntitySetgetTargetEntitySet()Gets the target entity set after navigation.List<KeyPredicate>getTargetKeyPredicates()Gets the key predicates used to select a single entity out of the target entity set, or an empty list if not used - identical to the key predicates from the last entry retrieved fromgetNavigationSegments()or, if no navigation has been used, to the result ofgetKeyPredicates().EdmTypegetTargetType()Gets the target type of the request: an entity type, a simple type, or a complex type.IntegergetTop()Gets the value of the $top system query option.booleanisCount()Determines whether $count has been used in the request URI.booleanisLinks()Determines whether $links has been used in the request URI.booleanisNew()booleanisValue()Determines whether $value has been used in the request URI.booleanrawEntity()
-
-
-
Method Detail
-
getEntityContainer
EdmEntityContainer getEntityContainer()
Gets the target entity container.- Specified by:
getEntityContainerin interfaceDeleteUriInfo- Specified by:
getEntityContainerin interfaceGetComplexPropertyUriInfo- Specified by:
getEntityContainerin interfaceGetEntityCountUriInfo- Specified by:
getEntityContainerin interfaceGetEntityLinkCountUriInfo- Specified by:
getEntityContainerin interfaceGetEntityLinkUriInfo- Specified by:
getEntityContainerin interfaceGetEntitySetCountUriInfo- Specified by:
getEntityContainerin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getEntityContainerin interfaceGetEntitySetLinksUriInfo- Specified by:
getEntityContainerin interfaceGetEntitySetUriInfo- Specified by:
getEntityContainerin interfaceGetEntityUriInfo- Specified by:
getEntityContainerin interfaceGetMediaResourceUriInfo- Specified by:
getEntityContainerin interfaceGetSimplePropertyUriInfo- Specified by:
getEntityContainerin interfacePostUriInfo- Specified by:
getEntityContainerin interfacePutMergePatchUriInfo- Returns:
EdmEntityContainerthe target entity container
-
getStartEntitySet
EdmEntitySet getStartEntitySet()
Gets the start entity set - identical to the target entity set if no navigation has been used.- Specified by:
getStartEntitySetin interfaceDeleteUriInfo- Specified by:
getStartEntitySetin interfaceGetComplexPropertyUriInfo- Specified by:
getStartEntitySetin interfaceGetEntityCountUriInfo- Specified by:
getStartEntitySetin interfaceGetEntityLinkCountUriInfo- Specified by:
getStartEntitySetin interfaceGetEntityLinkUriInfo- Specified by:
getStartEntitySetin interfaceGetEntitySetCountUriInfo- Specified by:
getStartEntitySetin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getStartEntitySetin interfaceGetEntitySetLinksUriInfo- Specified by:
getStartEntitySetin interfaceGetEntitySetUriInfo- Specified by:
getStartEntitySetin interfaceGetEntityUriInfo- Specified by:
getStartEntitySetin interfaceGetMediaResourceUriInfo- Specified by:
getStartEntitySetin interfaceGetSimplePropertyUriInfo- Specified by:
getStartEntitySetin interfacePostUriInfo- Specified by:
getStartEntitySetin interfacePutMergePatchUriInfo- Returns:
EdmEntitySet
-
getTargetEntitySet
EdmEntitySet getTargetEntitySet()
Gets the target entity set after navigation.- Specified by:
getTargetEntitySetin interfaceDeleteUriInfo- Specified by:
getTargetEntitySetin interfaceGetComplexPropertyUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntityCountUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntityLinkCountUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntityLinkUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntitySetCountUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntitySetLinksUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntitySetUriInfo- Specified by:
getTargetEntitySetin interfaceGetEntityUriInfo- Specified by:
getTargetEntitySetin interfaceGetMediaResourceUriInfo- Specified by:
getTargetEntitySetin interfaceGetSimplePropertyUriInfo- Specified by:
getTargetEntitySetin interfacePostUriInfo- Specified by:
getTargetEntitySetin interfacePutMergePatchUriInfo- Returns:
EdmEntitySettarget entity set
-
getFunctionImport
EdmFunctionImport getFunctionImport()
Gets the function import.- Specified by:
getFunctionImportin interfaceDeleteUriInfo- Specified by:
getFunctionImportin interfaceGetComplexPropertyUriInfo- Specified by:
getFunctionImportin interfaceGetEntityCountUriInfo- Specified by:
getFunctionImportin interfaceGetEntityLinkCountUriInfo- Specified by:
getFunctionImportin interfaceGetEntityLinkUriInfo- Specified by:
getFunctionImportin interfaceGetEntitySetCountUriInfo- Specified by:
getFunctionImportin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getFunctionImportin interfaceGetEntitySetLinksUriInfo- Specified by:
getFunctionImportin interfaceGetEntitySetUriInfo- Specified by:
getFunctionImportin interfaceGetEntityUriInfo- Specified by:
getFunctionImportin interfaceGetFunctionImportUriInfo- Specified by:
getFunctionImportin interfaceGetMediaResourceUriInfo- Specified by:
getFunctionImportin interfaceGetSimplePropertyUriInfo- Specified by:
getFunctionImportin interfacePostUriInfo- Specified by:
getFunctionImportin interfacePutMergePatchUriInfo- Returns:
EdmFunctionImportthe function import
-
getTargetType
EdmType getTargetType()
Gets the target type of the request: an entity type, a simple type, or a complex type.- Specified by:
getTargetTypein interfaceDeleteUriInfo- Specified by:
getTargetTypein interfaceGetComplexPropertyUriInfo- Specified by:
getTargetTypein interfaceGetEntityCountUriInfo- Specified by:
getTargetTypein interfaceGetEntityLinkCountUriInfo- Specified by:
getTargetTypein interfaceGetEntityLinkUriInfo- Specified by:
getTargetTypein interfaceGetEntitySetCountUriInfo- Specified by:
getTargetTypein interfaceGetEntitySetLinksCountUriInfo- Specified by:
getTargetTypein interfaceGetEntitySetLinksUriInfo- Specified by:
getTargetTypein interfaceGetEntitySetUriInfo- Specified by:
getTargetTypein interfaceGetEntityUriInfo- Specified by:
getTargetTypein interfaceGetMediaResourceUriInfo- Specified by:
getTargetTypein interfaceGetSimplePropertyUriInfo- Specified by:
getTargetTypein interfacePostUriInfo- Specified by:
getTargetTypein interfacePutMergePatchUriInfo- Returns:
EdmTypethe target type
-
getKeyPredicates
List<KeyPredicate> getKeyPredicates()
Gets the key predicates used to select a single entity out of the start entity set, or an empty list if not used.- Specified by:
getKeyPredicatesin interfaceDeleteUriInfo- Specified by:
getKeyPredicatesin interfaceGetComplexPropertyUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntityCountUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntityLinkCountUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntityLinkUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntitySetCountUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntitySetLinksUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntitySetUriInfo- Specified by:
getKeyPredicatesin interfaceGetEntityUriInfo- Specified by:
getKeyPredicatesin interfaceGetMediaResourceUriInfo- Specified by:
getKeyPredicatesin interfaceGetSimplePropertyUriInfo- Specified by:
getKeyPredicatesin interfacePostUriInfo- Specified by:
getKeyPredicatesin interfacePutMergePatchUriInfo- Returns:
- List of
KeyPredicate - See Also:
getStartEntitySet()
-
getTargetKeyPredicates
List<KeyPredicate> getTargetKeyPredicates()
Gets the key predicates used to select a single entity out of the target entity set, or an empty list if not used - identical to the key predicates from the last entry retrieved fromgetNavigationSegments()or, if no navigation has been used, to the result ofgetKeyPredicates().- Specified by:
getTargetKeyPredicatesin interfaceDeleteUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetComplexPropertyUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetEntityCountUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetEntityLinkCountUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetEntityLinkUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetEntityUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetMediaResourceUriInfo- Specified by:
getTargetKeyPredicatesin interfaceGetSimplePropertyUriInfo- Specified by:
getTargetKeyPredicatesin interfacePutMergePatchUriInfo- Returns:
- List of
KeyPredicate - See Also:
getTargetEntitySet()
-
getNavigationSegments
List<NavigationSegment> getNavigationSegments()
Gets the navigation segments, or an empty list if no navigation has been used.- Specified by:
getNavigationSegmentsin interfaceDeleteUriInfo- Specified by:
getNavigationSegmentsin interfaceGetComplexPropertyUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntityCountUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntityLinkCountUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntityLinkUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntitySetCountUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntitySetLinksUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntitySetUriInfo- Specified by:
getNavigationSegmentsin interfaceGetEntityUriInfo- Specified by:
getNavigationSegmentsin interfaceGetMediaResourceUriInfo- Specified by:
getNavigationSegmentsin interfaceGetSimplePropertyUriInfo- Specified by:
getNavigationSegmentsin interfacePostUriInfo- Specified by:
getNavigationSegmentsin interfacePutMergePatchUriInfo- Returns:
- List of
NavigationSegment
-
getPropertyPath
List<EdmProperty> getPropertyPath()
Gets the path used to select a (simple or complex) property of an entity, or an empty list if no property is accessed.- Specified by:
getPropertyPathin interfaceDeleteUriInfo- Specified by:
getPropertyPathin interfaceGetComplexPropertyUriInfo- Specified by:
getPropertyPathin interfaceGetSimplePropertyUriInfo- Specified by:
getPropertyPathin interfacePutMergePatchUriInfo- Returns:
- List of
EdmProperty
-
isCount
boolean isCount()
Determines whether $count has been used in the request URI.- Specified by:
isCountin interfaceGetEntityCountUriInfo- Specified by:
isCountin interfaceGetEntityLinkCountUriInfo- Specified by:
isCountin interfaceGetEntitySetCountUriInfo- Specified by:
isCountin interfaceGetEntitySetLinksCountUriInfo- Returns:
- whether $count has been used
-
isValue
boolean isValue()
Determines whether $value has been used in the request URI.- Specified by:
isValuein interfaceGetSimplePropertyUriInfo- Returns:
- whether $value has been used
-
isLinks
boolean isLinks()
Determines whether $links has been used in the request URI.- Specified by:
isLinksin interfaceGetEntityLinkCountUriInfo- Specified by:
isLinksin interfaceGetEntityLinkUriInfo- Specified by:
isLinksin interfaceGetEntitySetLinksCountUriInfo- Specified by:
isLinksin interfaceGetEntitySetLinksUriInfo- Returns:
- whether $links has been used
-
getFormat
String getFormat()
Gets the value of the $format system query option.- Specified by:
getFormatin interfaceGetComplexPropertyUriInfo- Specified by:
getFormatin interfaceGetEntityLinkUriInfo- Specified by:
getFormatin interfaceGetEntitySetLinksUriInfo- Specified by:
getFormatin interfaceGetEntitySetUriInfo- Specified by:
getFormatin interfaceGetEntityUriInfo- Specified by:
getFormatin interfaceGetFunctionImportUriInfo- Specified by:
getFormatin interfaceGetMediaResourceUriInfo- Specified by:
getFormatin interfaceGetServiceDocumentUriInfo- Specified by:
getFormatin interfaceGetSimplePropertyUriInfo- Returns:
- the format (as set as
$formatquery parameter) or null
-
getFilter
FilterExpression getFilter()
Gets the value of the $filter system query option as root object of the expression tree built during URI parsing.- Specified by:
getFilterin interfaceGetEntityCountUriInfo- Specified by:
getFilterin interfaceGetEntitySetCountUriInfo- Specified by:
getFilterin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getFilterin interfaceGetEntitySetLinksUriInfo- Specified by:
getFilterin interfaceGetEntitySetUriInfo- Specified by:
getFilterin interfaceGetEntityUriInfo- Specified by:
getFilterin interfaceGetMediaResourceUriInfo- Specified by:
getFilterin interfacePutMergePatchUriInfo- Returns:
- the filter expression or null
-
getInlineCount
InlineCount getInlineCount()
Gets the value of the $inlinecount system query option.- Specified by:
getInlineCountin interfaceGetEntitySetLinksUriInfo- Specified by:
getInlineCountin interfaceGetEntitySetUriInfo- Returns:
InlineCountthe inline count or null
-
getOrderBy
OrderByExpression getOrderBy()
Gets the value of the $orderby system query option as root object of the expression tree built during URI parsing.- Specified by:
getOrderByin interfaceGetEntitySetUriInfo- Returns:
- the order-by expression or null
-
getSkipToken
String getSkipToken()
Gets the value of the $skiptoken system query option.- Specified by:
getSkipTokenin interfaceGetEntitySetLinksUriInfo- Specified by:
getSkipTokenin interfaceGetEntitySetUriInfo- Returns:
- skip token or null
-
getSkip
Integer getSkip()
Gets the value of the $skip system query option.- Specified by:
getSkipin interfaceGetEntitySetCountUriInfo- Specified by:
getSkipin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getSkipin interfaceGetEntitySetLinksUriInfo- Specified by:
getSkipin interfaceGetEntitySetUriInfo- Returns:
- skip or null
-
getTop
Integer getTop()
Gets the value of the $top system query option.- Specified by:
getTopin interfaceGetEntitySetCountUriInfo- Specified by:
getTopin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getTopin interfaceGetEntitySetLinksUriInfo- Specified by:
getTopin interfaceGetEntitySetUriInfo- Returns:
- top or null
-
getExpand
List<ArrayList<NavigationPropertySegment>> getExpand()
Gets the value of the $expand system query option as a list of lists of navigation-property segments, or an empty list if not used.- Specified by:
getExpandin interfaceGetEntitySetUriInfo- Specified by:
getExpandin interfaceGetEntityUriInfo- Returns:
- List of a list of
NavigationPropertySegmentto be expanded
-
getSelect
List<SelectItem> getSelect()
Gets the value of the $select system query option as a list of select items, or an empty list if not used.- Specified by:
getSelectin interfaceGetEntitySetUriInfo- Specified by:
getSelectin interfaceGetEntityUriInfo- Returns:
- List of
SelectItemto be selected
-
getFunctionImportParameters
Map<String,EdmLiteral> getFunctionImportParameters()
Gets the parameters of a function import as Map from parameter names to their corresponding typed values, or an empty list if no function import is used or no parameters are given in the URI.- Specified by:
getFunctionImportParametersin interfaceDeleteUriInfo- Specified by:
getFunctionImportParametersin interfaceGetComplexPropertyUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntityCountUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntityLinkCountUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntityLinkUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntitySetCountUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntitySetLinksUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntitySetUriInfo- Specified by:
getFunctionImportParametersin interfaceGetEntityUriInfo- Specified by:
getFunctionImportParametersin interfaceGetFunctionImportUriInfo- Specified by:
getFunctionImportParametersin interfaceGetMediaResourceUriInfo- Specified by:
getFunctionImportParametersin interfaceGetSimplePropertyUriInfo- Specified by:
getFunctionImportParametersin interfacePostUriInfo- Specified by:
getFunctionImportParametersin interfacePutMergePatchUriInfo- Returns:
- Map of <String,
EdmLiteral> function import parameters
-
getCustomQueryOptions
Map<String,String> getCustomQueryOptions()
Gets the custom query options as Map from option names to their corresponding String values, or an empty list if no custom query options are given in the URI.- Specified by:
getCustomQueryOptionsin interfaceDeleteUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetComplexPropertyUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntityCountUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntityLinkCountUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntityLinkUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntitySetCountUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntitySetLinksCountUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntitySetLinksUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntitySetUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetEntityUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetFunctionImportUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetMediaResourceUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetMetadataUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetServiceDocumentUriInfo- Specified by:
getCustomQueryOptionsin interfaceGetSimplePropertyUriInfo- Specified by:
getCustomQueryOptionsin interfacePostUriInfo- Specified by:
getCustomQueryOptionsin interfacePutMergePatchUriInfo- Returns:
- Map of <String, String> custom query options
-
getCallback
String getCallback()
- Specified by:
getCallbackin interfaceGetEntityCountUriInfo- Specified by:
getCallbackin interfaceGetEntitySetLinksUriInfo- Specified by:
getCallbackin interfaceGetEntitySetUriInfo- Specified by:
getCallbackin interfaceGetEntityUriInfo
-
rawEntity
boolean rawEntity()
-
isNew
boolean isNew()
- Specified by:
isNewin interfaceGetEntitySetUriInfo- Specified by:
isNewin interfaceGetEntityUriInfo
-
composeWhere
boolean composeWhere()
-
getClientCallbacks
List<ClientCallback> getClientCallbacks()
- Specified by:
getClientCallbacksin interfaceGetEntitySetLinksUriInfo- Specified by:
getClientCallbacksin interfaceGetEntitySetUriInfo- Specified by:
getClientCallbacksin interfaceGetEntityUriInfo
-
-