org.apache.jetspeed.portal
Class JetspeedPortletInstance

java.lang.Object
  org.apache.jetspeed.portal.JetspeedPortletInstance

All Implemented Interfaces:

PortletInstance

public class JetspeedPortletInstance

extends java.lang.Object

implements PortletInstance

Default Implementation of Jetspeed Portlet Instance. It implements the methods for getting, setting and removing attributes from portlet instance persistence storage. In a Jetspeed 1.4x PSML profile, the default XML format for an instance and attribute is: Since this modifies PSMLDocuments, it will make a clone once modification starts.

Version:

$Id: JetspeedPortletInstance.java,v 1.9 2004/02/23 04:05:35 jford Exp $

Author:

Scott Weaver, Glenn R. Golden

Constructor Summary

protected	JetspeedPortletInstance() Protect the constructor so it can only be instantitated by by the PortalPersistenceService
	JetspeedPortletInstance(Portlet portlet, Profile profile) Constructs a PortletInstance from a Portlet and a Profile
	JetspeedPortletInstance(Portlet portlet, org.apache.turbine.util.RunData data) Constructs a PortletInstance from a Portlet and a RunData.

Method Summary

java.lang.String	getAttribute(java.lang.String name) Retrieves an attributes value associated with a named object from a portlet instance's persistence storage.
java.lang.String	getAttribute(java.lang.String name, java.lang.String dftValue) Retrieves an attributes value associated with a named object from a portlet instance's persistence storage.
java.util.Iterator	getAttributeNames() Retrieves a list of all attributes names for all the attributes contained within this portlet instance.
java.util.Iterator	getAttributes() Retrieves a list of all of the attributes of this portlet instance as org.apache.jetspeed.om.profile.Parameter objects.
org.apache.ecs.ConcreteElement	getContent()
java.lang.String	getDescription() Retrieves the description (if it is defined) of the parent portlet as it is defined within the portlet registry.
PSMLDocument	getDocument() Returns the PSMLDocument that contains this portlet instance.
Entry	getEntry() Returns the PSML OM instance associated with this instance.
java.lang.String	getImage()
java.lang.String	getName() Retrieves the name of the parent portlet as it is defined within the portlet registry.
Portlet	getPortlet() Returns the parent portlet of this PortletInstance.
Profile	getProfile() Returns the Profile instance containing this portlet instance.
java.lang.String	getTitle() Retrieves the title (if it is defined) of the parent portlet as it is defined within the portlet registry.
boolean	isShowTitleBar()
void	removeAllAttributes() Removes all portlet instance attributes from persistence storage.
void	removeAttribute(java.lang.String name) Removes a portlet instance attribute from persistence storage.
void	setAttribute(java.lang.String name, java.lang.String value) Sets a portlet instance attribute into persistence storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

JetspeedPortletInstance

public JetspeedPortletInstance(Portlet portlet,
                               org.apache.turbine.util.RunData data)

Constructs a PortletInstance from a Portlet and a RunData.

JetspeedPortletInstance

public JetspeedPortletInstance(Portlet portlet,
                               Profile profile)

Constructs a PortletInstance from a Portlet and a Profile

JetspeedPortletInstance

protected JetspeedPortletInstance()

Protect the constructor so it can only be instantitated by by the PortalPersistenceService

Method Detail

getAttribute

public java.lang.String getAttribute(java.lang.String name,
                                     java.lang.String dftValue)

Description copied from interface: PortletInstance

Retrieves an attributes value associated with a named object from a portlet instance's persistence storage.

Specified by:

getAttribute in interface PortletInstance

Parameters:

name - The name of the attribute

dftValue - The default value if the attribute is not found.

Returns:

String The attribute value, or the defaultValue if not found.

See Also:

PortletInstance#getAttribute()

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Description copied from interface: PortletInstance

Retrieves an attributes value associated with a named object from a portlet instance's persistence storage.

Specified by:

getAttribute in interface PortletInstance

