org.apache.jetspeed.om.profile.psml
Class PsmlReference

java.lang.Object
  org.apache.jetspeed.om.profile.psml.PsmlConfigElement
      org.apache.jetspeed.om.profile.psml.PsmlIdentityElement
          org.apache.jetspeed.om.profile.psml.PsmlPortlets
              org.apache.jetspeed.om.profile.psml.PsmlReference

All Implemented Interfaces:

java.lang.Cloneable, ConfigElement, IdentityElement, MetaInfo, Portlets, Reference, java.io.Serializable

public class PsmlReference

extends PsmlPortlets

implements Reference, java.io.Serializable

Base simple bean-like implementation of the Portlets interface suitable for Castor XML serialization. sure wish I could figure out how to use Proxies with Castor...

Version:

$Id: PsmlReference.java,v 1.5 2004/02/23 03:02:54 jford Exp $

Author:

David Sean Taylor

See Also:

Serialized Form

Field Summary

protected java.lang.String	path
protected PsmlPortlets	ref

Constructor Summary

PsmlReference()

Method Summary

void	addEntry(Entry entry)
void	addParameter(Parameter vParameter)
void	addPortlets(Portlets p)
void	addReference(Reference ref)
java.lang.Object	clone() Create a clone of this object
Control	getControl()
Controller	getController()
java.lang.String	getDescription()
java.util.Vector	getEntries()
Entry[]	getEntriesArray()
java.util.Iterator	getEntriesIterator()
Entry	getEntry(int index)
int	getEntryCount()
java.lang.String	getImage()
MetaInfo	getMetaInfo() Required by Castor 0.8.11 XML serialization for retrieving the metainfo
Parameter[]	getParameter()
Parameter	getParameter(int index)
Parameter	getParameter(java.lang.String name)
int	getParameterCount()
java.util.Iterator	getParameterIterator()
java.util.Vector	getParameters()
java.lang.String	getParameterValue(java.lang.String name)
java.lang.String	getPath()
java.util.Vector	getPortlets() Return a list of portlet.
Portlets	getPortlets(int index)
Portlets[]	getPortletsArray()
int	getPortletsCount()
java.util.Iterator	getPortletsIterator()
Portlets	getPortletsReference()
Reference	getReference(int index)
Reference[]	getReferenceArray()
int	getReferenceCount()
java.util.Iterator	getReferenceIterator()
Security	getSecurity()
SecurityReference	getSecurityRef() Getter for property securityRef.
java.lang.String	getTitle()
void	removeAllParameter()
Entry	removeEntry(int index)
Parameter	removeParameter(int index)
Portlets	removePortlets(int index)
Reference	removeReference(int index)
void	setControl(Control control)
void	setController(Controller controller)
void	setDescription(java.lang.String description) Sets the descsription of this parameter.value.
void	setEntries(java.util.Vector entries)
void	setImage(java.lang.String image) Sets the image name of this parameter.
void	setParameter(int index, Parameter vParameter)
void	setParameters(java.util.Vector parameters) Sets the parameters for this element
void	setPath(java.lang.String path)
void	setPortlets(java.util.Vector portlets)
void	setSecurity(Security security)
void	setSecurityRef(SecurityReference securityRef) Setter for property securityRef.
void	setTitle(java.lang.String title) Sets the descsription of this parameter.value.

Methods inherited from class org.apache.jetspeed.om.profile.psml.PsmlPortlets

addPortlets, addReference, getParentPortlets, getReferences, setParentPortlets

Methods inherited from class org.apache.jetspeed.om.profile.psml.PsmlIdentityElement

getId, getLayout, getSkin, setId, setLayout, setMetaInfo, setSkin

Methods inherited from class org.apache.jetspeed.om.profile.psml.PsmlConfigElement

getName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jetspeed.om.profile.Portlets

getParentPortlets, setParentPortlets

Methods inherited from interface org.apache.jetspeed.om.profile.IdentityElement

getId, getLayout, getSkin, setId, setLayout, setMetaInfo, setSkin

Methods inherited from interface org.apache.jetspeed.om.profile.ConfigElement

getName, setName

Field Detail

path

protected java.lang.String path

ref

protected PsmlPortlets ref

Constructor Detail

PsmlReference

public PsmlReference()

Method Detail

getPortletsReference

public Portlets getPortletsReference()

Specified by:

getPortletsReference in interface Reference

setPath

public void setPath(java.lang.String path)

Specified by:

setPath in interface Reference

getPath

public java.lang.String getPath()

Specified by:

getPath in interface Reference

