arlut.csd.ganymede
Class CategoryTransport

java.lang.Object
  |
  +--arlut.csd.ganymede.CategoryTransport

All Implemented Interfaces:

java.io.Serializable

public class CategoryTransport

extends java.lang.Object

implements java.io.Serializable

This class is intended to provide a serializable object that can be used to bulk-dump a static description of the category and base structures on the server to the client.

See Also:

Serialized Form

Field Summary

(package private) java.lang.StringBuffer	buffer
private boolean	hideNonEditables If true and the session is a user client, only editable object types will be included in the generated CategoryTransport.
(package private) static long	serialVersionUID
(package private) java.lang.Object	session This is really a GanymedeSession object, but by defining this as a generic Object we avoid having the client attempt to load the GanymedeSession.class unless it calls the server-side constructor methods, which it should not do.

Constructor Summary

CategoryTransport(DBBaseCategory root)
Server side constructor for the full category tree

CategoryTransport(DBBaseCategory root, GanymedeSession session)
Server side constructor for the viewable subset of the category tree

CategoryTransport(DBBaseCategory root, GanymedeSession session, boolean hideNonEditables)
Server side constructor for the viewable subset of the category tree

Method Summary

private void	addBaseInfo(DBObjectBase node)
private void	addCategoryInfo(DBBaseCategory category)
private void	addChunk(java.lang.String text)
private boolean	containsEditableBase(DBBaseCategory category)
private boolean	containsVisibleBase(DBBaseCategory category)
CategoryDump	getTree() Client side accessor

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

buffer

java.lang.StringBuffer buffer

session

transient java.lang.Object session

This is really a GanymedeSession object, but by defining this as a generic Object we avoid having the client attempt to load the GanymedeSession.class unless it calls the server-side constructor methods, which it should not do.

hideNonEditables

private transient boolean hideNonEditables

If true and the session is a user client, only editable object types will be included in the generated CategoryTransport.

Constructor Detail

CategoryTransport

public CategoryTransport(DBBaseCategory root)

Server side constructor for the full category tree

CategoryTransport

public CategoryTransport(DBBaseCategory root,
                         GanymedeSession session)

Server side constructor for the viewable subset of the category tree

CategoryTransport

public CategoryTransport(DBBaseCategory root,
                         GanymedeSession session,
                         boolean hideNonEditables)

Server side constructor for the viewable subset of the category tree

Method Detail

getTree

public CategoryDump getTree()

Client side accessor

addCategoryInfo

private void addCategoryInfo(DBBaseCategory category)

containsEditableBase

private boolean containsEditableBase(DBBaseCategory category)

containsVisibleBase

private boolean containsVisibleBase(DBBaseCategory category)

addBaseInfo

private void addBaseInfo(DBObjectBase node)

addChunk

private void addChunk(java.lang.String text)