stream.io

Class TimeStream

java.lang.Object

stream.io.AbstractStream

stream.io.TimeStream

All Implemented Interfaces:

Source, Stream

public class TimeStream
extends AbstractStream

Author:

chris

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Long	gap
(package private) String	interval
(package private) String	key
(package private) long	last

Fields inherited from class stream.io.AbstractStream

closed, count, id, in, limit, log, prefix, seqId, sequenceKey, url

Fields inherited from interface stream.io.Stream

SOURCE_KEY

Constructor Summary

Constructors

Constructor and Description
TimeStream()

Method Summary

Modifier and Type	Method and Description
String	getInterval()
String	getKey()
Data	readNext()
void	setInterval(String interval)
void	setKey(String key)

Methods inherited from class stream.io.AbstractStream

close, getId, getInputStream, getLimit, getPrefix, getSequenceKey, getUrl, init, read, setId, setLimit, setPrefix, setSequenceKey, setUrl

Methods inherited from class java.lang.Object

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

Field Detail

key

String key

interval

String interval

gap

Long gap

last

long last

Constructor Detail

TimeStream

public TimeStream()

Parameters:

url -

Method Detail

getInterval

public String getInterval()

Returns:

the interval

setInterval

@Parameter(description="The time gap/rate at which this stream should provide items.",
           required=true)
public void setInterval(String interval)

Parameters:

interval - the interval to set

getKey

public String getKey()

Returns:

the key

setKey

@Parameter(description="The name of the attribute that should hold the timestamp, defaults to `@timestamp`",
           required=false)
public void setKey(String key)

Parameters:

key - the key to set

readNext

public Data readNext()
              throws Exception

Specified by:

readNext in class AbstractStream

Throws:

Exception

See Also:

stream.io.AbstractStream#readItem(stream.Data)