com.pcbsys.nirvana.client.nDataGroup Class Reference

This class represents a individual data group object. More...

Inheritance diagram for com.pcbsys.nirvana.client.nDataGroup:

Public Member Functions
void	add (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Add a new stream to this data group. More...
void	add (nDataStream[] streams) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Add an array of new stream to this data group. More...
void	add (nDataGroup add) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Adds an existing data group to this data group, allowing groups to be cascaded. More...
void	addListener (nDataGroupListener listener) throws nDataGroupDeletedException
	Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified. More...
void	addPublisher (String subject) throws nBaseClientException
	Allow the specified subject to be allowed to publish to this group. More...
void	addSnoop (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Add a new snoop stream to this data group This stream will be hidden from the group, with no callbacks fired for it. More...
boolean	contains (nDataGroup group) throws nDataGroupDeletedException
	Checks if the input group exists within this data group. More...
boolean	contains (nDataStream stream) throws nDataGroupDeletedException
	Checks if the stream id exists in this group. More...
boolean	contains (String streamId) throws nDataGroupDeletedException
	Checks if the stream id exists in this group. More...
boolean	containsSnoop (nDataStream stream) throws nDataGroupDeletedException
	Checks if the snoop stream id exists in this group. More...
boolean	containsSnoop (String streamId) throws nDataGroupDeletedException
	Checks if the snoop stream id exists in this group. More...
nRegisteredEvent	createRegisteredEvent () throws nIllegalStateException
	Registers a new nRegisteredEvent with the data stream allowing updates only to be sent through to the clients. More...
nConflationAttributes	getConflationAttributes ()
	Get the conflation attributes for this data group if they exist. More...
nDataGroup	getGroup (String groupName) throws nDataGroupDeletedException
	Returns the DataGroup specified, if it is contained within this group. More...
int	getGroupCount () throws nDataGroupDeletedException
	Returns the size of the DataGroups (if any) contained within this group. More...
Iterator< nDataGroup >	getGroups () throws nDataGroupDeletedException
	Returns the DataGroups (if any) contained within this group. More...
nDataGroup[]	getGroupsContaining ()
	Locate the groups that currently contain this group. More...
Enumeration< nDataGroup >	getGroupsEnumeration () throws nDataGroupDeletedException
	Returns the DataGroups (if any) contained within this group. More...
long	getID ()
	Return the id of this nDataGroup object. More...
String	getName ()
	Return the name of the group. More...
int	getPriority ()
	Returns the level of priority assigned to this Data Group. More...
Iterator< String >	getPublishers () throws nDataGroupDeletedException
	Obtain an iterator of publisher ids. More...
Enumeration< String >	getPublishersEnumeration () throws nDataGroupDeletedException
	Obtain an Enumeration of publisher ids. More...
nSession	getSession ()
	Returns the session associated with this data group instance.
nDataStream	getSnoopStream (String name) throws nDataGroupDeletedException
	Get the nDataStream snoop object corresponding to the name. More...
nDataStream	getStream (String name) throws nDataGroupDeletedException
	Get the nDataStream object corresponding to the name. More...
Iterator< nDataStream >	getStreams () throws nDataGroupDeletedException
	Obtain an iterator of the nDataStream objects contained within this group. More...
Enumeration< nDataStream >	getStreamsEnumeration () throws nDataGroupDeletedException
	Obtain an Enumeration of the nDataStream objects contained within this group. More...
boolean	isClosed ()
	Returns true if this group has been deleted. More...
boolean	isMulticastEnabled ()
	Flag to indicate whether this Data Group is multicast enabled. More...
boolean	isNested ()
	Flag indicating whether this group is nested within one of more other groups. More...
boolean	isReadOnly ()
	Flag to indicate whether this group is read only. More...
void	remove (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Remove the stream Id from this data group. More...
void	remove (nDataGroup group) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Remove the specified data group from this one. More...
void	removePublisher (String subject) throws Exception
	Remove the specified subject from the list of authorised publishers for this group. More...
void	removeSnoop (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException
	Remove the snoop stream Id from this data group. More...
int	size () throws nDataGroupDeletedException
	Return the total number of streams contained in this group. More...
Public Member Functions inherited from com.pcbsys.nirvana.client.nDataStream
String	getName ()
	Get the name of the stream. More...
String	getSubject ()
	Get the subject associated with the stream. More...

Detailed Description

This class represents a individual data group object.

Since

6.0

Member Function Documentation

void com.pcbsys.nirvana.client.nDataGroup.add

(

nDataStream

stream

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Add a new stream to this data group.

Parameters

stream

- the stream to add

void com.pcbsys.nirvana.client.nDataGroup.add

(

nDataStream[]

streams

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Add an array of new stream to this data group.

Parameters

streams

- the array of streams to add

void com.pcbsys.nirvana.client.nDataGroup.add

(

nDataGroup

add

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Adds an existing data group to this data group, allowing groups to be cascaded.

Parameters

add	- group to be added

void com.pcbsys.nirvana.client.nDataGroup.addListener

(

nDataGroupListener

listener

)

throws nDataGroupDeletedException

Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified.

Parameters

listener

the listener to receive callbacks on this data group

Exceptions

nDataGroupDeletedException

if the group is deleted

void com.pcbsys.nirvana.client.nDataGroup.addPublisher

(

String

subject

)

throws nBaseClientException

Allow the specified subject to be allowed to publish to this group.

Parameters

subject

the subject to give permissions to

Exceptions

nDataGroupIsReadOnlyException	if the data group is read only
nDataGroupDeletedException	if the group is deleted
nBaseClientException	if there are problems when adding the publisher

void com.pcbsys.nirvana.client.nDataGroup.addSnoop

(

nDataStream

stream

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Add a new snoop stream to this data group This stream will be hidden from the group, with no callbacks fired for it.

Parameters

stream

- the stream to add

boolean com.pcbsys.nirvana.client.nDataGroup.contains

(

nDataGroup

group

)

throws nDataGroupDeletedException

Checks if the input group exists within this data group.

Parameters

group

to test to see if is contained within this data group

Returns

true if this data group contains this group

boolean com.pcbsys.nirvana.client.nDataGroup.contains

(

nDataStream

stream

)

throws nDataGroupDeletedException

Checks if the stream id exists in this group.

Parameters

stream

the stream to test for

Returns

true if this group contains the specified stream id

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

boolean com.pcbsys.nirvana.client.nDataGroup.contains

(

String

streamId

)

throws nDataGroupDeletedException

Checks if the stream id exists in this group.

Parameters

streamId

the name of the stream or group to test for

Returns

true if this group contains the specified stream id

Exceptions

nDataGroupDeletedException

if the group is deleted

boolean com.pcbsys.nirvana.client.nDataGroup.containsSnoop

(

nDataStream

stream

)

throws nDataGroupDeletedException

Checks if the snoop stream id exists in this group.

Parameters

stream

the stream to test for

Returns

true if this group contains the specified stream id

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

boolean com.pcbsys.nirvana.client.nDataGroup.containsSnoop

(

String

streamId

)

throws nDataGroupDeletedException

Checks if the snoop stream id exists in this group.

Parameters

streamId

the name of the snoop stream to test for

Returns

true if this group contains the specified stream id

Exceptions

nDataGroupDeletedException

if the group is deleted

nRegisteredEvent com.pcbsys.nirvana.client.nDataGroup.createRegisteredEvent

(

)

throws nIllegalStateException

Registers a new nRegisteredEvent with the data stream allowing updates only to be sent through to the clients.

Returns

nRegisteredEvent object

Exceptions

nIllegalStateException

If the conflation attributes are mis-configured

See Also

nRegisteredEvent

nConflationAttributes com.pcbsys.nirvana.client.nDataGroup.getConflationAttributes

(

)

Get the conflation attributes for this data group if they exist.

Returns

the conflation attributes if they exist

nDataGroup com.pcbsys.nirvana.client.nDataGroup.getGroup

(

String

groupName

)

throws nDataGroupDeletedException

Returns the DataGroup specified, if it is contained within this group.

Parameters

groupName

to find

Returns

nDataGroup the group matching the groupName

Exceptions

nDataGroupDeletedException

if the group is deleted

int com.pcbsys.nirvana.client.nDataGroup.getGroupCount

(

)

throws nDataGroupDeletedException

Returns the size of the DataGroups (if any) contained within this group.

Returns

int size the number of data groups contained within this group

Exceptions

nDataGroupDeletedException

if the group is deleted

Iterator<nDataGroup> com.pcbsys.nirvana.client.nDataGroup.getGroups

(

)

throws nDataGroupDeletedException

Returns the DataGroups (if any) contained within this group.

Returns

nDataGroup Iterator of the contained data groups

Exceptions

nDataGroupDeletedException

if the group is deleted

nDataGroup [] com.pcbsys.nirvana.client.nDataGroup.getGroupsContaining

(

)

Locate the groups that currently contain this group.

Returns

an array of nDataGroup objects containing the group

Enumeration<nDataGroup> com.pcbsys.nirvana.client.nDataGroup.getGroupsEnumeration

(

)

throws nDataGroupDeletedException

Returns the DataGroups (if any) contained within this group.

Returns

Enumeration with the contained nDataGroup groups

Exceptions

nDataGroupDeletedException

if the group is deleted

long com.pcbsys.nirvana.client.nDataGroup.getID

(

)

Return the id of this nDataGroup object.

Returns

the unique long value representing this nDataGroup

String com.pcbsys.nirvana.client.nDataGroup.getName

(

)

Return the name of the group.

Returns

the name of this Data Group

int com.pcbsys.nirvana.client.nDataGroup.getPriority

(

)

Returns the level of priority assigned to this Data Group.

Returns

a value between 1 and 10 indicating priority

Iterator<String> com.pcbsys.nirvana.client.nDataGroup.getPublishers

(

)

throws nDataGroupDeletedException

Obtain an iterator of publisher ids.

Returns

an Iterator of currently allowed publishers

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

Enumeration<String> com.pcbsys.nirvana.client.nDataGroup.getPublishersEnumeration

(

)

throws nDataGroupDeletedException

Obtain an Enumeration of publisher ids.

Returns

an Enumeration of Strings with currently allowed publishers

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

nDataStream com.pcbsys.nirvana.client.nDataGroup.getSnoopStream

(

String

name

)

throws nDataGroupDeletedException

Get the nDataStream snoop object corresponding to the name.

Parameters

name	of the snoop stream

Returns

the stream object

Exceptions

nDataGroupDeletedException

if the group is deleted

nDataStream com.pcbsys.nirvana.client.nDataGroup.getStream

(

String

name

)

throws nDataGroupDeletedException

Get the nDataStream object corresponding to the name.

Parameters

name	of the stream

Returns

the stream object

Exceptions

nDataGroupDeletedException

if the group is deleted

Iterator<nDataStream> com.pcbsys.nirvana.client.nDataGroup.getStreams

(

)

throws nDataGroupDeletedException

Obtain an iterator of the nDataStream objects contained within this group.

Returns

an Iterator of known streams

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

Enumeration<nDataStream> com.pcbsys.nirvana.client.nDataGroup.getStreamsEnumeration

(

)

throws nDataGroupDeletedException

Obtain an Enumeration of the nDataStream objects contained within this group.

Returns

an Enumeration of known streams

Exceptions

nDataGroupDeletedException

if this nDataGroup is now closed

boolean com.pcbsys.nirvana.client.nDataGroup.isClosed

(

)

Returns true if this group has been deleted.

Returns

true if deleted

boolean com.pcbsys.nirvana.client.nDataGroup.isMulticastEnabled

(

)

Flag to indicate whether this Data Group is multicast enabled.

Returns

true if enabled, false otherwise

boolean com.pcbsys.nirvana.client.nDataGroup.isNested

(

)

Flag indicating whether this group is nested within one of more other groups.

Returns

true if nested else false

boolean com.pcbsys.nirvana.client.nDataGroup.isReadOnly

(

)

Flag to indicate whether this group is read only.

If it is, it will be the default Data Group object

Returns

true is default Data Group

void com.pcbsys.nirvana.client.nDataGroup.remove

(

nDataStream

stream

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Remove the stream Id from this data group.

Parameters

stream

- the stream to remove from this data group

void com.pcbsys.nirvana.client.nDataGroup.remove

(

nDataGroup

group

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Remove the specified data group from this one.

Parameters

group

the group to remove

void com.pcbsys.nirvana.client.nDataGroup.removePublisher

(

String

subject

)

throws Exception

Remove the specified subject from the list of authorised publishers for this group.

Parameters

subject

the subject to remove permissions from

Exceptions

nDataGroupIsReadOnlyException	if the data group is read only
nDataGroupDeletedException	if the group is deleted

void com.pcbsys.nirvana.client.nDataGroup.removeSnoop

(

nDataStream

stream

)

throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException

Remove the snoop stream Id from this data group.

Parameters

stream

- the stream to remove from this data group

int com.pcbsys.nirvana.client.nDataGroup.size

(

)

throws nDataGroupDeletedException

Return the total number of streams contained in this group.

Returns

the number of streams in this group

Exceptions

nDataGroupDeletedException

if the group is deleted