com.pcbsys.nirvana.nAdminAPI.nJoinDetails Class Reference

This class contains information about a join between two channels. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nJoinDetails:
com.pcbsys.nirvana.client.Observable

Public Member Functions

virtual bool allowPurgeRequests ()
 Return whether purge requests are permitted in this join. More...
 
virtual int getHopCount ()
 Returns the number of times an event will be passed over a join. More...
 
virtual long getLastEID ()
 Returns the last Event ID sent to the remote join More...
 
virtual nLeafNode getRemoteNode ()
 Returns the nLeafNode of the remote end of the join, if this is a source join then this returns the destination else it returns the source. More...
 
virtual string getSelector ()
 Returns the selector used for the join. More...
 
bool isArchival ()
 Returns true if this join is an archival join More...
 
virtual bool isSource ()
 Returns a boolean flag representive of whether the channel is the source side of the join More...
 
override string ToString ()
 Returns a string representation of this object More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. More...
 

Detailed Description

This class contains information about a join between two channels.

There is a nJoinDetails for both sides of a join. On a channel which sends the events this is known as a source channel and this class will return true to isSource() function.

The source can also have a selector associacted with it while the channel receiving the events, the destination, has no selector associated with it.

Member Function Documentation

virtual bool com.pcbsys.nirvana.nAdminAPI.nJoinDetails.allowPurgeRequests ( )
virtual

Return whether purge requests are permitted in this join.

When you purge an event from a channel, you can specify whether to purge from any subsequent joined channels, like a cascade deletion. If this flag is set to true, any purge requests from the source channel to the destination channel / queue will be enforced. If false, purge requests will not be enforced on the destination channel / queue.

Returns
whether purge requests are honoured
virtual int com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getHopCount ( )
virtual

Returns the number of times an event will be passed over a join.

Useful if you wish to limit the number of time an event is sent over the network.

Returns
int hop count
virtual long com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getLastEID ( )
virtual

Returns the last Event ID sent to the remote join

Returns
long eid
virtual nLeafNode com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getRemoteNode ( )
virtual

Returns the nLeafNode of the remote end of the join, if this is a source join then this returns the destination else it returns the source.

Returns
nLeafNode remote channel / queue
virtual string com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getSelector ( )
virtual

Returns the selector used for the join.

This is only applicable if the join is the source since the destination side of a join is not informed of the selector

Returns
String selector
bool com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isArchival ( )

Returns true if this join is an archival join

Returns
boolean is archival
virtual bool com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isSource ( )
virtual

Returns a boolean flag representive of whether the channel is the source side of the join

Returns
boolean flag indicating if the channel to which the join details belongs is the source channel for the join
override string com.pcbsys.nirvana.nAdminAPI.nJoinDetails.ToString ( )

Returns a string representation of this object

<return> string representation of object </return>