getController

public Controller getController()

Specified by:

getController in interface Portlets

Overrides:

getController in class PsmlPortlets

setController

public void setController(Controller controller)

Specified by:

setController in interface Portlets

Overrides:

setController in class PsmlPortlets

setSecurity

public void setSecurity(Security security)

Specified by:

setSecurity in interface Portlets

Overrides:

setSecurity in class PsmlPortlets

getSecurity

public Security getSecurity()

Specified by:

getSecurity in interface Portlets

Overrides:

getSecurity in class PsmlPortlets

getEntries

public java.util.Vector getEntries()

Overrides:

getEntries in class PsmlPortlets

setEntries

public void setEntries(java.util.Vector entries)

Overrides:

setEntries in class PsmlPortlets

getPortlets

public java.util.Vector getPortlets()

Description copied from class: PsmlPortlets

Return a list of portlet. Portlets that where added via a reference, see addReference(), are excluded.

Overrides:

getPortlets in class PsmlPortlets

Returns:

Vector of portlet

setPortlets

public void setPortlets(java.util.Vector portlets)

Overrides:

setPortlets in class PsmlPortlets

getEntryCount

public int getEntryCount()

Specified by:

getEntryCount in interface Portlets

Overrides:

getEntryCount in class PsmlPortlets

getPortletsCount

public int getPortletsCount()

Specified by:

getPortletsCount in interface Portlets

Overrides:

getPortletsCount in class PsmlPortlets

removeEntry

public Entry removeEntry(int index)

Specified by:

removeEntry in interface Portlets

Overrides:

removeEntry in class PsmlPortlets

removePortlets

public Portlets removePortlets(int index)

Specified by:

removePortlets in interface Portlets

Overrides:

removePortlets in class PsmlPortlets

getEntry

public Entry getEntry(int index)
               throws java.lang.IndexOutOfBoundsException

Specified by:

getEntry in interface Portlets

Overrides:

getEntry in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

getPortlets

public Portlets getPortlets(int index)
                     throws java.lang.IndexOutOfBoundsException

Specified by:

getPortlets in interface Portlets

Overrides:

getPortlets in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

getEntriesIterator

public java.util.Iterator getEntriesIterator()

Specified by:

getEntriesIterator in interface Portlets

Overrides:

getEntriesIterator in class PsmlPortlets

getPortletsIterator

public java.util.Iterator getPortletsIterator()

Specified by:

getPortletsIterator in interface Portlets

Overrides:

getPortletsIterator in class PsmlPortlets

addEntry

public void addEntry(Entry entry)
              throws java.lang.IndexOutOfBoundsException

Specified by:

addEntry in interface Portlets

Overrides:

addEntry in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

addPortlets

public void addPortlets(Portlets p)
                 throws java.lang.IndexOutOfBoundsException

Specified by:

addPortlets in interface Portlets

Overrides:

addPortlets in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

getEntriesArray

public Entry[] getEntriesArray()

Specified by:

getEntriesArray in interface Portlets

Overrides:

getEntriesArray in class PsmlPortlets

getPortletsArray

public Portlets[] getPortletsArray()

Specified by:

getPortletsArray in interface Portlets

Overrides:

getPortletsArray in class PsmlPortlets

getControl

public Control getControl()

Specified by:

getControl in interface IdentityElement

Overrides:

getControl in class PsmlIdentityElement

See Also:

IdentityElement.getControl()

setControl

public void setControl(Control control)

Specified by:

setControl in interface IdentityElement

Overrides:

setControl in class PsmlIdentityElement

See Also:

IdentityElement.setControl(org.apache.jetspeed.om.profile.Control)

getMetaInfo

public MetaInfo getMetaInfo()

Required by Castor 0.8.11 XML serialization for retrieving the metainfo

Specified by:

getMetaInfo in interface IdentityElement

Overrides:

getMetaInfo in class PsmlIdentityElement

See Also:

IdentityElement.getMetaInfo()

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface MetaInfo

Overrides:

getTitle in class PsmlIdentityElement

See Also:

MetaInfo.getTitle()

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: MetaInfo

Sets the descsription of this parameter.value.

Specified by:

setTitle in interface MetaInfo

Overrides:

setTitle in class PsmlIdentityElement

See Also:

MetaInfo.setTitle(java.lang.String)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface MetaInfo

Overrides:

getDescription in class PsmlIdentityElement

See Also:

MetaInfo.getDescription()

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: MetaInfo

Sets the descsription of this parameter.value.

Specified by:

setDescription in interface MetaInfo

