BaseWindowedSink

java.lang.Object
- edu.iu.dsc.tws.api.compute.nodes.BaseNode
- - edu.iu.dsc.tws.task.window.api.BaseWindowSink<T>
  - - edu.iu.dsc.tws.task.window.core.AbstractSingleWindowDataSink<T>
    - - edu.iu.dsc.tws.task.window.core.BaseWindowedSink<T>

All Implemented Interfaces:

Closable, ICompute<T>, INode, IWindowedSink<T>, IWindowCompute<T>, java.io.Serializable

Direct Known Subclasses:

AggregateWindow, FoldWindow, ProcessWindow, ReduceWindow, STWindowCustomExample.DirectCustomWindowReceiver, STWindowEventTimeExample.DirectWindowedReceivingTask, STWindowExample.DirectWindowedReceivingTask, STWindowMPI.DirectWindowedReceivingTask, WindowComputeOp
```
public abstract class BaseWindowedSink<T>
extends AbstractSingleWindowDataSink<T>
implements IWindowCompute<T>, Closable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected WindowConfig.Duration`	`allowedLateness`
`protected IWindowMessage<T>`	`collectiveEvents`
`protected T`	`collectiveOutput`
`protected static long`	`DEFAULT_MAX_LAG`
`protected static long`	`DEFAULT_WATERMARK_INTERVAL`
`protected IEvictionPolicy<T>`	`evictionPolicy`
`protected ITimestampExtractor<T>`	`iTimestampExtractor`
`protected IWindow`	`iWindow`
`protected long`	`maxLagMs`
`protected WatermarkEventGenerator<T>`	`watermarkEventGenerator`
`protected WindowConfig.Duration`	`watermarkInterval`
`protected IWindowingPolicy<T>`	`windowingPolicy`
`protected WindowLifeCycleListener<T>`	`windowLifeCycleListener`
`protected WindowManager<T>`	`windowManager`
`protected WindowParameter`	`windowParameter`

Fields inherited from class edu.iu.dsc.tws.api.compute.nodes.BaseNode
config, context

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseWindowedSink()

Constructors
Modifier	Constructor and Description
`protected`	`BaseWindowedSink()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close method for cleaning up the resources
`boolean`	`execute(IMessage<T> message)` Execute with an incoming message
`abstract boolean`	`execute(IWindowMessage<T> windowMessage)`
`IEvictionPolicy<T>`	`getEvictionPolicy(WindowConfig.Count windowLengthCount, WindowConfig.Duration windowLengthDuration)`
`abstract boolean`	`getExpire(IWindowMessage<T> expiredMessages)`
`abstract boolean`	`getLateMessages(IMessage<T> lateMessages)`
`IWindowingPolicy<T>`	`getWindowingPolicy(WindowConfig.Count slidingIntervalCount, WindowConfig.Duration slidingIntervalDuration, WindowManager<T> manager, IEvictionPolicy<T> policy)`
`void`	`initialize(TaskContext context)`
`protected boolean`	`isTimestamped()`
`protected WindowLifeCycleListener<T>`	`newWindowLifeCycleListener()`
`void`	`prepare(Config cfg, TaskContext ctx)` Prepare the task to be executed
`void`	`reset()` Reset the task
`void`	`setPolicies(IWindowStrategy<T> windowStrategy)`
`void`	`start()`
`BaseWindowedSink<T>`	`withAllowedLateness(long lateness, java.util.concurrent.TimeUnit timeUnit)`
`BaseWindowedSink<T>`	`withCustomTimestampExtractor(ITimestampExtractor timestampExtractor)`
`BaseWindowedSink<T>`	`withSlidingCountWindow(long windowCount, long slidingCount)`
`BaseWindowedSink<T>`	`withSlidingDurationWindow(long windowDuration, java.util.concurrent.TimeUnit windowTU, long slidingDuration, java.util.concurrent.TimeUnit slidingTU)`
`BaseWindowedSink<T>`	`withTimestampExtractor()`
`BaseWindowedSink<T>`	`withTumblingCountWindow(long tumblingCount)`
`BaseWindowedSink<T>`	`withTumblingDurationWindow(long tumblingDuration, java.util.concurrent.TimeUnit timeUnit)`
`BaseWindowedSink<T>`	`withWatermarkInterval(long watermarkInt, java.util.concurrent.TimeUnit timeUnit)`
`BaseWindowedSink<T>`	`withWindow(IWindow window)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.iu.dsc.tws.api.compute.nodes.ICompute
endExecute

Field Detail

DEFAULT_WATERMARK_INTERVAL
```
protected static final long DEFAULT_WATERMARK_INTERVAL
```
See Also:

Constant Field Values

DEFAULT_MAX_LAG
```
protected static final long DEFAULT_MAX_LAG
```
See Also:

Constant Field Values

maxLagMs
```
protected long maxLagMs
```

watermarkInterval

protected WindowConfig.Duration watermarkInterval

allowedLateness

protected WindowConfig.Duration allowedLateness

windowManager

protected WindowManager<T> windowManager

windowingPolicy

