Package com.sun.portal.portletcontainer.admin.registry

Class AbstractPortletRegistryElement

java.lang.Object

com.sun.portal.portletcontainer.admin.registry.AbstractPortletRegistryElement

All Implemented Interfaces:

PortletRegistryElement, PortletRegistryTags

Direct Known Subclasses:

PortletApp, PortletWindow, PortletWindowPreference

public abstract class AbstractPortletRegistryElement
extends Object
implements PortletRegistryTags, PortletRegistryElement

AbstractPortletRegistryElement provides partial implementation of the PortletRegistryElement interface. It has implementation for the methods that are common to all elements like PortletApp, PortletWindow or PortletWindowPreference

Field Summary

Fields inherited from interface com.sun.portal.portletcontainer.admin.registry.PortletRegistryTags

ARCHIVE_KEY, ARCHIVE_NAME_KEY, ARCHIVE_TYPE_KEY, COLLECTION_TAG, CONSUMER_ID, DESCRIPTION_KEY, DESCRIPTION_MAP_KEY, DISPLAY_NAME_MAP_KEY, ENTITY_ID_PREFIX_KEY, KEYWORDS_KEY, LANG, NAME_KEY, PORTLET_APP_REGISTRY_TAG, PORTLET_APP_TAG, PORTLET_HANDLE, PORTLET_ID, PORTLET_NAME_KEY, PORTLET_WINDOW_PREFERENCE_REGISTRY_TAG, PORTLET_WINDOW_PREFERENCE_TAG, PORTLET_WINDOW_REGISTRY_TAG, PORTLET_WINDOW_TAG, PREFERENCE_PROPERTIES_KEY, PREFERENCE_READ_ONLY_KEY, PRODUCER_ENTITY_ID, PROPERTIES_TAG, REMOTE_KEY, ROLE_DESCRIPTIONS_KEY, ROLE_MAP_KEY, ROW_KEY, SHORT_TITLE_KEY, STRING_TAG, SUPPORTED_CONTENT_TYPES_KEY, SUPPORTED_LOCALES_KEY, SUPPORTS_MAP_KEY, TITLE_KEY, TRANSPORT_GUARANTEE_KEY, USER_INFO_DESCRIPTIONS_KEY, USER_INFO_MAP_KEY, USER_NAME_KEY, VALUE_KEY, VERSION_KEY, VISIBLE_KEY, WIDTH_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractPortletRegistryElement()

Method Summary

Modifier and Type	Method	Description
protected void	create(Document document, Element propertiesTag)
Map<String,Object>	getCollectionProperty(String key)	Returns the values contained in the Collection tag specified by the key.
String	getLang()	Returns the value of the "lang" attribute for the String tag specified by the key.
protected Map<String,Map<String,Object>>	getMapCollectionTable()
String	getName()	Returns the value of "name" attribute of the registry element
String	getPortletName()	Returns the value of "portletName" attribute of the registry element
String	getRemote()	Returns the value of "isRemote" attribute of the registry element
protected Map<String,String>	getStringCollectionTable()
String	getStringProperty(String key)	Returns the value of the "name" attribute for the String tag specified by the key.
String	getUserName()	Returns the value of "userName" attribute of the registry element
protected void	populateValues(Element rootTag)
void	setCollectionProperty(String key, List<String> values)	Set the values for the Collection tag specified by the key.
void	setCollectionProperty(String key, Map<String,Object> values)	Set the values for the Collection tag specified by the key.
void	setLang(String lang)	Set the value of the "lang" attribute of the String tag.
void	setName(String name)	Set the value of the "name" attribute of the registry element.
void	setPortletName(String portletName)	Set the value of the "portletName" attribute of the registry element.
void	setRemote(String isRemote)	Set the value of the "isRemote" attribute of the registry element.
void	setStringProperty(String key, String value)
void	setUserName(String userName)	Set the value of the "userName" attribute of the registry element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPortletRegistryElement

public AbstractPortletRegistryElement()

Method Detail

setCollectionProperty

public void setCollectionProperty(String key,
                                  Map<String,Object> values)

Description copied from interface: PortletRegistryElement

Set the values for the Collection tag specified by the key. This Collection tag is contained within the registry element. Each key in the Map is represented as a value of the "name" attribute in the String tag and value for the key is represented as a value for the "value" attribute in the String tag. This String tag is contained within the Collection tag

Specified by:

setCollectionProperty in interface PortletRegistryElement

Parameters:

key - the value for the "name" attribute of the Collection tag.

