de.innovationgate.webgate.api

Class WGTransientPortlet

java.lang.Object

de.innovationgate.webgate.api.WGTransientPortlet

All Implemented Interfaces:

WGPortlet, java.io.Serializable

public class WGTransientPortlet
extends java.lang.Object
implements WGPortlet, java.io.Serializable

Implementation for a transient portlet, registered only for a single request in memory, used by the WGTransientPortletRegistry

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,WGTransientPortlet>	_childPortlets

Constructor Summary

Constructors

Constructor and Description
WGTransientPortlet(WGTransientPortletRegistry registry, java.lang.String appDb) For root portlets without key supply
WGTransientPortlet(WGTransientPortletRegistry registry, java.lang.String appDb, java.lang.String key) For root portlets with direct key supply
WGTransientPortlet(WGTransientPortletRegistry registry, java.lang.String appDb, WGTransientPortlet parentPortlet)

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	generateKey(java.lang.String appDb, java.lang.String parentPortletKey, java.lang.String name) Generates the portlet key for a transient portlet with the given specs.
java.lang.String	getApplicationDb() Returns the database key of the application using this portlet registration
java.util.Map<java.lang.String,WGTransientPortlet>	getChildPortlets() Returns the immediate child portlets of this portlet
java.lang.String	getDesign() Returns the name of the WebTML module used as portlet design
java.lang.String	getDesignDb() Returns the database key of the application containing the portlet design
java.lang.String	getKey() Returns the registration key of the portlet
java.lang.String	getName() Returns the registration name of the portlet
WGTransientPortlet	getParentPortlet() Returns the parent portlet of this portlet, null if it is the root portlet
java.lang.String	getParentPortletKey() Returns the registration key of the parent portlet
boolean	isRoot() Determines if this is the root portlet
void	setDesign(java.lang.String design) Sets the name of the WebTML module used as portlet design
void	setDesignDb(java.lang.String db) Sets the database key of the application containing the portlet design
void	setName(java.lang.String name) Sets the registration name of the portlet

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_childPortlets

public java.util.Map<java.lang.String,WGTransientPortlet> _childPortlets

Constructor Detail

WGTransientPortlet

public WGTransientPortlet(WGTransientPortletRegistry registry,
                  java.lang.String appDb,
                  WGTransientPortlet parentPortlet)

WGTransientPortlet

public WGTransientPortlet(WGTransientPortletRegistry registry,
                  java.lang.String appDb,
                  java.lang.String key)

For root portlets with direct key supply

Parameters:

registry - The portlet registry

appDb - The application of the portlet

key - The key of the portlet

WGTransientPortlet

public WGTransientPortlet(WGTransientPortletRegistry registry,
                  java.lang.String appDb)

For root portlets without key supply

Parameters:

registry - The portlet registry

appDb - The application of the portlet

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: WGPortlet

Returns the registration key of the portlet

Specified by:

getKey in interface WGPortlet

generateKey

public static java.lang.String generateKey(java.lang.String appDb,
                           java.lang.String parentPortletKey,
                           java.lang.String name)

Generates the portlet key for a transient portlet with the given specs. For transient portlets the portlet key is generated by the names of involved portlets and the application id. Portlets with equal name path from the same application represent the same portlet and therefor have the same portlet key.

Parameters:

appDb - The application id of the portlet application, as given by WGPortletRegistry.getApplicationId(WGDatabase)

parentPortletKey - The key of the parent portlet. null if the key should be generated for a root portlet.

name - The name of the porlet. null if the key should be generated for a root portlet.

Returns:

The portlet key for the given specs.

getChildPortlets

public java.util.Map<java.lang.String,WGTransientPortlet> getChildPortlets()

Returns the immediate child portlets of this portlet

getParentPortlet

public WGTransientPortlet getParentPortlet()

Returns the parent portlet of this portlet, null if it is the root portlet

getName

public java.lang.String getName()

Description copied from interface: WGPortlet

Returns the registration name of the portlet

Specified by:

getName in interface WGPortlet

getApplicationDb

public java.lang.String getApplicationDb()

Description copied from interface: WGPortlet

Returns the database key of the application using this portlet registration

Specified by:

getApplicationDb in interface WGPortlet

getDesign

public java.lang.String getDesign()

Description copied from interface: WGPortlet

Returns the name of the WebTML module used as portlet design

Specified by:

getDesign in interface WGPortlet

getDesignDb

public java.lang.String getDesignDb()

Description copied from interface: WGPortlet

Returns the database key of the application containing the portlet design

Specified by:

getDesignDb in interface WGPortlet

setDesignDb

public void setDesignDb(java.lang.String db)

Description copied from interface: WGPortlet

Sets the database key of the application containing the portlet design

Specified by:

setDesignDb in interface WGPortlet

setDesign

public void setDesign(java.lang.String design)

Description copied from interface: WGPortlet

Sets the name of the WebTML module used as portlet design

Specified by:

setDesign in interface WGPortlet

setName

public void setName(java.lang.String name)

Description copied from interface: WGPortlet

Sets the registration name of the portlet

Specified by:

setName in interface WGPortlet

getParentPortletKey

public java.lang.String getParentPortletKey()

Description copied from interface: WGPortlet

Returns the registration key of the parent portlet

Specified by:

getParentPortletKey in interface WGPortlet

isRoot

public boolean isRoot()

Description copied from interface: WGPortlet

Determines if this is the root portlet

Specified by:

isRoot in interface WGPortlet