Serialized Form

Package com.rbnb.api

Class com.rbnb.api.AddressException extends RBNBException implements Serializable

Class com.rbnb.api.Ask extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

informationType

String informationType

additional

Vector<E> additional

additional parameters.

Since:

V2.0

Author:

Ian Brown

Version:

05/09/2001

Class com.rbnb.api.ControllerHandle extends com.rbnb.api.ClientHandle implements Serializable

Class com.rbnb.api.DataArray extends Object implements Serializable

Serialized Fields

data

Object data

the data.

This field needs to be cast to the appropriate array type to be used.

Since:

V2.0

Author:

Ian Brown

Version:

11/30/2000

dType

byte dType

the data type.

Since:

V2.0

Author:

Ian Brown

Version:

09/17/2002

frameRanges

Vector<E> frameRanges

the frame information.

Since:

V2.0;

Author:

Ian Brown

Version:

04/12/2002

frames

double[] frames

the individual frame values.

Since:

V2.0

Author:

Ian Brown

Version:

04/15/2002

numberInArray

int numberInArray

the current number of points in the data array.

Since:

V2.0

Author:

Ian Brown

Version:

04/12/2002

numberOfPoints

int numberOfPoints

the total number of points.

Since:

V2.0

Author:

Ian Brown

Version:

04/12/2002

mimeType

String mimeType

the MIME type.

Since:

V2.0

Author:

Ian Brown

Version:

01/24/2002

pointsPerRange

Vector<E> pointsPerRange

the number of points per TimeRange.

Since:

V2.0

Author:

Ian Brown

Version:

04/12/2002

ptSize

int ptSize

the point size.

Since:

V2.0

Author:

Ian Brown

Version:

09/17/2002

timeRanges

Vector<E> timeRanges

the time information.

Since:

V2.0;

Author:

Ian Brown

Version:

04/12/2002

times

double[] times

the individual times.

Since:

V2.0

Author:

Ian Brown

Version:

04/15/2002

Class com.rbnb.api.DataBlock extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

reference

com.rbnb.api.DataReference reference

Optional descriptive information.

Since:

V2.0

Author:

Ian Brown

Version:

08/09/2001

numPoints

int numPoints

The number of points.

Since:

V2.0

Author:

Ian Brown

Version:

11/30/2000

pointSize

int pointSize

The number of bytes in a single point.

Since:

V2.0

Author:

Ian Brown

Version:

11/30/2000

data

Vector<E> data

The data payload.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

Class com.rbnb.api.DataRequest extends Rmap implements Serializable

Serialized Fields

gapControl

boolean gapControl

control when gaps can occur?

Since:

V2.0

Author:

Ian Brown

Version:

06/07/2001

increment

double increment

the time increment.

If this is not 0, then it is added to the calculated start time of the previous request to produce an ABSOLUTE start time for subsequent repetitions *

Since:

V2.0

See Also:

DataRequest.ABSOLUTE

Author:

Ian Brown

Version:

04/03/2001

repetitions

long repetitions

the number of repetitions.

Since:

V2.0

See Also:

DataRequest.INFINITE

Author:

Ian Brown

Version:

04/03/2001

responseMode

byte responseMode

response mode.

Since:

V2.0

See Also:

DataRequest.CONSOLIDATED, DataRequest.FRAMES

Author:

Ian Brown

Version:

03/01/2001

synchronizedChannels

boolean synchronizedChannels

synchronized channel responses?

Since:

V2.0

Author:

Ian Brown

Version:

03/01/2001

timeDomain

byte timeDomain

the time domain.

Since:

V2.0

See Also:

DataRequest.ALL, DataRequest.EXISTING, DataRequest.FUTURE

Author:

Ian Brown

Version:

03/01/2001

timeReference

byte timeReference

the time reference.

Since:

V2.0

See Also:

DataRequest.ABSOLUTE, DataRequest.AFTER, DataRequest.MODIFIED, DataRequest.NEWEST, DataRequest.OLDEST

Author:

Ian Brown

Version:

04/11/2002

timeRelationship

byte timeRelationship

the time relationship.

Since:

V2.2

See Also:

DataRequest.EQUAL, DataRequest.GREATER, DataRequest.GREATER_EQUAL, DataRequest.LESS, DataRequest.LESS_EQUAL

Author:

Ian Brown

Version:

11/06/2003

Class com.rbnb.api.DisconnectedClientException extends AddressException implements Serializable

Class com.rbnb.api.EndOfStream extends Rmap implements Serializable

Serialized Fields

reason

byte reason

the reason for the end of stream.

Since:

V2.0

Author:

Ian Brown

Version:

09/28/2001

Class com.rbnb.api.RBNBException extends Exception implements Serializable

Class com.rbnb.api.RequestOptions extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

extendStart

boolean extendStart

extend the start time of a request rather than move it?

This option only works with requests that specify that the actual time retrieved must be less than, or less than or equal to, the request specified time.

Since:

V2.2

Author:

Ian Brown

Version:

12/08/2003

maxWait

long maxWait

the maximum time to wait for the data to appear in a request for "existing" data.

Since:

V2.2

Author:

Ian Brown

Version:

06/11/2003

Class com.rbnb.api.Rmap extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

dataBlock

DataBlock dataBlock

data for this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

parent

Rmap parent

parent Rmap of this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

children

com.rbnb.api.RmapVector children

Rmap children of this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

