sfi.director.util.ObjectRegistry Class Reference

List of all members.

Detailed Description

Every object class the Director knows of needs to be registered in the Object registry.

The registry glues object classes with user interface

Before using the ObjectRegistry for the first time it needs to be initialized using the fromSearch() method.

See also:
fromSearch(Enumeration)


Public Member Functions

 ObjectRegistry (File schemaFile)
 ObjectRegistry (DBObject dbo)
 initializer: create ObjectRegistry entry
String getIcon ()
 return the name of an icon associated with this ObjectRegistry entry
Vector getClasses ()
 return the object classes associated with this ObjectRegistry entry
String getSchema ()
 return the name of the object editor schema associated with this ObjectRegistry entry
boolean isEditable ()
 returns true if entry is marked editable
boolean isCreateable ()
 returns true if entry is marked createable
String name ()
 return the name of this ObjectRegistry entry.
String getDisplayname ()
 return the display/menu name of this ObjectRegistry entry
String getDescription ()
 return the description of this ObjectRegistry entry
Vector getContext ()
 return a list of contexts this object class appears in
DBObject toDBObject ()
 convert ObjectRegistry object into a DBObject.

Static Public Member Functions

static ObjectRegistry getByName (String name)
 find an object registry entry by its name
static ObjectRegistry getByClass (String objclass)
 find an object registry entry by an objectclass.
static ObjectRegistry getByClass (Vector objclass)
 find best matching object registry entry by object class list.
static ObjectRegistry getByDisplayname (String name)
 find object registry entry by its displayname
static void fromSearch (Enumeration search)
 initialize the ObjectRegistry.
static Enumeration getNewFromContext (final String context)
static Enumeration getRegistered ()


Constructor & Destructor Documentation

sfi.director.util.ObjectRegistry.ObjectRegistry File  schemaFile  ) 
 

sfi.director.util.ObjectRegistry.ObjectRegistry DBObject  dbo  ) 
 

initializer: create ObjectRegistry entry


Member Function Documentation

static void sfi.director.util.ObjectRegistry.fromSearch Enumeration  search  )  [static]
 

initialize the ObjectRegistry.

Read entries from a DBConnection.search() result and fill them into the memory-held database.

See also:
sfi.director.repository.DBConnection.search()

static ObjectRegistry sfi.director.util.ObjectRegistry.getByClass Vector  objclass  )  [static]
 

find best matching object registry entry by object class list.

static ObjectRegistry sfi.director.util.ObjectRegistry.getByClass String  objclass  )  [static]
 

find an object registry entry by an objectclass.

(Trivial and not very useful - use getByClass(Vector) instead)

See also:
getByClass(Vector)

static ObjectRegistry sfi.director.util.ObjectRegistry.getByDisplayname String  name  )  [static]
 

find object registry entry by its displayname

static ObjectRegistry sfi.director.util.ObjectRegistry.getByName String  name  )  [static]
 

find an object registry entry by its name

Vector sfi.director.util.ObjectRegistry.getClasses  ) 
 

return the object classes associated with this ObjectRegistry entry

Vector sfi.director.util.ObjectRegistry.getContext  ) 
 

return a list of contexts this object class appears in

String sfi.director.util.ObjectRegistry.getDescription  ) 
 

return the description of this ObjectRegistry entry

String sfi.director.util.ObjectRegistry.getDisplayname  ) 
 

return the display/menu name of this ObjectRegistry entry

String sfi.director.util.ObjectRegistry.getIcon  ) 
 

return the name of an icon associated with this ObjectRegistry entry

static Enumeration sfi.director.util.ObjectRegistry.getNewFromContext final String  context  )  [static]
 

static Enumeration sfi.director.util.ObjectRegistry.getRegistered  )  [static]
 

String sfi.director.util.ObjectRegistry.getSchema  ) 
 

return the name of the object editor schema associated with this ObjectRegistry entry

boolean sfi.director.util.ObjectRegistry.isCreateable  ) 
 

returns true if entry is marked createable

boolean sfi.director.util.ObjectRegistry.isEditable  ) 
 

returns true if entry is marked editable

String sfi.director.util.ObjectRegistry.name  ) 
 

return the name of this ObjectRegistry entry.

DBObject sfi.director.util.ObjectRegistry.toDBObject  ) 
 

convert ObjectRegistry object into a DBObject.


The documentation for this class was generated from the following file:
Generated on Sat May 19 01:20:00 2012 for Node Director by  doxygen 1.4.5