Overrides:

setDescription in class PsmlIdentityElement

See Also:

MetaInfo.setDescription(java.lang.String)

getImage

public java.lang.String getImage()

Specified by:

getImage in interface MetaInfo

Overrides:

getImage in class PsmlIdentityElement

See Also:

MetaInfo.getImage()

setImage

public void setImage(java.lang.String image)

Description copied from interface: MetaInfo

Sets the image name of this parameter.

Specified by:

setImage in interface MetaInfo

Overrides:

setImage in class PsmlIdentityElement

See Also:

MetaInfo.setImage(java.lang.String)

getParameters

public java.util.Vector getParameters()

Overrides:

getParameters in class PsmlConfigElement

Returns:

the parameters

setParameters

public void setParameters(java.util.Vector parameters)

Sets the parameters for this element

Overrides:

setParameters in class PsmlConfigElement

Parameters:

parameters -

getParameterValue

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

Specified by:

getParameterValue in interface ConfigElement

Overrides:

getParameterValue in class PsmlConfigElement

getParameter

public Parameter getParameter(java.lang.String name)

Specified by:

getParameter in interface ConfigElement

Overrides:

getParameter in class PsmlConfigElement

getParameterIterator

public java.util.Iterator getParameterIterator()

Specified by:

getParameterIterator in interface ConfigElement

Overrides:

getParameterIterator in class PsmlConfigElement

getParameter

public Parameter getParameter(int index)
                       throws java.lang.IndexOutOfBoundsException

Specified by:

getParameter in interface ConfigElement

Overrides:

getParameter in class PsmlConfigElement

Throws:

java.lang.IndexOutOfBoundsException

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface ConfigElement

Overrides:

getParameterCount in class PsmlConfigElement

getReferenceCount

public int getReferenceCount()

Specified by:

getReferenceCount in interface Portlets

Overrides:

getReferenceCount in class PsmlPortlets

removeAllParameter

public void removeAllParameter()

Specified by:

removeAllParameter in interface ConfigElement

Overrides:

removeAllParameter in class PsmlConfigElement

removeParameter

public Parameter removeParameter(int index)

Specified by:

removeParameter in interface ConfigElement

Overrides:

removeParameter in class PsmlConfigElement

setParameter

public void setParameter(int index,
                         Parameter vParameter)
                  throws java.lang.IndexOutOfBoundsException

Specified by:

setParameter in interface ConfigElement

Overrides:

setParameter in class PsmlConfigElement

Throws:

java.lang.IndexOutOfBoundsException

getParameter

public Parameter[] getParameter()

Specified by:

getParameter in interface ConfigElement

Overrides:

getParameter in class PsmlConfigElement

addParameter

public void addParameter(Parameter vParameter)
                  throws java.lang.IndexOutOfBoundsException

Specified by:

addParameter in interface ConfigElement

Overrides:

addParameter in class PsmlConfigElement

Throws:

java.lang.IndexOutOfBoundsException

getReference

public Reference getReference(int index)
                       throws java.lang.IndexOutOfBoundsException

Specified by:

getReference in interface Portlets

Overrides:

getReference in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

removeReference

public Reference removeReference(int index)

Specified by:

removeReference in interface Portlets

Overrides:

removeReference in class PsmlPortlets

getReferenceIterator

public java.util.Iterator getReferenceIterator()

Specified by:

getReferenceIterator in interface Portlets

Overrides:

getReferenceIterator in class PsmlPortlets

addReference

public void addReference(Reference ref)
                  throws java.lang.IndexOutOfBoundsException

Specified by:

addReference in interface Portlets

Overrides:

addReference in class PsmlPortlets

Throws:

java.lang.IndexOutOfBoundsException

getReferenceArray

public Reference[] getReferenceArray()

Specified by:

getReferenceArray in interface Portlets

Overrides:

getReferenceArray in class PsmlPortlets

getSecurityRef

public SecurityReference getSecurityRef()

Getter for property securityRef.

Specified by:

getSecurityRef in interface Portlets

Overrides:

getSecurityRef in class PsmlPortlets

Returns:

Value of property securityRef.

setSecurityRef

public void setSecurityRef(SecurityReference securityRef)

Setter for property securityRef.

Specified by:

setSecurityRef in interface Portlets

Overrides:

setSecurityRef in class PsmlPortlets

Parameters:

securityRef - New value of property securityRef.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Create a clone of this object

Specified by:

clone in interface MetaInfo

Overrides:

clone in class PsmlPortlets

Throws:

java.lang.CloneNotSupportedException