Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.collection Object Description
(collection Template)

The rb.collection object represents pairs of objects (contact, catalogue item or catalogue nodes) connected together by arcs. This simple model allows complex data collections to be created such as subscription lists, 'friends' lists etc.

Each 'arc' connecting two entities has a 'type' and a set of data. This allows more complex relationships than can be produced using communities one catalogue trees. The arc data can for example be used to store 'why' the two items are linked.

Consider the case where individuals are to be linked to artcles in a publication. Ten people could related to that document - for different reasons. One is the author. Another is the reviewer and the other eight are people that have read the article.

Methods

rb.collection.typeSet() Create or modify a collection
rb.collection.typeRemove() Delete an existing class of collection
rb.collection.typeInfo() Return info stored about this collection class
rb.collection.typeGet() Iterate over the set of defined classes
rb.collection.getArcs() Iterator used to traverse arcs
rb.collection.countArcs() Count number of arcs that meet a specific search criteria
rb.collection.configureArcs() Create, modify or delete a number of arcs
rb.collection.removeArcs() Bulk mechanism to remove all arcs that match a specified set of criteria.

Aggregate Types

rb.collection.type Information about a collection class
rb.collection.arcDef Type used to specify an arc and right-hand point when updating arc definitions
rb.collection.arcQueryData Iterator data type representing an arc
rb.collection.arcSearchType Search parameters for rb.collection.getArcs()
Whitebeam release 1.3.36
(loadtime : 184ms)