raphael 2002/11/03 07:07:35
Modified: src/java/org/apache/jetspeed/om/registry/base
BasePortletInfoEntry.java
Added: src/java/org/apache/jetspeed/om/registry/base
BaseToolDescriptor.java
Log:
Add PortletTool support to Registry
Revision Changes Path
1.4 +294 -45
jakarta-jetspeed/src/java/org/apache/jetspeed/om/registry/base/BasePortletInfoEntry.java
Index: BasePortletInfoEntry.java
===================================================================
RCS file:
/home/cvs/jakarta-jetspeed/src/java/org/apache/jetspeed/om/registry/base/BasePortletInfoEntry.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- BasePortletInfoEntry.java 28 Jun 2002 05:37:31 -0000 1.3
+++ BasePortletInfoEntry.java 3 Nov 2002 15:07:35 -0000 1.4
@@ -66,7 +66,7 @@
/**
* The BasePortletInfoEntry is a bean like implementation of the PortletInfoEntry
* interface suitable for Castor XML serialization
- *
+ *
* @see org.apache.jetspeed.om.registry.PortletInfoEntry
* @author <a href="mailto:raphael@;apache.org">Rapha�l Luta</a>
* @version $Id$
@@ -75,15 +75,131 @@
{
protected String classname;
-
+
protected Vector parameter = new Vector();
-
+
protected transient Map nameIdx = null;
-
+
protected Vector medias = new Vector();
-
+
protected transient Map mediasIdx = null;
-
+
+ protected Vector tools = new Vector();
+
+ protected transient Map toolsIdx = null;
+
+ /**
+ * Implements the equals operation so that 2 elements are equal if
+ * all their member values are equal.
+ */
+ public boolean equals(Object object)
+ {
+ if (object==null)
+ {
+ return false;
+ }
+
+ BasePortletInfoEntry obj = (BasePortletInfoEntry)object;
+
+ if (classname!=null)
+ {
+ if (!classname.equals(obj.getClassname()))
+ {
+ return false;
+ }
+ }
+ else
+ {
+ if (obj.getClassname()!=null)
+ {
+ return false;
+ }
+ }
+
+ Iterator i = parameter.iterator();
+ Iterator i2 = obj.getParameters().iterator();
+ while(i.hasNext())
+ {
+ BaseParameter p1 = (BaseParameter)i.next();
+ BaseParameter p2 = null;
+
+ if (i2.hasNext())
+ {
+ p2 = (BaseParameter)i2.next();
+ }
+ else
+ {
+ return false;
+ }
+
+ if (!p1.equals(p2))
+ {
+ return false;
+ }
+ }
+
+ if (i2.hasNext())
+ {
+ return false;
+ }
+
+ i = medias.iterator();
+ i2 = obj.getMediaTypes().iterator();
+ while(i.hasNext())
+ {
+ BaseMediaType m1 = (BaseMediaType)i.next();
+ BaseMediaType m2 = null;
+
+ if (i2.hasNext())
+ {
+ m2 = (BaseMediaType)i2.next();
+ }
+ else
+ {
+ return false;
+ }
+
+ if (!m1.equals(m2))
+ {
+ return false;
+ }
+ }
+
+ if (i2.hasNext())
+ {
+ return false;
+ }
+
+ i = tools.iterator();
+ i2 = obj.getTools().iterator();
+ while(i.hasNext())
+ {
+ BaseToolDescriptor t1 = (BaseToolDescriptor)i.next();
+ BaseToolDescriptor t2 = null;
+
+ if (i2.hasNext())
+ {
+ t2 = (BaseToolDescriptor)i2.next();
+ }
+ else
+ {
+ return false;
+ }
+
+ if (!t1.equals(t2))
+ {
+ return false;
+ }
+ }
+
+ if (i2.hasNext())
+ {
+ return false;
+ }
+
+ return super.equals(object);
+ }
+
/** @return the classname associated to this entry */
public String getClassname()
{
@@ -93,14 +209,14 @@
/** Sets the classname for this entry. This classname is used for instanciating
* the associated element
*
- * @param classname the classname used for instanciating the component
associated with
+ * @param classname the classname used for instanciating the component
associated with
* this entry
*/
public void setClassname( String classname )
{
this.classname = classname;
}
-
+
/** @return an enumeration of this entry parameter names */
public Iterator getParameterNames()
{
@@ -111,7 +227,7 @@
buildNameIndex();
}
}
-
+
return nameIdx.keySet().iterator();
}
@@ -141,12 +257,12 @@
return (Parameter)parameter.elementAt(pos.intValue());
}
}
-
+
return null;
}
-
-
- /** Returns a map of parameter values keyed on the parameter names
+
+
+ /** Returns a map of parameter values keyed on the parameter names
* @return the parameter values map
*/
public Map getParameterMap()
@@ -158,7 +274,7 @@
Parameter param = (Parameter)en.nextElement();
params.put(param.getName(),param.getValue());
}
- return params;
+ return params;
}
/** Adds a new parameter for this entry
@@ -178,11 +294,11 @@
p = new BaseParameter();
p.setName(name);
}
-
+
p.setValue(value);
-
+
addParameter(p);
-
+
}
}
@@ -195,7 +311,7 @@
{
if (parameter == null)
parameter = new Vector();
-
+
if (nameIdx == null)
buildNameIndex();
@@ -224,12 +340,12 @@
i.remove();
}
}
-
+
buildNameIndex();
}
}
-
- /**
+
+ /**
* Returns a list of the supported media type names
*
* @return an iterator on the supported media type names
@@ -237,21 +353,21 @@
public Iterator listMediaTypes()
{
if (mediasIdx == null)
- {
+ {
synchronized( medias )
{
buildMediasIndex();
}
}
-
+
return mediasIdx.keySet().iterator();
}
-
- /**
+
+ /**
* Test if a given media type is supported by this entry.
* The test is done by a case sensitive name comparison
*
- * @param name the media type name to test for.
+ * @param name the media type name to test for.
* @return true is the media type is supported false otherwise
*/
public boolean hasMediaType(String name)
@@ -262,14 +378,14 @@
{
buildMediasIndex();
}
- }
+ }
return ((name!=null)&&(mediasIdx.get(name)!=null));
}
-
- /**
+
+ /**
* Add a new supported media type
*
- * @param name the media type name to add.
+ * @param name the media type name to add.
*/
public void addMediaType(String name)
{
@@ -284,11 +400,11 @@
}
}
}
-
- /**
+
+ /**
* Remove support for a given media type
*
- * @param name the media type name to remove.
+ * @param name the media type name to remove.
*/
public void removeMediaType(String name)
{
@@ -310,10 +426,10 @@
}
}
}
-
+
// Castor serialization accessor methods
-
- /** Needed for Castor 0.8.11 XML serialization for retrieving the
+
+ /** Needed for Castor 0.8.11 XML serialization for retrieving the
* parameters objects associated to this object
*/
public Vector getParameters()
@@ -331,7 +447,7 @@
this.medias = mediaTypes;
}
- /** Needed for Castor 0.8.11 XML serialization for retrieving the
+ /** Needed for Castor 0.8.11 XML serialization for retrieving the
* media type names associated to this object
*/
public Vector getMediaTypes()
@@ -339,15 +455,25 @@
return this.medias;
}
+ public Vector getTools()
+ {
+ return this.tools;
+ }
+
+ public void setTools(Vector tools)
+ {
+ this.tools = tools;
+ }
+
/** This method recreates the paramter name index for quick retrieval
* of parameters by name. Shoule be called whenever a complete index
- * of parameter should be rebuilt (eg removing a parameter or setting
+ * of parameter should be rebuilt (eg removing a parameter or setting
* a parameters vector)
*/
protected void buildNameIndex()
{
Hashtable idx = new Hashtable();
-
+
Iterator i = parameter.iterator();
int count = 0;
while( i.hasNext() )
@@ -356,9 +482,9 @@
idx.put( p.getName(), new Integer(count) );
count++;
}
-
+
this.nameIdx = idx;
- }
+ }
/** This method recreates the media name index for quick retrieval
* by name.
@@ -366,7 +492,7 @@
private void buildMediasIndex()
{
Hashtable idx = new Hashtable();
-
+
Iterator i = medias.iterator();
int count = 0;
while( i.hasNext() )
@@ -375,7 +501,130 @@
idx.put( b.getRef(), new Integer(count) );
count++;
}
-
+
this.mediasIdx = idx;
- }
+ }
+
+ /** @return an enumeration of this entry parameter names */
+ public Iterator getToolNames()
+ {
+ synchronized (tools)
+ {
+ if (toolsIdx == null)
+ {
+ buildToolsIndex();
+ }
+ }
+
+ return toolsIdx.keySet().iterator();
+ }
+
+
+ /** Search for a named parameter and return the associated
+ * parameter object. The search is case sensitive.
+ *
+ * @return the parameter object for a given parameter name
+ * @param name the parameter name to look for
+ */
+ public ToolDescriptor getTool( String name )
+ {
+ synchronized (tools)
+ {
+ if (toolsIdx == null)
+ {
+ buildToolsIndex();
+ }
+ }
+
+ if (name != null)
+ {
+ Integer pos = (Integer)toolsIdx.get(name);
+
+ if (pos != null)
+ {
+ return (ToolDescriptor)tools.elementAt(pos.intValue());
+ }
+ }
+
+ return null;
+ }
+
+
+ /** Returns a map of parameter values keyed on the parameter names
+ * @return the parameter values map
+ */
+ public Map getToolMap()
+ {
+ Hashtable map = new Hashtable();
+ Enumeration en = tools.elements();
+ while(en.hasMoreElements())
+ {
+ ToolDescriptor desc = (ToolDescriptor)en.nextElement();
+ map.put(desc.getName(),desc);
+ }
+ return map;
+ }
+
+ /** Adds a new parameter for this entry
+ * @param parameter the new parameter to add
+ */
+ public void addTool( ToolDescriptor tool )
+ {
+ synchronized (tools)
+ {
+ if (tools == null)
+ tools = new Vector();
+
+ if (toolsIdx == null)
+ buildToolsIndex();
+
+ tools.addElement( tool );
+ toolsIdx.put( tool.getName(), new Integer( tools.size()-1 ) );
+ }
+ }
+
+ /** Removes all parameter values associated with the
+ * name
+ *
+ * @param name the parameter name to remove
+ */
+ public void removeTool( String name )
+ {
+ if (name == null) return;
+
+ synchronized (tools)
+ {
+ Iterator i = tools.iterator();
+ while(i.hasNext())
+ {
+ ToolDescriptor tool = (ToolDescriptor)i.next();
+ if (tool.getName().equals(name))
+ {
+ i.remove();
+ }
+ }
+
+ buildToolsIndex();
+ }
+ }
+
+ /** This method recreates the media name index for quick retrieval
+ * by name.
+ */
+ private void buildToolsIndex()
+ {
+ Hashtable idx = new Hashtable();
+
+ Iterator i = tools.iterator();
+ int count = 0;
+ while( i.hasNext() )
+ {
+ ToolDescriptor b = (ToolDescriptor)i.next();
+ idx.put( b.getName(), new Integer(count) );
+ count++;
+ }
+
+ this.toolsIdx = idx;
+ }
+
}
1.1
jakarta-jetspeed/src/java/org/apache/jetspeed/om/registry/base/BaseToolDescriptor.java
Index: BaseToolDescriptor.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Jetspeed" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache" or
* "Apache Jetspeed", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jetspeed.om.registry.base;
import org.apache.jetspeed.om.registry.ToolDescriptor;
/**
* Bean-like implementation of the ToolDescriptor interface
*
* @author <a href="mailto:raphael@;apache.org">Rapha�l Luta</a>
* @version $Id: BaseToolDescriptor.java,v 1.1 2002/11/03 15:07:35 raphael Exp $
*/
public class BaseToolDescriptor implements ToolDescriptor, java.io.Serializable
{
private String name = null;
private String scope = null;
private String classname = null;
/**
* Implements the equals operation so that 2 elements are equal if
* all their member values are equal.
*/
public boolean equals(Object object)
{
if (object==null)
{
return false;
}
BaseToolDescriptor obj = (BaseToolDescriptor)object;
if (name!=null)
{
if (!name.equals(obj.getName()))
{
return false;
}
}
else
{
if (obj.getName()!=null)
{
return false;
}
}
if (scope!=null)
{
if(!scope.equals(obj.getScope()))
{
return false;
}
}
else
{
if (obj.getScope()!=null)
{
return false;
}
}
if (classname!=null)
{
if(!classname.equals(obj.getClassname()))
{
return false;
}
}
else
{
if (obj.getClassname()!=null)
{
return false;
}
}
return true;
}
/** @return the name of the tool */
public String getName()
{
return this.name;
}
/** Sets the name for this tool
* @param title the new name of the tool
*/
public void setName( String name )
{
this.name = name;
}
/** @return the scope of this tool */
public String getScope()
{
return this.scope;
}
/** Sets the scope of this tool.
* The currently recognized scope are "request", "session", "persistent",
"global"
* @param scope the new scope of this tool
*/
public void setScope( String scope )
{
this.scope = scope;
}
/** @return the clasname of this tool */
public String getClassname()
{
return this.classname;
}
/** Sets the classname of this tool
* @param classname the new classname of this tool
*/
public void setClassname( String classname )
{
this.classname = classname;
}
}
--
To unsubscribe, e-mail: <mailto:jetspeed-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:jetspeed-dev-help@;jakarta.apache.org>