Parameters:

name - The name of the attribute

Returns:

String The attribute value, or the empty string if not found.

See Also:

PortletInstance#getAttribute()

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

Description copied from interface: PortletInstance

Sets a portlet instance attribute into persistence storage.

Specified by:

setAttribute in interface PortletInstance

Parameters:

name - The name of the attribute.

value - The value of the attribute.

See Also:

PortletInstance.setAttribute(String, String)

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from interface: PortletInstance

Removes a portlet instance attribute from persistence storage.

Specified by:

removeAttribute in interface PortletInstance

Parameters:

name - The name of the attribute.

See Also:

PortletInstance.removeAttribute(String)

removeAllAttributes

public void removeAllAttributes()

Description copied from interface: PortletInstance

Removes all portlet instance attributes from persistence storage.

Specified by:

removeAllAttributes in interface PortletInstance

See Also:

PortletInstance.removeAllAttributes()

getAttributes

public java.util.Iterator getAttributes()

Description copied from interface: PortletInstance

Retrieves a list of all of the attributes of this portlet instance as org.apache.jetspeed.om.profile.Parameter objects.

Specified by:

getAttributes in interface PortletInstance

Returns:

java.util.Iterator

See Also:

PortletInstance.getAttributes()

getAttributeNames

public java.util.Iterator getAttributeNames()

Description copied from interface: PortletInstance

Retrieves a list of all attributes names for all the attributes contained within this portlet instance.

Specified by:

getAttributeNames in interface PortletInstance

Returns:

java.util.Iterator

See Also:

PortletInstance.getAttributeNames()

getDocument

public PSMLDocument getDocument()

Description copied from interface: PortletInstance

Returns the PSMLDocument that contains this portlet instance.

Specified by:

getDocument in interface PortletInstance

Returns:

org.apache.jetspeed.om.profile.PSMLDocument

See Also:

PortletInstance.getDocument()

getProfile

public Profile getProfile()

Description copied from interface: PortletInstance

Returns the Profile instance containing this portlet instance.

Specified by:

getProfile in interface PortletInstance

Returns:

org.apache.jetspeed.om.profile.Profile

See Also:

PortletInstance.getProfile()

getEntry

public Entry getEntry()

Description copied from interface: PortletInstance

Returns the PSML OM instance associated with this instance.

Specified by:

getEntry in interface PortletInstance

Returns:

org.apache.jetspeed.om.profile.Entry

See Also:

PortletInstance.getPortlet()

getDescription

public java.lang.String getDescription()

Description copied from interface: PortletInstance

Retrieves the description (if it is defined) of the parent portlet as it is defined within the portlet registry.

Specified by:

getDescription in interface PortletInstance

Returns:

String The description of the portlet.

See Also:

PortletInstance.getDescription()

getName

public java.lang.String getName()

Description copied from interface: PortletInstance

Retrieves the name of the parent portlet as it is defined within the portlet registry.

Specified by:

getName in interface PortletInstance

Returns:

String The name of the portlet.

See Also:

PortletInstance.getName()

getTitle

public java.lang.String getTitle()

Description copied from interface: PortletInstance

Retrieves the title (if it is defined) of the parent portlet as it is defined within the portlet registry.

Specified by:

getTitle in interface PortletInstance

Returns:

String The title of the portlet.

See Also:

PortletInstance.getTitle()

getImage

public java.lang.String getImage()

See Also:

PortletInstance#getImage()

getPortlet

public Portlet getPortlet()

Description copied from interface: PortletInstance

Returns the parent portlet of this PortletInstance.

Specified by:

getPortlet in interface PortletInstance

Returns:

org.apache.jetspeed.portal.Portlet

See Also:

PortletInstance.getPortlet()

getContent

public org.apache.ecs.ConcreteElement getContent()

See Also:

PortletInstance#getContent()

isShowTitleBar

public boolean isShowTitleBar()

See Also:

PortletInstance#isShowTitleBar()