io.druid.segment.realtime.firehose

Class ClippedFirehoseFactory

java.lang.Object

io.druid.segment.realtime.firehose.ClippedFirehoseFactory

All Implemented Interfaces:

FirehoseFactory

public class ClippedFirehoseFactory
extends Object
implements FirehoseFactory

Creates firehoses clipped to a particular time interval. Useful for enforcing min time, max time, and time windows.

Constructor Summary

Constructors

Constructor and Description
ClippedFirehoseFactory(FirehoseFactory delegate, org.joda.time.Interval interval)

Method Summary

Modifier and Type	Method and Description
Firehose	connect(InputRowParser parser, File temporaryDirectory) Initialization method that connects up the fire hose.
FirehoseFactory	getDelegate()
org.joda.time.Interval	getInterval()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.druid.data.input.FirehoseFactory

connect

Constructor Detail

ClippedFirehoseFactory

public ClippedFirehoseFactory(FirehoseFactory delegate,
                              org.joda.time.Interval interval)

Method Detail

getDelegate

public FirehoseFactory getDelegate()

getInterval

public org.joda.time.Interval getInterval()

connect

public Firehose connect(InputRowParser parser,
                        File temporaryDirectory)
                 throws IOException

Description copied from interface: FirehoseFactory

Initialization method that connects up the fire hose. If this method returns successfully it should be safe to call hasMore() on the returned Firehose (which might subsequently block).

If this method returns null, then any attempt to call hasMore(), nextRow(), commit() and close() on the return value will throw a surprising NPE. Throwing IOException on connection failure or runtime exception on invalid configuration is preferred over returning null.

Some fire hoses like PrefetchableTextFilesFirehoseFactory may use a temporary directory to cache data in it.

Specified by:

connect in interface FirehoseFactory

Parameters:

parser - an input row parser

temporaryDirectory - a directory where temporary files are stored

Throws:

IOException