groupList

com.rbnb.api.RmapVector groupList

Rmap group children of this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

name

String name

name of the Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

frameRange

TimeRange frameRange

frame index span of this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

nameNSD

boolean nameNSD

name is not to be significant?

Since:

V2.0

Author:

Ian Brown

Version:

10/21/2002

timeRange

TimeRange timeRange

time span of this Rmap.

Since:

V2.0

Author:

Ian Brown

Version:

05/10/2001

Class com.rbnb.api.SerializeException extends RBNBException implements Serializable

Class com.rbnb.api.Server extends Rmap implements Serializable

Serialized Fields

address

String address

the address.

Since:

V2.0

Author:

Ian Brown

Version:

05/11/2001

Class com.rbnb.api.TimeRange extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

changing

byte changing

how does time change across the range?

The values that this field can take are:

• INCREASING - monotonically increasing,
• DECREASING - monotonically descreasing,
• RANDOM - time can go in any direction,
• UNKNOWN - haven't determined direction yet.

Note: at this point, TimeRanges must monotonically increase.

Since:

V2.0

Author:

Ian Brown

Version:

09/20/2001

direction

boolean direction

the comparison direction.

This field is used by requests for NEWEST to indicate that the comparison is to reverse its direction. It is somewhat of a kludge due to the fact that I needed to fix things quickly.

Since:

V2.0

Author:

Ian Brown

Version:

05/21/2002

duration

double duration

duration (applies to all of the times).

Since:

V2.0

Author:

Ian Brown

Version:

11/30/2000

inclusive

boolean inclusive

inclusive of both ends?

Since:

V2.0

Author:

Ian Brown

Version:

11/06/2002

ptimes

double[] ptimes

time values.

Since:

V2.0

Author:

Ian Brown

Version:

11/30/2000

Class com.rbnb.api.Username extends com.rbnb.api.Serializable implements Serializable

Serialized Fields

password

String password

the password string or an indicator of how to get it.

Since:

V2.0

Author:

Ian Brown

Version:

01/14/2003

username

String username

the username string.

Since:

V2.0

Author:

Ian Brown

Version:

01/14/2003

Package com.rbnb.sapi

Class com.rbnb.sapi.ChannelMap extends Object implements Serializable

serialVersionUID: 8274903653155563848L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

debugFlag

boolean debugFlag

wasTimeout

boolean wasTimeout

response

Rmap response

timeMode

int timeMode

start

double start

duration

double duration

pointTimes

double[] pointTimes

timeReference

DataArray timeReference

channelsPut

int channelsPut

timePerChannel

boolean timePerChannel

setTimeCounter

int setTimeCounter

channelList

Vector<E> channelList

channelMap

Hashtable<K,V> channelMap

folderMappings

Hashtable<K,V> folderMappings

baseFrame

Rmap baseFrame

outputRmap

Rmap outputRmap

folderArray

String[] folderArray

Class com.rbnb.sapi.ChannelTree extends Object implements Serializable

serialVersionUID: -5459292206096099221L

Serialized Fields

map

HashMap<K,V> map

rootList

LinkedList<E> rootList

Class com.rbnb.sapi.ChannelTree.Node extends Object implements Serializable

serialVersionUID: 6312795055754506624L

Serialized Fields

name

String name

fullName

String fullName

children

LinkedList<E> children

childrenMap

HashMap<K,V> childrenMap

readOnlyChildren

List<E> readOnlyChildren

readOnlyMap

Map<K,V> readOnlyMap

depth

int depth

type

ChannelTree.NodeTypeEnum type

parent

ChannelTree.Node parent

mime

String mime

size

int size

start

double start

duration

double duration

Class com.rbnb.sapi.ChannelTree.NodeTypeEnum extends Object implements Serializable

serialVersionUID: 8888487910653971066L

Serialized Fields

typename

String typename

Class com.rbnb.sapi.Client extends Object implements Serializable

Serialized Fields

cacheSize

int cacheSize

archiveSize

int archiveSize

archiveMode

int archiveMode

Class com.rbnb.sapi.Control extends Client implements Serializable

Serialized Fields

controller

Controller controller

Class com.rbnb.sapi.PlugIn extends Client implements Serializable

Serialized Fields

plugin

PlugIn plugin

Class com.rbnb.sapi.PlugInChannelMap extends ChannelMap implements Serializable

serialVersionUID: 6543714829227271536L

Serialized Fields

pluginStart

double pluginStart

pluginDuration

double pluginDuration

repeatInterval

double repeatInterval

pluginTimeMode

boolean pluginTimeMode

repeatCount

int repeatCount

requestType

int requestType

pluginTimeReference

String pluginTimeReference

requestId

String requestId

responseHeader

Rmap responseHeader

requestOptions

RequestOptions requestOptions

Class com.rbnb.sapi.RequestOptions extends RequestOptions implements Serializable

Class com.rbnb.sapi.SAPIException extends Exception implements Serializable

Serialized Fields

nestedException

Exception nestedException

Class com.rbnb.sapi.Sink extends Client implements Serializable

serialVersionUID: -3107073470270413675L

Serialized Fields

registrationResult

Rmap registrationResult

Class com.rbnb.sapi.Source extends Client implements Serializable

serialVersionUID: 3938978994160732623L

Serialized Fields

groups

Hashtable<K,V> groups

Maps channel names to the number of channels in each set.

Since:

V2.0B10