Glossary:

Nirvana Flex API: com.pcbsys.nirvana.client.nDataGroup

Package	com.pcbsys.nirvana.client
Class	public class nDataGroup
Inheritance	nDataGroup nDataStream Object

This class represents a individual data group object.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		closed : Boolean [read-only] Returns whether or not this Data group is closed	nDataGroup
		id : Long [read-only] Returns this dataGroups ID	nDataGroup
		listener : nDataGroupListener [write-only] Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified	nDataGroup
		name : String [read-only] eturns the name of this stream	nDataStream
		publishers : Array [read-only] Returns an Array of currently allowed publishers	nDataGroup
		streams : nDataGroupIterator [read-only] Returns an array of nDataStream's	nDataGroup
		subject : String [read-only] eturns the subject of this stream	nDataStream

Public Methods

	Method		Defined By
		addByGroup(group:nDataGroup):void Adds an existing data group to this data group, allowing groups to be cascaded	nDataGroup
		addByStream(stream:nDataStream):void Add a new stream to this data group	nDataGroup
		addByStreams(streams:Array):void Add a new stream to this data group	nDataGroup
		addPublisher(subject:String, callback:Function):void Allow the specified subject to be allowed to publish to this group	nDataGroup
		contains(stream:String):Boolean Checks if the stream id exists in this group	nDataGroup
		containsStream(stream:nDataStream):Boolean Checks if the stream id exists in this group	nDataGroup
		createRegisteredEvent():nRegisteredEvent Used to create a registered event on a data group	nDataGroup
		getConflationAttributes():nConflationAttributes Get the conflation attributes for this data group if they exist	nDataGroup
		getGroup(groupName:String):nDataGroup Returns the DataGroup specified, if it is contained within this group.	nDataGroup
		getGroupCount():int Returns the size of the DataGroups (if any) contained within this group.	nDataGroup
		getGroups():Array Returns the DataGroups (if any) contained within this group.	nDataGroup
		getGroupsContaining():Array Locate the groups that currently contain this group	nDataGroup
		getStream(name:String):nDataStream Returns the stream associated with groupName	nDataGroup
		isNested():Boolean Flag to indicate whether this group is nested within one or more other groups	nDataGroup
		isReadOnly():Boolean Flag to indicate whether this group is read only.	nDataGroup
		removeByGroup(group:nDataGroup):void Remove the specified data group from this one	nDataGroup
		removeByStream(stream:nDataStream):void Remove the stream Id from this data group	nDataGroup
		removePublisher(subject:String, callback:Function):void Remove the specified subject from the list of authorised publishers for this group	nDataGroup
		setReadOnly():void Marks the nDataGroup as read only	nDataGroup
		size():int Returns the amount of streams this dataGroup contains	nDataGroup

Property Detail

closed

property

closed:Boolean [read-only]

Returns whether or not this Data group is closed

Implementation
public function get closed():Boolean

property

id:Long [read-only]

Returns this dataGroups ID

Implementation
public function get id():Long

listener

property

listener:nDataGroupListener [write-only]

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

Implementation
public function set listener(value:nDataGroupListener):void

Throws

nDataGroupDeletedError —

publishers

property

publishers:Array [read-only]

Returns an Array of currently allowed publishers

Implementation
public function get publishers():Array

streams

property

streams:nDataGroupIterator [read-only]

Returns an array of nDataStream's

Implementation
public function get streams():nDataGroupIterator

Method Detail

addByGroup

()

method

public function addByGroup(group:nDataGroup):void

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

Parameters

group:nDataGroup — - group to be added

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

addByStream

()

method

public function addByStream(stream:nDataStream):void

Add a new stream to this data group

Parameters

stream:nDataStream — - a nDataStream objects to add

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

addByStreams

()

method

public function addByStreams(streams:Array):void

Add a new stream to this data group

Parameters

streams:Array — - Array of nDataStream objects to add

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

addPublisher

()

method

public function addPublisher(subject:String, callback:Function):void

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

Parameters

	`subject:String` — the subject to give permissions to

	`callback:Function` — the callback with either null of a error

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

contains

()

method

public function contains(stream:String):Boolean

Checks if the stream id exists in this group

Parameters

stream:String — of the stream or group to test for

Returns

Boolean — true if this group contains the specified stream id

Throws

nDataGroupDeletedError —

containsStream

()

method

public function containsStream(stream:nDataStream):Boolean

Checks if the stream id exists in this group

Parameters

stream:nDataStream — the stream or group to test for

Returns

Boolean — true if this group contains the specified stream id

Throws

nDataGroupDeletedError —

createRegisteredEvent

()

method

public function createRegisteredEvent():nRegisteredEvent

Used to create a registered event on a data group

Returns

nRegisteredEvent — nRegisteredEvent the registered event for publishing

getConflationAttributes

()

method

public function getConflationAttributes():nConflationAttributes

Get the conflation attributes for this data group if they exist

Returns

nConflationAttributes — the conflation attributes if they exist

getGroup

()

method

public function getGroup(groupName:String):nDataGroup

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

Parameters

groupName:String — to find

Returns

nDataGroup — nDataGroup object

Throws

nDataGroupDeletedError —

getGroupCount

()

method

public function getGroupCount():int

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

Returns

int — int size the number of data groups contained within this group

Throws

nDataGroupDeletedError —

getGroups

()

method

public function getGroups():Array

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

Returns

Array — nDataGroup array of the contained data groups

Throws

nDataGroupDeletedError —

getGroupsContaining

()

method

public function getGroupsContaining():Array

Locate the groups that currently contain this group

Returns

Array — an array of nDataGroup objects containing the group

Throws

nDataGroupDeletedError — if this nDataGroup is now closed

getStream

()

method

public function getStream(name:String):nDataStream

Returns the stream associated with groupName

Parameters

name:String — the name of the string to return

Returns

nDataStream — nDataStream

Throws

nDataGroupDeletedError —

isNested

()

method

public function isNested():Boolean

Flag to indicate whether this group is nested within one or more other groups

Returns

Boolean — true if nested else false

isReadOnly

()

method

public function isReadOnly():Boolean

Flag to indicate whether this group is read only. If it is, it will be the default Data Group object

Returns

Boolean — true is default Data Group

removeByGroup

()

method

public function removeByGroup(group:nDataGroup):void

Remove the specified data group from this one

Parameters

group:nDataGroup

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

removeByStream

()

method

public function removeByStream(stream:nDataStream):void

Remove the stream Id from this data group

Parameters

stream:nDataStream

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

removePublisher

()

method

public function removePublisher(subject:String, callback:Function):void

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

Parameters

	`subject:String` — the subject to remove permissions from

	`callback:Function` — the callback with either null of a error

Throws

	`nDataGroupIsReadOnlyError` —

	`nDataGroupDeletedError` —

	`com.pcbsys.nirvana.client.error:nSessionNotConnectedError` —

	`nSessionNotInitialisedError` — if you have not initialised the session

setReadOnly

()

method

public function setReadOnly():void

Marks the nDataGroup as read only

size

()

method

public function size():int

Returns the amount of streams this dataGroup contains

Returns

int

developers » nirvana » web » flex » apidocs_6_0

Nirvana Flex API: com.pcbsys.nirvana.client.nDataGroup