space.kscience.dataforge.provider

Path

common

@JvmInline

value class Path(tokens: List<PathToken>) : Iterable<PathToken>

Path interface.

PathToken

common

data class PathToken(name: Name, target: String?)

Provider

common

interface Provider

A marker utility interface for providers.

asPath

common

fun PathToken.asPath(): Path

Represent this path token as full path

fun Name.asPath(target: String? = null): Path

Represent a name with optional target as a Path

gather

jvm

inline fun <T : Any> Context.gather(inherit: Boolean = true): Map<Name, T>

All objects provided by plugins with given target and type

Path

common

fun Path(vararg tokens: Pair<Name, String?>): Path

Use an array of Name-target pairs to construct segmented Path

fun Path(vararg names: Name): Path

Build a path from given names using default targets

plus

common

operator fun Path.plus(path: Path): Path

provide

common

inline fun <T : Any> Provider.provide(path: String, targetOverride: String? = null): T?

Type checked provide

fun Provider.provide(path: Path, targetOverride: String? = null): Any?

provideByType

jvm

inline fun <T : Any> Provider.provideByType(name: String): T?

Provide an object with given name inferring target from its type using Type annotation

top

jvm

inline fun <T : Any> Provider.top(): Map<Name, T>

common

inline fun <T : Any> Provider.top(target: String): Map<Name, T>

fun <T : Any> Provider.top(target: String, type: KClass<out T>): Map<Name, T>

Typed top level content

dfType

jvm

val KClass<*>.dfType: String

head

common

val Path.head: PathToken?

length

common

val Path.length: Int

tail

common

val Path.tail: Path?

Returns non-empty optional containing the chain without first segment in case of chain path.

Package space.kscience.dataforge.provider

Types

Functions

Properties