values - represented by "name" and "value" attribute of the String tags.

getCollectionProperty

public Map<String,Object> getCollectionProperty(String key)

Description copied from interface: PortletRegistryElement

Returns the values contained in the Collection tag specified by the key. The Collection tag contains String tags. This String tag has either "name" attribute or both "name" and "value" attribute. If the String tag has only "name" attribute, the Map returned contains the value of the "name" attribute as both key and value. If the String tag has both "name" and "value" attribute, the Map returned contains the value of the "name" attribute as key and value of the "value" attribute as value.

Specified by:

getCollectionProperty in interface PortletRegistryElement

Returns:

a Map, the value of attributes "name" and "value" of String tag.

setCollectionProperty

public void setCollectionProperty(String key,
                                  List<String> values)

Description copied from interface: PortletRegistryElement

Set the values for the Collection tag specified by the key. This Collection tag is contained within the registry element. Each value in the list is represented as a value of the "value" attribute in the String tag. This String tag is contained within the Collection tag.

Specified by:

setCollectionProperty in interface PortletRegistryElement

Parameters:

key - the value for the "name" attribute of the Collection tag.

values - represented by "value" attribute of the String tags.

setStringProperty

public void setStringProperty(String key,
                              String value)

Specified by:

setStringProperty in interface PortletRegistryElement

getStringProperty

public String getStringProperty(String key)

Description copied from interface: PortletRegistryElement

Returns the value of the "name" attribute for the String tag specified by the key.

Specified by:

getStringProperty in interface PortletRegistryElement

Returns:

a String, the value represented by the "name" attribute for the String tag

getName

public String getName()

Description copied from interface: PortletRegistryElement

Returns the value of "name" attribute of the registry element

Specified by:

getName in interface PortletRegistryElement

Returns:

a String, the value of "name" attribute of the registry element.

setName

public void setName(String name)

Description copied from interface: PortletRegistryElement

Set the value of the "name" attribute of the registry element.

Specified by:

setName in interface PortletRegistryElement

Parameters:

name - the value of the "name" attribute of the registry element.

getPortletName

public String getPortletName()

Description copied from interface: PortletRegistryElement

Returns the value of "portletName" attribute of the registry element

Specified by:

getPortletName in interface PortletRegistryElement

Returns:

a String, the value of "portletName" attribute of the registry element.

setPortletName

public void setPortletName(String portletName)

Description copied from interface: PortletRegistryElement

Set the value of the "portletName" attribute of the registry element.

Specified by:

setPortletName in interface PortletRegistryElement

Parameters:

portletName - the value of the "portletName" attribute of the registry element.

getLang

public String getLang()

Description copied from interface: PortletRegistryElement

Returns the value of the "lang" attribute for the String tag specified by the key.

Specified by:

getLang in interface PortletRegistryElement

Returns:

a String, the value represented by the "lang" attribute for the String tag

setLang

public void setLang(String lang)

Description copied from interface: PortletRegistryElement

Set the value of the "lang" attribute of the String tag.

Specified by:

setLang in interface PortletRegistryElement

Parameters:

lang - the value represented by the "lang" attribute for the String tag

getUserName

public String getUserName()

Description copied from interface: PortletRegistryElement

Returns the value of "userName" attribute of the registry element

Specified by:

getUserName in interface PortletRegistryElement

Returns:

a String, the value of "userName" attribute of the registry element.

setUserName

public void setUserName(String userName)

Description copied from interface: PortletRegistryElement

Set the value of the "userName" attribute of the registry element.

Specified by:

setUserName in interface PortletRegistryElement

Parameters:

userName - the value of the "userName" attribute of the registry element.

getRemote

public String getRemote()

Description copied from interface: PortletRegistryElement

Returns the value of "isRemote" attribute of the registry element

Specified by:

getRemote in interface PortletRegistryElement

Returns:

a String, the value of "isRemote" attribute of the registry element.

setRemote

public void setRemote(String isRemote)

Description copied from interface: PortletRegistryElement

Set the value of the "isRemote" attribute of the registry element.

Specified by:

setRemote in interface PortletRegistryElement

Parameters:

isRemote - the value of the "isRemote" attribute of the registry element.

getMapCollectionTable

protected Map<String,Map<String,Object>> getMapCollectionTable()

getStringCollectionTable

protected Map<String,String> getStringCollectionTable()

populateValues

protected void populateValues(Element rootTag)

create

protected void create(Document document,
                      Element propertiesTag)