dataforge-data/space.kscience.dataforge.data/DataSourceBuilder

DataSourceBuilder

interface DataSourceBuilder<T : Any> : DataSetBuilder<T> , DataSource<T>

Inheritors

DataTreeBuilder

Properties

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val dataType: KType

abstract val meta: Meta

Meta-data associated with this node. If no meta is provided, returns Meta.EMPTY.

val CoroutineScope.monitor: CoroutineMonitor?

abstract override val updates: MutableSharedFlow<Name>

A flow of updated item names. Updates are propagated in a form of Flow of names of updated nodes. Those can include new data items and replacement of existing ones. The replaced items could update existing data content and replace it completely, so they should be pulled again.

val <T : Any> DataSet<T>.updates: Flow<Name>

updatesWithData

val <T : Any> DataSet<T>.updatesWithData: Flow<NamedData<T>>

Functions

fun <T : Any> DataSet<T>.asIterable(): Iterable<NamedData<T>>

fun <T : Any> DataSet<T>.asSequence(): Sequence<NamedData<T>>

fun <T : Any> DataSet<T>.branch(branchName: String): DataSet<T>

fun <T : Any> DataSet<T>.branch(branchName: Name): DataSet<T>

Get a subset of data starting with a given branchName

open fun close()

Stop generating updates from this DataSource

computeAndJoinAll

suspend fun <T : Any> DataSet<T>.computeAndJoinAll()

abstract fun data(name: Name, data: Data<T>?)

fun <T : Any> DataSetBuilder<T>.data(name: String, value: Data<T>)

inline fun <T : Any> DataSourceBuilder<T>.emit(name: String, parent: CoroutineScope, noinline block: DataSourceBuilder<T>.() -> Unit)

inline fun <T : Any> DataSourceBuilder<T>.emit(name: Name, parent: CoroutineScope, noinline block: DataSourceBuilder<T>.() -> Unit)

fun <T : Any> DataSet<T>.filter(predicate: (Name, Meta) -> Boolean): DataSource<T>

A stateless filtered DataSet

inline fun <R : Any> DataSet<*>.filterByType(noinline predicate: (name: Name, meta: Meta) -> Boolean = { _, _ -> true }): DataSet<R>

Select a single datum of the appropriate type

fun <R : Any> DataSet<*>.filterByType(type: KType, predicate: (name: Name, meta: Meta) -> Boolean = { _, _ -> true }): DataSource<R>

Select all data matching given type and filters. Does not modify paths

inline fun <T : Any, R : Any> DataSet<T>.foldToData(initial: R, coroutineContext: CoroutineContext = EmptyCoroutineContext, meta: Meta = Meta.EMPTY, crossinline block: suspend (result: R, data: NamedValueWithMeta<T>) -> R): Data<R>

inline fun <T : Any> DataSet<T>.forEach(block: (NamedData<T>) -> Unit)

abstract operator fun get(name: Name): Data<T>?

Get data with given name.

operator fun <T : Any> DataSet<T>.get(name: String): Data<T>?

inline fun <R : Any> DataSet<*>.getByType(name: String): NamedData<R>?

inline fun <R : Any> DataSet<*>.getByType(name: Name): NamedData<R>?

fun <R : Any> DataSet<*>.getByType(type: KType, name: Name): NamedData<R>?

Select a single datum if it is present and of given type

abstract operator fun iterator(): Iterator<NamedData<T>>

Traverse this DataSet returning named data instances. The order is not guaranteed.

inline suspend fun <T : Any, R : Any> DataSet<T>.map(coroutineContext: CoroutineContext = EmptyCoroutineContext, noinline metaTransform: MutableMeta.() -> Unit = {}, noinline block: suspend (NamedValueWithMeta<T>) -> R): DataTree<R>

suspend fun <T : Any, R : Any> DataSet<T>.map(outputType: KType, coroutineContext: CoroutineContext = EmptyCoroutineContext, metaTransform: MutableMeta.() -> Unit = {}, block: suspend (NamedValueWithMeta<T>) -> R): DataTree<R>

abstract fun meta(name: Name, meta: Meta)

Set meta for the given node

fun <T : Any> DataSetBuilder<T>.meta(mutableMeta: MutableMeta.() -> Unit)

fun <T : Any> DataSetBuilder<T>.meta(value: Meta)

Define meta in this DataSet

open fun node(name: Name, dataSet: DataSet<T>)

Set a current state of given dataSet into a branch name. Does not propagate updates

inline fun <T : Any> DataSetBuilder<T>.node(name: String, crossinline block: DataSetBuilder<T>.() -> Unit)

fun <T : Any> DataSetBuilder<T>.node(name: String, set: DataSet<T>)

inline fun <T : Any> DataSetBuilder<T>.node(name: Name, crossinline block: DataSetBuilder<T>.() -> Unit)

fun <T : Any> DataSetBuilder<T>.populateFrom(sequence: Sequence<NamedData<T>>)

fun <T : Any> DataSetBuilder<T>.populateFrom(tree: DataSet<T>)

Update data with given node data and meta with node meta.

inline fun <T : Any> DataSetBuilder<T>.produce(name: String, meta: Meta = Meta.EMPTY, noinline producer: suspend () -> T)

Produce lazy Data and emit it into the DataSetBuilder

inline fun <T : Any> DataSetBuilder<T>.produce(name: Name, meta: Meta = Meta.EMPTY, noinline producer: suspend () -> T)

inline fun <T : Any, R : Any> DataSet<T>.reduceToData(coroutineContext: CoroutineContext = EmptyCoroutineContext, meta: Meta = Meta.EMPTY, crossinline transformation: suspend (Iterable<NamedValueWithMeta<T>>) -> R): Data<R>

abstract fun remove(name: Name)

Remove all data items starting with name

suspend fun <T : Any> DataSet<T>.rootData(): Data<T>?

fun <T : Any> DataSet<T>.seal(): DataTree<T>

fun <T : Any> DataSetBuilder<T>.set(value: NamedData<T>)

fun <T : Any> CoroutineScope.setAndWatch(name: Name, dataSet: DataSet<T>): Job

Copy given data set and mirror its changes to this DataTreeBuilder in this@setAndObserve. Returns an update Job

fun <T : Any> DataSet<T>.single(): NamedData<T>

Return a single Data in this DataSet. Throw error if it is not single.

fun <T : Any> DataSet<T>.startAll(coroutineScope: CoroutineScope): Job

Start computation for all goals in data node and return a job for the whole node

inline fun <T : Any> DataSetBuilder<T>.static(name: String, data: T, mutableMeta: MutableMeta.() -> Unit)

inline fun <T : Any> DataSetBuilder<T>.static(name: Name, data: T, meta: Meta = Meta.EMPTY)

inline fun <T : Any> DataSetBuilder<T>.static(name: String, data: T, meta: Meta = Meta.EMPTY)

Emit a static data with the fixed value

fun DataSet<*>.toMeta(): Meta

fun <T : Any> DataSet<T>.withNamePrefix(prefix: Name): DataSet<T>

Generate a wrapper data set with a given name prefix appended to all names