diva.pod

Interface Generator

All Superinterfaces:

PropertyContainer

public interface Generator
extends PropertyContainer

A Generator is an object that generates data. Generators might generate data incrementally, such a web crawler, or a running simulation. Or, they might simply represent an existing store of data and generate that data into a protocol.

It is possible for objects to implement both the Generator and Pod interfaces. This would be used for Pods that have the generator-like property of producing data.

Generators can have string-named properties attached to them.

Version:

$Revision: 1.1 $

Author:

John Reekie

Method Summary

Modifier and Type	Method and Description
boolean	getEnabled() Get the flag that says whether the generator is enabled.
Transmitter	getTransmitter(Protocol p, HashMap properties) Get a transmitter of the given protocol from the Generator.
void	setEnabled(boolean enabled) Enable or disable the generator.

Methods inherited from interface diva.util.PropertyContainer

getProperty, propertyNames, setProperty

Method Detail

getEnabled

boolean getEnabled()

Get the flag that says whether the generator is enabled.

getTransmitter

Transmitter getTransmitter(Protocol p,
                           HashMap properties)

Get a transmitter of the given protocol from the Generator. Null if the protocol is not supported by the pod, or if the Pod is unable to create more transmitters (some Pods, for example, may be able to create only a single transmitter). The properties hash map, if supplied, can be used in a protocol-specific way to place constraints on the selection of a transmitter.

setEnabled

void setEnabled(boolean enabled)

Enable or disable the generator. By default, generators should start off disabled, so that clients can make the necessary connections before the generator starts producing data.