annotate artifacts/src/main/java/de/intevation/artifacts/DataProvider.java @ 352:9c8d91708d28

Added DataProvider interface (interface for inter-facet communication). artifacts/trunk@3330 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Wed, 30 Nov 2011 08:20:15 +0000
parents
children ab3900303f25
rev   line source
352
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
1 package de.intevation.artifacts;
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
2
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
3 import de.intevation.artifacts.CallContext;
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
4
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
5 /**
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
6 * DataProviders register on a Blackboard with a key (basically shouting
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
7 * "I can or know X!").
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
8 *
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
9 * Consumers look at the blackboard and then consume data from these
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
10 * DataProvider, passing them (optional) parameterization and the blackboard
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
11 * itself.
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
12 *
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13 * Through the blackboard-passing-when-consuming, also recursive patterns can
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14 * be modelled (but take care, there is no in-built cycle detection).
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15 */
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
16 public interface DataProvider {
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
17 /** Register this DataProvider on a blackboard under a key. */
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
18 public void register(CallContext blackboard);
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
19
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
20 /** Provide data, given parameterization and a "blackboard". */
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
21 public Object provideData(Object key, Object param, CallContext context);
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
22 }
9c8d91708d28 Added DataProvider interface (interface for inter-facet communication).
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
23 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org