com.sap.cloud.server.odata

Class DataPath

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.QueryValue

com.sap.cloud.server.odata.PropertyPath

com.sap.cloud.server.odata.DataPath

public class DataPath
extends PropertyPath

Used together with DataQuery to represent a select, expand or sort item which is a single-part or multi-part path expression. For example, a path whose OData URL representation is "Address/City" might be used to access the "City" property in a complex-typed "Address" property. Also used to represent paths in OData CSDL.

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Method Summary

Modifier and Type	Method and Description
DataPath	atIndex(int itemIndex) Sets the item index to address an element of a collection typed property.
static DataPath	castOptional(DataValue value) For internal use only.
static DataPath	castRequired(DataValue value) For internal use only.
DataPath	dynamicPath(java.lang.String child) Construct a new multi-part path, with this path as the DataPath.parentPath.
DataType	getDataType() Return data type with a DataType.code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.
Property	getDefinedProperty() Return (nullable) The defined property for a single-part path or the terminating defined property for a multi-part path.
java.lang.String	getDynamicProperty() Return (nullable) The dynamic property for a single-part path or the terminating dynamic property for a multi-part path.
EntityKey	getEntityKey() Return (nullable) The entity key of the element in an entity collection.
java.lang.Integer	getItemIndex() Return (nullable) The index of an element in a collection.
java.lang.String	getLambdaVariable() Return (nullable) The lambda variable name for a lambda variable path.
DataPath	getParentPath() Return (nullable) The parent path for a multi-part path; null for a single-part path.
StringList	getPathSegments() Return the '/'-separated segments in this path, as a list.
int	getPathType() Return data type code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.
Property	getRootProperty() Return (nullable) The DataPath.definedProperty from the topmost DataPath.parentPath in this path, or null if unknown.
int	getSegmentCount() Return the number of segments in this path.
boolean	hasSegments() Return true if this path has segments.
boolean	isNavigation() Return true if this path has type DataType.NAVIGATION_PATH.
boolean	isProperty(Property property) Return true if this path is simply for the specified target property.
boolean	isStructural() Return true if this path has type DataType.STRUCTURAL_PATH.
static DataPath	lambda(java.lang.String name) Construct a lambda variable path (for use with 'any' and 'all' lambda operators).
static DataPath	of(Property start) Construct a new single-part path.
static DataPath	ofDynamic(java.lang.String start) Construct a new single-part path.
DataPath	path(Property child) Construct a new multi-part path, with this path as the DataPath.parentPath.
static DataPath	toDynamic(StringList segments) Return a new data path with the specified type, using chained DataPath.parentPath and DataPath.dynamicProperty rather than DataPath.pathSegments.
DataPath	toPath() Return this property or path, expressed as a DataPath.
java.lang.String	toString() Return the OData CSDL path expression syntax for this path ('/'-separated segments).
DataValue	unwrap() Return the path, property, constant value or query function/operator call which is wrapped by this object.
DataPath	withKey(EntityKey entityKey) Sets the entity key to address an element of an entity collection.
static DataPath	withSegments(int type, StringList segments) Return a new data path with the specified type and segments.

Methods inherited from class com.sap.cloud.server.odata.QueryValue

add, add, add, add, add, add, add, all, any, asType, average, ceiling, concat, concat, contains, contains, countDistinct, date, day, divide, divide, divide, divide, divide, divide, divide, endsWith, endsWith, equal, equal, equal, equal, equal, equal, equal, equal, equal, floor, fractionalSeconds, geoDistance, geoIntersectse, geoLength, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, has, hour, indexOf, indexOf, isNull, isType, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, maximum, minimum, minute, modulo, modulo, modulo, modulo, modulo, modulo, modulo, month, multiply, multiply, multiply, multiply, multiply, multiply, multiply, negate, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notNull, round, second, startsWith, startsWith, substring, substring, substring, substring, subtract, subtract, subtract, subtract, subtract, subtract, subtract, sum, time, toLower, totalOffsetMinutes, toUpper, trim, wrap, year

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

atIndex

public DataPath atIndex(int itemIndex)

Sets the item index to address an element of a collection typed property.

Parameters:

itemIndex - Zero-based index of the element in the collection.

Returns:

This data path.

castOptional

