com.tibco.as.space.browser

Class BrowserDef

java.lang.Object

com.tibco.as.space.browser.BrowserDef

public abstract class BrowserDef
extends java.lang.Object

The BrowserDef object is used to define the characteristics of a Browser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrowserDef.BrowserType Enumeration of the different Browser types possible.
static class	BrowserDef.DistributionScope Enumeration of the possible ways to browse for entries in a Space based upon where entries are stored in the space.
static class	BrowserDef.TimeScope Enumeration of the possible ways to browse for entries in a Space based upon the time at which entries were stored in the space relative to the Browser creation time.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_WAIT Calls to the Browser's next() method will return immediately if no entries are left to iterate over.
static long	PREFETCH_ALL Prefetch all of the entries available in the Space.
static int	WAIT_FOREVER Calls to the Browser's next() method will block endlessly waiting for more entries to iterate over.

Constructor Summary

Constructors

Constructor and Description
BrowserDef()

Method Summary

Methods

Modifier and Type	Method and Description
static BrowserDef	create() Instantiate a new BrowserDef instance.
static BrowserDef	create(long timeout) Instantiate a new BrowserDef instance with the specified timeout.
static BrowserDef	create(long timeout, BrowserDef.TimeScope timeScope) Instantiate a new BrowserDef instance with the specified timeout and time scope settings.
static BrowserDef	create(long timeout, BrowserDef.TimeScope timeScope, BrowserDef.DistributionScope distributionScope) Instantiate a new BrowserDef instance with the specified timeout, time scope, and distribution scope settings.
abstract BrowserDef.DistributionScope	getDistributionScope() Retrieve the distribution scope setting of the Browser.
abstract long	getPrefetch() Retrieve the prefetch setting of the Browser.
abstract long	getQueryLimit() Retrieve the query limit setting of the Browser.
abstract long	getTimeout() Retrieve the timeout setting of the Browser.
abstract BrowserDef.TimeScope	getTimeScope() Retrieve the time scope setting of the Browser.
abstract boolean	isRoute()
abstract BrowserDef	setDistributionScope(BrowserDef.DistributionScope distributionScope) Sets the distribution scope associated with the Browser.
abstract BrowserDef	setPrefetch(long count)
abstract BrowserDef	setQueryLimit(long limit)
abstract BrowserDef	setRoute(boolean doRoute)
abstract BrowserDef	setTimeout(long timeout) Sets the timeout value associated with the Browser.
abstract BrowserDef	setTimeScope(BrowserDef.TimeScope timeScope) Sets the time scope associated with the Browser.

Methods inherited from class java.lang.Object

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

Field Detail

PREFETCH_ALL

public static final long PREFETCH_ALL

Prefetch all of the entries available in the Space. Used with GET Browsers only.

See Also:

Constant Field Values

NO_WAIT

public static int NO_WAIT

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

WAIT_FOREVER

public static int WAIT_FOREVER

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

Constructor Detail

BrowserDef

public BrowserDef()

Method Detail

create

public static BrowserDef create()

Instantiate a new BrowserDef instance.

Returns:

The new BrowserDef instance.

create

public static BrowserDef create(long timeout)

Instantiate a new BrowserDef instance with the specified timeout.

Parameters:

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

Returns:

The new BrowserDef instance.

create

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

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

Parameters:

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

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

Returns:

The new BrowserDef instance.

create

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

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

Parameters:

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

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

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

Returns:

The new BrowserDef instance.

getTimeScope

public abstract BrowserDef.TimeScope getTimeScope()

Retrieve the time scope setting of the Browser.

Returns:

The TimeScope enumeration setting of the Browser.

getDistributionScope

public abstract BrowserDef.DistributionScope getDistributionScope()

Retrieve the distribution scope setting of the Browser.

Returns:

The DistributionScope enumeration setting of the Browser.

getTimeout

public abstract long getTimeout()

Retrieve the timeout setting of the Browser.

Returns:

The timeout in milliseconds.

setTimeout

public abstract BrowserDef setTimeout(long timeout)

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

Parameters:

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

Returns:

This BrowserDef instance.

setDistributionScope

public abstract BrowserDef setDistributionScope(BrowserDef.DistributionScope distributionScope)

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

Parameters:

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

Returns:

This BrowserDef instance.

setTimeScope

public abstract BrowserDef setTimeScope(BrowserDef.TimeScope timeScope)

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

Parameters:

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

Returns:

This BrowserDef instance.

setPrefetch

public abstract BrowserDef setPrefetch(long count)

Parameters:

count - The number of entries to prefetch from the Space. Used with GET Browsers only.

Returns:

This BrowserDef instance.

getPrefetch

public abstract long getPrefetch()

Retrieve the prefetch setting of the Browser. Used with GET Browsers only.

Returns:

The number of entries to prefetch from the Space.

setRoute

public abstract BrowserDef setRoute(boolean doRoute)

isRoute

public abstract boolean isRoute()

setQueryLimit

public abstract BrowserDef setQueryLimit(long limit)

Parameters:

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

Returns:

This BrowserDef instance.

getQueryLimit

public abstract long getQueryLimit()

Retrieve the query limit setting of the Browser.

Returns:

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