protected IWindowingPolicy<T> windowingPolicy

windowParameter

protected WindowParameter windowParameter

windowLifeCycleListener

protected WindowLifeCycleListener<T> windowLifeCycleListener

evictionPolicy

protected IEvictionPolicy<T> evictionPolicy

iWindow
```
protected IWindow iWindow
```

collectiveOutput
```
protected T collectiveOutput
```

collectiveEvents

protected IWindowMessage<T> collectiveEvents

iTimestampExtractor

protected ITimestampExtractor<T> iTimestampExtractor

watermarkEventGenerator

protected WatermarkEventGenerator<T> watermarkEventGenerator

Constructor Detail
- BaseWindowedSink
```
protected BaseWindowedSink()
```

Method Detail

execute

public abstract boolean execute(IWindowMessage<T> windowMessage)

getExpire

public abstract boolean getExpire(IWindowMessage<T> expiredMessages)

getLateMessages

public abstract boolean getLateMessages(IMessage<T> lateMessages)

prepare
```
public void prepare(Config cfg,
                    TaskContext ctx)
```
Description copied from interface: INode

Prepare the task to be executed

Specified by:

prepare in interface INode

Overrides:

prepare in class BaseNode

Parameters:

cfg - the configuration

ctx - the task context, this has runtime information about the task

initialize

public void initialize(TaskContext context)

execute
```
public boolean execute(IMessage<T> message)
```
Description copied from interface: ICompute

Execute with an incoming message

Specified by:

execute in interface ICompute<T>

Specified by:

execute in interface IWindowedSink<T>

Specified by:

execute in interface IWindowCompute<T>

withTumblingCountWindow

public BaseWindowedSink<T> withTumblingCountWindow(long tumblingCount)

withTumblingDurationWindow

public BaseWindowedSink<T> withTumblingDurationWindow(long tumblingDuration,
                                                      java.util.concurrent.TimeUnit timeUnit)

withSlidingCountWindow

public BaseWindowedSink<T> withSlidingCountWindow(long windowCount,
                                                  long slidingCount)

withSlidingDurationWindow

public BaseWindowedSink<T> withSlidingDurationWindow(long windowDuration,
                                                     java.util.concurrent.TimeUnit windowTU,
                                                     long slidingDuration,
                                                     java.util.concurrent.TimeUnit slidingTU)

withCustomTimestampExtractor

public BaseWindowedSink<T> withCustomTimestampExtractor(ITimestampExtractor timestampExtractor)

withTimestampExtractor

public BaseWindowedSink<T> withTimestampExtractor()

withAllowedLateness

public BaseWindowedSink<T> withAllowedLateness(long lateness,
                                               java.util.concurrent.TimeUnit timeUnit)

withWatermarkInterval

public BaseWindowedSink<T> withWatermarkInterval(long watermarkInt,
                                                 java.util.concurrent.TimeUnit timeUnit)

withWindow

public BaseWindowedSink<T> withWindow(IWindow window)

newWindowLifeCycleListener

protected WindowLifeCycleListener<T> newWindowLifeCycleListener()

getWindowingPolicy

public IWindowingPolicy<T> getWindowingPolicy(WindowConfig.Count slidingIntervalCount,
                                              WindowConfig.Duration slidingIntervalDuration,
                                              WindowManager<T> manager,
                                              IEvictionPolicy<T> policy)

getEvictionPolicy

public IEvictionPolicy<T> getEvictionPolicy(WindowConfig.Count windowLengthCount,
                                            WindowConfig.Duration windowLengthDuration)

setPolicies

public void setPolicies(IWindowStrategy<T> windowStrategy)

start
```
public void start()
```

close
```
public void close()
```
Description copied from interface: Closable

Close method for cleaning up the resources

Specified by:

close in interface Closable

Overrides:

close in class BaseNode

reset
```
public void reset()
```
Description copied from interface: Closable

Reset the task

Specified by:

reset in interface Closable

Overrides:

reset in class BaseNode

isTimestamped
```
protected boolean isTimestamped()
```

Class BaseWindowedSink<T>

Field Summary

Fields inherited from class edu.iu.dsc.tws.api.compute.nodes.BaseNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface edu.iu.dsc.tws.api.compute.nodes.ICompute

Field Detail

DEFAULT_WATERMARK_INTERVAL

DEFAULT_MAX_LAG

maxLagMs

watermarkInterval

allowedLateness

windowManager

windowingPolicy

windowParameter

windowLifeCycleListener

evictionPolicy

iWindow

collectiveOutput

collectiveEvents

iTimestampExtractor

watermarkEventGenerator

Constructor Detail

BaseWindowedSink

Method Detail

execute

getExpire

getLateMessages

prepare

initialize

execute

withTumblingCountWindow

withTumblingDurationWindow

withSlidingCountWindow

withSlidingDurationWindow

withCustomTimestampExtractor

withTimestampExtractor

withAllowedLateness

withWatermarkInterval

withWindow

newWindowLifeCycleListener

getWindowingPolicy

getEvictionPolicy

setPolicies

start

close

reset

isTimestamped