Package space.kscience.dataforge.context

Types

AbstractPlugin

common

abstract class AbstractPlugin(meta: Meta) : Plugin

ClassLoaderPlugin

jvm

class ClassLoaderPlugin(classLoader: ClassLoader) : AbstractPlugin

ConsoleLogManager

class ConsoleLogManager : AbstractPlugin, LogManager

Context

common

open class Context : Named, MetaRepr, Provider, CoroutineScope

The local environment for anything being done in DataForge framework. Contexts are organized into tree structure with Global at the top. Context has properties - equivalent for system environment values, but grouped into a tree and inherited from parent context.

ContextAware

common

interface ContextAware

The interface for something that encapsulated in context

ContextBuilder

common

class ContextBuilder

A convenience builder for context

DefaultLogManager

common

class DefaultLogManager : AbstractPlugin, LogManager

Factory

common

interface Factory<out T : Any>

Logger

common

fun interface Logger

LogManager

common

interface LogManager : Plugin, Logger

Plugin

common

@Type(id = "plugin")

interface Plugin : Named, ContextAware, Provider, MetaRepr

The interface to define a Context plugin. A plugin stores all runtime features of a context. The plugin is by default configurable and a Provider (both features could be ignored). The plugin must in most cases have an empty constructor in order to be able to load it from library.

PluginFactory

common

@Type(id = "pluginFactory")

interface PluginFactory<T : Plugin> : Factory<T>

PluginManager

common

class PluginManager : ContextAware, Iterable<Plugin>

The manager for plugin system. Should monitor plugin dependencies and locks.

PluginTag

common

data class PluginTag(name: String, group: String, version: String) : MetaRepr

The tag which contains information about name, group and version of some object. It also could contain any complex rule to define version ranges

SlfLogManager

jvm

class SlfLogManager : AbstractPlugin, LogManager

Functions

Context

common

fun Context(name: String? = null, block: ContextBuilder.() -> Unit = {}): Context

debug

common

fun Logger.debug(body: () -> String)

error

common

fun Logger.error(body: () -> String)

fun Logger.error(throwable: Throwable?, body: () -> String)

fetch

common

inline fun <T : Plugin> Context.fetch(factory: PluginFactory<T>, meta: Meta = Meta.EMPTY): T

Fetch a plugin with given meta from the context. If the plugin (with given meta) is already registered, it is returned. Otherwise, new child context with the plugin is created. In the later case the context could be retrieved from the plugin.

gather

common

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

fun <T : Any> Context.gather(target: String, type: KClass<out T>, inherit: Boolean = true): Map<Name, T>

Gather a map of all top-level objects with given target from context plugins. Content from plugins is prefixed by plugin name so name conflicts are impossible This operation could be slow in case of large number of plugins

gatherInSequence

common