API for dataflow - clojure-contrib v1.2 (stable)

by Jeffrey Straszheim

clojure-contrib is now deprecated

clojure-contrib is no longer being developed or maintained.

Rather than a single, monolithic, contributions library, Clojure now has a set of separate libraries for each unit of functionality. The libraries are in the Clojure GitHub organization at https://github.com/clojure. API documentation of the libraries can be found at http://clojure.github.io.

If you're looking for a specific function or namespace from the old clojure-contrib, see "Where Did Clojure.Contrib Go".


Full namespace name: clojure.contrib.dataflow

Overview

A library to support a dataflow model of state

Public Variables and Functions



add-cell-watcher

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (add-cell-watcher cell key fun)
Adds a watcher to a cell to respond to changes of value.  The is a
function of 4 values: a key, the cell, its old value, its new
value.  This is implemented using Clojure's add-watch to the
underlying ref, and shared its sematics
Source


add-cells

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (add-cells df cells)
Given a collection of cells, add them to the dataflow.
Source


build-dataflow

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (build-dataflow cs)
Given a collection of cells, build and return a dataflow object
Source


build-source-cell

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (build-source-cell name init)
Builds a source cell
Source


build-standard-cell

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (build-standard-cell name deps fun expr)
Builds a standard cell
Source


build-validator-cell

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (build-validator-cell deps fun expr)
Builds a validator cell
Source


cell

macro
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (cell type & data)
Build a standard cell, like this:

 (cell fred
    (* ?mary ?joe))

Which creates a cell named fred that is the product of a cell mary and cell joe

Or:

 (cell joe
   (apply * ?*sally))

Which creates a cell that applies * to the collection of all cells named sally

Or:

 (cell :source fred 0)

Which builds a source cell fred with initial value 0

Or:

  (cell :validator (when (< ?fred ?sally)
                       (throwf "%s must be greater than %s" ?fred ?sally))

Which will perform the validation
Source


display-cell

multimethod
This library, clojure-contrib, is deprecated. See here for more information.
No usage documentation available
A 'readable' form of the cell
Source


eval-cell

multimethod
This library, clojure-contrib, is deprecated. See here for more information.
No usage documentation available
Evaluate a dataflow cell.  Return [changed, old val]
Source


get-cell

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-cell df name)
Get the single cell named by name
Source


get-cells

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-cells df name)
Get all the cells named by name
Source


get-old-value

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-old-value df env name)
Looks up an old value
Source


get-source-cells

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-source-cells df)
Returns a collection of source cells from the dataflow
Source


get-value

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-value df name)
Gets a value from the df matching the passed symbol.
Signals an error if the name is not present, or if it not a single
value.
Source


get-value-from-cell

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-value-from-cell cell)
Given a cell, get its value
Source


get-values

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (get-values df name)
Gets a collection of values from the df by name
Source


print-dataflow

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (print-dataflow df)
Prints a dataflow, one cell per line
Source


remove-cells

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (remove-cells df cells)
Given a collection of cells, remove them from the dataflow.
Source


source-cell?

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (source-cell? cell)
Is this cell a source cell?
Source


update-values

function
This library, clojure-contrib, is deprecated. See here for more information.
Usage: (update-values df data)
Given a dataflow, and a map of name-value pairs, update the
dataflow by binding the new values.  Each name must be of a source
cell
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.