public static DataPath castOptional(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

castRequired

public static DataPath castRequired(DataValue value)

For internal use only.

Parameters:

value - (internal use only)

Returns:

(internal use only)

dynamicPath

public DataPath dynamicPath(java.lang.String child)

Construct a new multi-part path, with this path as the DataPath.parentPath.

Parameters:

child - Value for DataPath.dynamicProperty in the new path.

Returns:

A new multi-part path.

getDataType

public DataType getDataType()

Return data type with a DataType.code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.

Overrides:

getDataType in class QueryValue

Returns:

Data type with a DataType.code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.

getDefinedProperty

public Property getDefinedProperty()

Return (nullable) The defined property for a single-part path or the terminating defined property for a multi-part path.

See Also:

DataPath.of, DataPath.path.

Returns:

(nullable) The defined property for a single-part path or the terminating defined property for a multi-part path.

getDynamicProperty

public java.lang.String getDynamicProperty()

Return (nullable) The dynamic property for a single-part path or the terminating dynamic property for a multi-part path.

See Also:

DataPath.ofDynamic, DataPath.dynamicPath.

Returns:

(nullable) The dynamic property for a single-part path or the terminating dynamic property for a multi-part path.

getEntityKey

public EntityKey getEntityKey()

Return (nullable) The entity key of the element in an entity collection.

Returns:

(nullable) The entity key of the element in an entity collection.

getItemIndex

public java.lang.Integer getItemIndex()

Return (nullable) The index of an element in a collection.

Returns:

(nullable) The index of an element in a collection.

getLambdaVariable

public java.lang.String getLambdaVariable()

Return (nullable) The lambda variable name for a lambda variable path.

See Also:

DataPath.lambda.

Returns:

(nullable) The lambda variable name for a lambda variable path.

getParentPath

public DataPath getParentPath()

Return (nullable) The parent path for a multi-part path; null for a single-part path.

See Also:

DataPath.path.

Returns:

(nullable) The parent path for a multi-part path; `null` for a single-part path.

getPathSegments

public StringList getPathSegments()

Return the '/'-separated segments in this path, as a list.

Returns:

The '/'-separated segments in this path, as a list.

getPathType

public int getPathType()

Return data type code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.

Returns:

Data type code of DataType.PATH, DataType.PATH_EXPRESSION, DataType.ANNOTATION_PATH, DataType.NAVIGATION_PATH, DataType.STRUCTURAL_PATH, or DataType.DYNAMIC_PATH.

getRootProperty

public Property getRootProperty()

Return (nullable) The DataPath.definedProperty from the topmost DataPath.parentPath in this path, or null if unknown.

Returns:

(nullable) The DataPath.definedProperty from the topmost DataPath.parentPath in this path, or null if unknown.

getSegmentCount

public int getSegmentCount()

Return the number of segments in this path.

Returns:

The number of segments in this path.

hasSegments

public boolean hasSegments()

Return true if this path has segments.

Returns:

true if this path has segments.

isNavigation

public boolean isNavigation()

Return true if this path has type DataType.NAVIGATION_PATH.

Returns:

true if this path has type DataType.NAVIGATION_PATH.

isProperty

public boolean isProperty(Property property)

Return true if this path is simply for the specified target property.

Parameters:

property - Specified target property.

Returns:

true if this path is simply for the specified target property.

isStructural

public boolean isStructural()

Return true if this path has type DataType.STRUCTURAL_PATH.

Returns:

true if this path has type DataType.STRUCTURAL_PATH.

lambda

public static DataPath lambda(java.lang.String name)

Construct a lambda variable path (for use with 'any' and 'all' lambda operators).

Parameters:

name - Lambda variable name.

Returns:

A new lambda-variable path.

of

public static DataPath of(Property start)

Construct a new single-part path.

Parameters:

start - Value for DataPath.definedProperty in the new path.

Returns:

A new single-part path.

ofDynamic

public static DataPath ofDynamic(java.lang.String start)

Construct a new single-part path.

Parameters:

start - Value for DataPath.dynamicProperty in the new path.

Returns:

A new single-part path.

path

public DataPath path(Property child)

Construct a new multi-part path, with this path as the DataPath.parentPath.

Parameters:

child - Value for DataPath.definedProperty in the new path.

Returns:

A new multi-part path.

toDynamic

public static DataPath toDynamic(StringList segments)

Return a new data path with the specified type, using chained DataPath.parentPath and DataPath.dynamicProperty rather than DataPath.pathSegments.

See Also:

DataPath.withSegments.

Parameters:

segments - Path segments. Must not be empty.

Returns:

A new data path with the specified `type`, using chained DataPath.parentPath and DataPath.dynamicProperty rather than DataPath.pathSegments.

toPath

public DataPath toPath()

Return this property or path, expressed as a DataPath.

Specified by:

toPath in class PropertyPath

Returns:

this property or path, expressed as a DataPath.

toString

public java.lang.String toString()

Return the OData CSDL path expression syntax for this path ('/'-separated segments).

Overrides:

toString in class QueryValue

Returns:

the OData CSDL path expression syntax for this path ('/'-separated segments).

unwrap

public DataValue unwrap()

Return the path, property, constant value or query function/operator call which is wrapped by this object.

Overrides:

unwrap in class QueryValue

Returns:

The path, property, constant value or query function/operator call which is wrapped by this object.

withKey

public DataPath withKey(EntityKey entityKey)

Sets the entity key to address an element of an entity collection.

Parameters:

entityKey - Entity key of the element in the entity collection.

Returns:

This data path.

withSegments

public static DataPath withSegments(int type,
                                    StringList segments)

Return a new data path with the specified type and segments.

Parameters:

type - Value for DataPath.pathType.

segments - Value for DataPath.pathSegments.

Returns:

A new data path with the specified type and segments.