ResourcePath

open class ResourcePath : DataValue, @unchecked Sendable

Holds the path to a data service resource.

  • Default initializer.

    Declaration

    Swift

    override public init()
  • Declaration

    Swift

    override open func copyMutable() -> DataValue

    Return Value

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

  • Data path for resource. Will be null if entitySet and/or entityKey is non-null.

    Declaration

    Swift

    open var dataPath: DataPath? { get set }
  • Data type of the wrapped value.

    Declaration

    Swift

    override open var dataType: DataType { get }
  • Entity key for resource path. Will be null if dataPath is non-null.

    Declaration

    Swift

    open var entityKey: EntityKey? { get set }
  • Entity set for resource path. Will be null if dataPath is non-null.

    Declaration

    Swift

    open var entitySet: EntitySet? { get set }
  • Declaration

    Swift

    open class func from(_ entitySet: EntitySet) -> ResourcePath

    Parameters

    entitySet

    Entity set for the resource.

    Return Value

    A new resource path specifying entitySet.

  • Declaration

    Swift

    open class func join(_ joinSets: EntitySetList) -> ResourcePath

    Parameters

    joinSets

    Entity sets to be joined.

    Return Value

    A new resource path specifying joinSets.

  • Entity sets for cross join. EntitySetList.empty if none were specified.

    Declaration

    Swift

    open var joinSets: EntitySetList { get set }
  • Declaration

    Swift

    open class func of(_ dataPath: DataPath) -> ResourcePath

    Parameters

    dataPath

    Data path for the resource.

    Return Value

    A new resource path specifying dataPath.

  • Convert this data value to a string. If the dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

    Declaration

    Swift

    override open func toString() -> String

    Return Value

    Lexical representation of this data value.