kotlin-odata/com.sap.cloud.mobile.kotlin.odata/DataPath

DataPath

open class DataPath : PropertyPath, BindingPath

Used together with {@link com.sap.cloud.mobile.kotlin.odata.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.

Types

Companion

object Companion

Properties

dataType

open override val dataType: DataType

definedProperty

val definedProperty: Property?

dynamicProperty

val dynamicProperty: String?

entityKey

open val entityKey: EntityKey?

entitySet

open val entitySet: EntitySet?

isNavigation

open val isNavigation: Boolean

isStructural

open val isStructural: Boolean

itemIndex

open val itemIndex: Int?

lambdaType

val lambdaType: StructureType?

lambdaVariable

val lambdaVariable: String?

parentPath

open val parentPath: DataPath?

pathSegments

open val pathSegments: StringList

pathType

open val pathType: Int

rootPath

open val rootPath: DataPath

rootProperty

open val rootProperty: Property?

segmentCount

open val segmentCount: Int

Functions

atIndex

open fun atIndex(itemIndex: Int): DataPath

Sets the item index to address an element of an entity collection.

changeRoot

open fun changeRoot(newRoot: DataPath): DataPath

Return a copy of this data path with the {@link com.sap.cloud.mobile.kotlin.odata.DataPath#rootProperty DataPath.rootProperty} changed.

copyMutable

open override fun copyMutable(): DataValue

Return a clone of this value if it (together with all value subcomponents) is possibly mutable, or return this value if it (together with all value subcomponents) is definitely immutable. The resulting value might share mutable metadata with this query.

dotString

open fun dotString(): String

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

dynamicPath

open fun dynamicPath(child: String): DataPath

Construct a new multi-part path, with this path as the {@link com.sap.cloud.mobile.kotlin.odata.DataPath#parentPath DataPath.parentPath}.

hasSegments

open fun hasSegments(): Boolean

Return true if this path has segments.

isNavigationProperty

open fun isNavigationProperty(): Boolean

See isNavigationProperty(Property?).

open fun isNavigationProperty(property: Property?): Boolean

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

isProperty

open fun isProperty(): Boolean

See isProperty(Property?).

open fun isProperty(property: Property?): Boolean

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

isStructuralProperty

open fun isStructuralProperty(): Boolean

See isStructuralProperty(Property?).

open fun isStructuralProperty(property: Property?): Boolean

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

path

open fun path(child: Property): DataPath

Return a new multi-part path, with this path as the {@link com.sap.cloud.mobile.kotlin.odata.DataPath#parentPath DataPath.parentPath}.

resolveType

open fun resolveType(): DataType

Return the resolved data type of this path, or {@link com.sap.cloud.mobile.kotlin.odata.DataType#unknown DataType.unknown} if it cannot be determined statically.

toPath

open override fun toPath(): DataPath

Return this property or path, expressed as a DataPath.

toString

open override fun toString(): String

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

unwrap

open override fun unwrap(): DataValue

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

withKey

open fun withKey(entityKey: EntityKey): DataPath

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

withParent

open fun withParent(parent: DataPath): DataPath

Return a copy of this data path with the specified parent as the {@link com.sap.cloud.mobile.kotlin.odata.DataPath#parentPath DataPath.parentPath} of the prior {@link com.sap.cloud.mobile.kotlin.odata.DataPath#rootPath DataPath.rootPath}.