Package org.marketcetera.modules.headwater

Class HeadwaterModule

java.lang.Object

org.marketcetera.module.Module

org.marketcetera.modules.headwater.HeadwaterModule

All Implemented Interfaces:

DataEmitter

public class HeadwaterModule
extends Module
implements DataEmitter

Provides an insertion point to a module framework data flow.

Module Features

Headwater Module Attributes

Capabilities	Data Emitter
DataFlow Request Parameters	none
Stops data flows	n/a
Start Operation	n/a
Stop Operation	n/a
Management Interface	n/a
Factory	HeadwaterModuleFactory

Since:

$Release$

Version:

$Id$

Author:

Colin DuPlantis

Field Summary

Fields

Modifier and Type	Field	Description
private Map<DataFlowID,DataEmitterSupport>	dataSupport	if wired into a multi-module flow, this object will assist in passing data to the next object in the flow
private static Map<String,HeadwaterModule>	instances	tracks all module instances

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeadwaterModule(ModuleURN inUrn, String inInstanceName)	Create a new HeadwaterModule instance.

Method Summary

Modifier and Type	Method	Description
void	cancel(DataFlowID inFlowID, RequestID inRequestID)
static ModuleURN	createHeadwaterModule(String inHeadwaterInstance, ModuleManager inModuleManager)	Create a headwater module.
void	emit(Object inData, DataFlowID... inDataFlowIds)	Emit the given data to the given data flows, if specified.
static HeadwaterModule	getInstance(String inInstanceName)	Get a HeadwaterInstance instance, creating it if necessary.
protected void	preStart()
protected void	preStop()
void	requestData(DataRequest inRequest, DataEmitterSupport inSupport)

Methods inherited from class org.marketcetera.module.Module

getCreated, getLastStartFailure, getLastStopFailure, getStarted, getState, getStopped, getURN, isAutoCreated, isAutoStart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dataSupport

private final Map<DataFlowID,DataEmitterSupport> dataSupport

if wired into a multi-module flow, this object will assist in passing data to the next object in the flow

instances

private static final Map<String,HeadwaterModule> instances

tracks all module instances

Constructor Detail

HeadwaterModule

protected HeadwaterModule(ModuleURN inUrn,
                          String inInstanceName)

Create a new HeadwaterModule instance.

Parameters:

inUrn - a ModuleURN value

inInstanceName - a String value

Method Detail

getInstance

public static HeadwaterModule getInstance(String inInstanceName)

Get a HeadwaterInstance instance, creating it if necessary.

Parameters:

inInstanceName - a String value

Returns:

a HeadwaterModule value

createHeadwaterModule

public static ModuleURN createHeadwaterModule(String inHeadwaterInstance,
                                              ModuleManager inModuleManager)

Create a headwater module.

Parameters:

inHeadwaterInstance - a String value

inModuleManager - a ModuleManager value

Returns:

a ModuleURN value

emit

public void emit(Object inData,
                 DataFlowID... inDataFlowIds)

Emit the given data to the given data flows, if specified.

If no data flows are specified, the data is emitted to all data flows in which this module participates.

Parameters:

inData - an Object value

inDataFlowIds - a DataFlowID[] value or null

requestData

public void requestData(DataRequest inRequest,
                        DataEmitterSupport inSupport)
                 throws RequestDataException

Specified by:

requestData in interface DataEmitter

Throws:

RequestDataException

cancel

public void cancel(DataFlowID inFlowID,
                   RequestID inRequestID)

Specified by:

cancel in interface DataEmitter

preStart

protected void preStart()
                 throws ModuleException

Specified by:

preStart in class Module

Throws:

ModuleException

preStop

protected void preStop()
                throws ModuleException

Specified by:

preStop in class Module

Throws:

ModuleException