org.apache.streams.local.builders

Class StreamComponent

java.lang.Object

org.apache.streams.local.builders.StreamComponent

All Implemented Interfaces:

Serializable

public class StreamComponent
extends Object
implements Serializable

Stores the implementations of StreamsOperation, the StreamsOperations it is connected to and the necessary metadata to construct a data stream.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamComponent(String id, StreamsPersistWriter writer, BlockingQueue<StreamsDatum> inQueue, int numTasks, org.apache.streams.config.StreamsConfiguration streamConfig)
StreamComponent(String id, StreamsProcessor processor, BlockingQueue<StreamsDatum> inQueue, int numTasks, org.apache.streams.config.StreamsConfiguration streamConfig)
StreamComponent(String id, StreamsProvider provider, BigInteger sequence, org.apache.streams.config.StreamsConfiguration streamConfig)
StreamComponent(String id, StreamsProvider provider, boolean perpetual, org.apache.streams.config.StreamsConfiguration streamConfig)
StreamComponent(String id, StreamsProvider provider, org.joda.time.DateTime start, org.joda.time.DateTime end, org.apache.streams.config.StreamsConfiguration streamConfig)

Method Summary

Modifier and Type	Method and Description
void	addInboundQueue(StreamComponent component) Add a component that supplies data through the inbound queue.
void	addOutBoundQueue(StreamComponent component, BlockingQueue<StreamsDatum> queue) Add an outbound queue for this component.
StreamsTask	createConnectedTask(int timeout) Creates a StreamsTask that is running a clone of this component whose inbound and outbound queues are appropriately connected to the parent and child nodes.
boolean	equals(Object o)
Collection<StreamComponent>	getDownStreamComponents() The components that are immediately downstream of this component (aka child nodes)
String	getId() The unique of this component
BlockingQueue<StreamsDatum>	getInBoundQueue() The inbound queue for this component
int	getNumTasks() The number of tasks this to run this component
protected StreamsOperation	getOperation()
List<StreamsTask>	getStreamsTasks()
Collection<StreamComponent>	getUpStreamComponents() The components that are immediately upstream of this component (aka parent nodes)
int	hashCode()
protected boolean	isOperationCountable() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamComponent

public StreamComponent(String id,
                       StreamsProvider provider,
                       boolean perpetual,
                       org.apache.streams.config.StreamsConfiguration streamConfig)

Parameters:

id -

provider -

StreamComponent

public StreamComponent(String id,
                       StreamsProvider provider,
                       org.joda.time.DateTime start,
                       org.joda.time.DateTime end,
                       org.apache.streams.config.StreamsConfiguration streamConfig)

Parameters:

id -

provider -

start -

end -

StreamComponent

public StreamComponent(String id,
                       StreamsProvider provider,
                       BigInteger sequence,
                       org.apache.streams.config.StreamsConfiguration streamConfig)

Parameters:

id -

provider -

sequence -

StreamComponent

public StreamComponent(String id,
                       StreamsProcessor processor,
                       BlockingQueue<StreamsDatum> inQueue,
                       int numTasks,
                       org.apache.streams.config.StreamsConfiguration streamConfig)

Parameters:

id -

processor -

inQueue -

numTasks -

StreamComponent

public StreamComponent(String id,
                       StreamsPersistWriter writer,
                       BlockingQueue<StreamsDatum> inQueue,
                       int numTasks,
                       org.apache.streams.config.StreamsConfiguration streamConfig)

Parameters:

id -

writer -

inQueue -

numTasks -

Method Detail

addOutBoundQueue

public void addOutBoundQueue(StreamComponent component,
                             BlockingQueue<StreamsDatum> queue)

Add an outbound queue for this component. The queue should be an inbound queue of a downstream component.

Parameters:

component - the component that this supplying their inbound queue

queue - the queue to to put post processed/provided datums on

addInboundQueue

public void addInboundQueue(StreamComponent component)

Add a component that supplies data through the inbound queue.

Parameters:

component - that supplies data through the inbound queue

getDownStreamComponents

public Collection<StreamComponent> getDownStreamComponents()

The components that are immediately downstream of this component (aka child nodes)

Returns:

Collection of child nodes of this component

getUpStreamComponents

public Collection<StreamComponent> getUpStreamComponents()

The components that are immediately upstream of this component (aka parent nodes)

Returns:

Collection of parent nodes of this component

getInBoundQueue

public BlockingQueue<StreamsDatum> getInBoundQueue()

The inbound queue for this component

Returns:

inbound queue

getNumTasks

public int getNumTasks()

The number of tasks this to run this component

Returns:

createConnectedTask

public StreamsTask createConnectedTask(int timeout)

Creates a StreamsTask that is running a clone of this component whose inbound and outbound queues are appropriately connected to the parent and child nodes.

Parameters:

timeout - The timeout to use in milliseconds for any tasks that support configurable timeout

Returns:

StreamsTask for this component

getStreamsTasks

public List<StreamsTask> getStreamsTasks()

getId

public String getId()

The unique of this component

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getOperation

protected StreamsOperation getOperation()

isOperationCountable

@Deprecated
protected boolean isOperationCountable()

Deprecated.