com.tibco.as.space.browser

Class EventBrowserDef

java.lang.Object

com.tibco.as.space.browser.EventBrowserDef

public abstract class EventBrowserDef
extends java.lang.Object

The EventBrowserDef object is used to define the characteristics of an EventBrowser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventBrowserDef.DistributionScope Enumeration of the possible ways to browse for events in a Space based upon where entries are stored in the space.
static class	EventBrowserDef.TimeScope Enumeration of the possible ways to browse for events in a Space based upon the time at which the entries, for which the events occur, were stored in the Space relative to the EventBrowser creation time.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_WAIT Calls to the EventBrowser's next() method will return immediately if no events are left to iterate over.
static int	WAIT_FOREVER Calls to the EventBrowser's next() method will block endlessly waiting for more events to iterate over.

Constructor Summary

Constructors

Constructor and Description
EventBrowserDef()

Method Summary

Modifier and Type	Method and Description
static EventBrowserDef	create() Instantiate a new EventBrowserDef instance.
static EventBrowserDef	create(long timeout) Instantiate a new EventBrowserDef instance with the specified timeout.
static EventBrowserDef	create(long timeout, EventBrowserDef.TimeScope timeScope) Instantiate a new EventBrowserDef instance with the specified timeout and time scope settings.
static EventBrowserDef	create(long timeout, EventBrowserDef.TimeScope timeScope, EventBrowserDef.DistributionScope distributionScope) Instantiate a new EventBrowserDef instance with the specified timeout, time scope, and distribution scope settings.
abstract EventBrowserDef.DistributionScope	getDistributionScope() Retrieve the distribution scope setting of the EventBrowser.
abstract long	getQueryLimit() Retrieve the query limit setting of the event browser.
abstract long	getTimeout() Retrieve the timeout setting of the EventBrowser.
abstract EventBrowserDef.TimeScope	getTimeScope() Retrieve the time scope setting of the EventBrowser.
abstract EventBrowserDef	setDistributionScope(EventBrowserDef.DistributionScope distributionScope) Sets the distribution scope associated with the EventBrowser.
abstract EventBrowserDef	setQueryLimit(long limit)
abstract EventBrowserDef	setTimeout(long timeout) Sets the timeout value associated with the EventBrowser.
abstract EventBrowserDef	setTimeScope(EventBrowserDef.TimeScope timeScope) Sets the time scope associated with the EventBrowser.

Methods inherited from class java.lang.Object

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

Field Detail

NO_WAIT

public static int NO_WAIT

Calls to the EventBrowser's next() method will return immediately if no events are left to iterate over.

WAIT_FOREVER

public static int WAIT_FOREVER

Calls to the EventBrowser's next() method will block endlessly waiting for more events to iterate over.

Constructor Detail

EventBrowserDef

public EventBrowserDef()

Method Detail

create

public static EventBrowserDef create()

Instantiate a new EventBrowserDef instance.

Returns:

The new EventBrowserDef instance.

create

public static EventBrowserDef create(long timeout)

Instantiate a new EventBrowserDef instance with the specified timeout.

Parameters:

timeout - Number of milliseconds the next() method should block waiting for more events.

Returns:

The new EventBrowserDef instance.

create

public static EventBrowserDef create(long timeout,
                                     EventBrowserDef.TimeScope timeScope)

Instantiate a new EventBrowserDef instance with the specified timeout and time scope settings.

Parameters:

timeout - Number of milliseconds the next() method should block waiting for more events.

timeScope - An enumeration which specifies how to browse for events in the Space based upon the time at which the entries, for which the events occur, were stored in the space relative to the EventBrowser creation time.

Returns:

The new EventBrowserDef instance.

create

public static EventBrowserDef create(long timeout,
                                     EventBrowserDef.TimeScope timeScope,
                                     EventBrowserDef.DistributionScope distributionScope)

Instantiate a new EventBrowserDef instance with the specified timeout, time scope, and distribution scope settings.

Parameters:

timeout - Number of milliseconds the next() method should block waiting for more events.

timeScope - An enumeration which specifies how to browse for events in the Space based upon the time at which the entries, for which the events occur, were stored in the space relative to the EventBrowser creation time.

distributionScope - An enumeration which specifies how to browse for events in the Space based upon where the entries, for which the events occur, are stored in the space.

Returns:

The new EventBrowserDef instance.

getTimeScope

public abstract EventBrowserDef.TimeScope getTimeScope()

Retrieve the time scope setting of the EventBrowser.

Returns:

The EventBrowserDef.TimeScope enumeration setting of the EventBrowser.

getDistributionScope

public abstract EventBrowserDef.DistributionScope getDistributionScope()

Retrieve the distribution scope setting of the EventBrowser.

Returns:

The EventBrowserDef.DistributionScope enumeration setting of the EventBrowser.

getTimeout

public abstract long getTimeout()

Retrieve the timeout setting of the EventBrowser.

Returns:

The timeout in milliseconds.

setTimeout

public abstract EventBrowserDef setTimeout(long timeout)

Sets the timeout value associated with the EventBrowser. Default is NO_WAIT.

Parameters:

timeout - Number of milliseconds the next() method should block waiting for more events.

Returns:

This EventBrowserDef instance.

setDistributionScope

public abstract EventBrowserDef setDistributionScope(EventBrowserDef.DistributionScope distributionScope)

Sets the distribution scope associated with the EventBrowser. Default is ALL.

Parameters:

distributionScope - An enumeration which specifies how to browse for events in the Space based upon where the entries, for which the events occur, are stored in the space.

Returns:

This EventBrowserDef instance.

setTimeScope

public abstract EventBrowserDef setTimeScope(EventBrowserDef.TimeScope timeScope)

Sets the time scope associated with the EventBrowser. Default is ALL.

Parameters:

timeScope - An enumeration which specifies how to browse for events in the Space based upon the time at which the entries, for which the events occur, were stored in the space relative to the EventBrowser creation time.

Returns:

This EventBrowserDef instance.

setQueryLimit

public abstract EventBrowserDef setQueryLimit(long limit)

Parameters:

limit - The number of initial events to get from the Space.

Returns:

This EventBrowserDef instance.

getQueryLimit

public abstract long getQueryLimit()

Retrieve the query limit setting of the event browser.

Returns:

The query limit of the event browser to retrieve initial values from the Space.