More fall out from Template/Script refactoring:

- fix to missing annotated service method (caused script command servlet to fail)
 - spelling mistakes in annotated service method parameters
 - cleanup in AbstractWebScript

Added ValueConverter concept to Template API - similar to JavaScript API ValueConverter, for a consistent mechanism to recursively convert Alfresco node properties to template accessable objects.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5535 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast
2007-04-24 13:11:25 +00:00
parent c1a69f0f3f
commit 577d45c551
7 changed files with 115 additions and 20 deletions

View File

@@ -536,8 +536,9 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
/**
* Converts the passed model into a Rhino model
*
* @param model the model
* @return Map<String, Object> the converted model
* @param model the model
*
* @return Map<String, Object> the converted model
*/
private Map<String, Object> convertToRhinoModel(Map<String, Object> model)
{

View File

@@ -99,13 +99,14 @@ public class ValueConverter
{
// recursively convert each value in the collection
Collection<Serializable> collection = (Collection<Serializable>)value;
Serializable[] array = new Serializable[collection.size()];
Object[] array = new Object[collection.size()];
int index = 0;
for (Serializable obj : collection)
{
array[index++] = convertValueForScript(services, scope, qname, obj);
}
value = array;
// convert array to a native JavaScript Array
value = (Serializable)Context.getCurrentContext().newArray(scope, array);
}
// simple numbers and strings are wrapped automatically by Rhino

View File

@@ -269,6 +269,13 @@ public class FreeMarkerProcessor extends BaseProcessor implements TemplateProces
}
}
/**
* Converts the passed model into a FreeMarker model
*
* @param model the model
*
* @return Object the converted model
*/
private Object convertToFreeMarkerModel(Object model)
{
// If we dont have a map in our hand we just return the passes model

View File

@@ -0,0 +1,68 @@
/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing
*/
package org.alfresco.repo.template;
import java.io.Serializable;
import java.util.List;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TemplateImageResolver;
import org.alfresco.service.namespace.QName;
/**
* Simple class to recursively convert property values to bean objects accessable by Templates.
*
* @author Kevin Roast
*/
public class PropertyConverter
{
public Serializable convertProperty(
Serializable value, QName name, ServiceRegistry services, TemplateImageResolver resolver)
{
// perform conversions from Java objects to template compatable instances
if (value == null)
{
return null;
}
else if (value instanceof NodeRef)
{
// NodeRef object properties are converted to new TemplateNode objects
// so they can be used as objects within a template
value = new TemplateNode(((NodeRef)value), services, resolver);
}
else if (value instanceof List)
{
// recursively convert each value in the collection
List<Serializable> list = (List<Serializable>)value;
for (int i=0; i<list.size(); i++)
{
list.set(i, convertProperty(list.get(i), name, services, resolver));
}
}
return value;
}
}

View File

@@ -90,6 +90,8 @@ public class TemplateNode extends BasePermissionsNode
private ChildAssociationRef primaryParentAssoc = null;
private Boolean isCategory = null;
private PropertyConverter propertyConverter = new TemplatePropertyConverter();
// ------------------------------------------------------------------------------
// Construction
@@ -197,20 +199,9 @@ public class TemplateNode extends BasePermissionsNode
for (QName qname : props.keySet())
{
Serializable propValue = props.get(qname);
if (propValue instanceof NodeRef)
{
// NodeRef object properties are converted to new TemplateNode objects
// so they can be used as objects within a template
propValue = new TemplateNode(((NodeRef)propValue), this.services, this.imageResolver);
}
else if (propValue instanceof ContentData)
{
// ContentData object properties are converted to TemplateContentData objects
// so the content and other properties of those objects can be accessed
propValue = new TemplateContentData((ContentData)propValue, qname);
}
this.properties.put(qname.toString(), propValue);
Serializable value = this.propertyConverter.convertProperty(
props.get(qname), qname, this.services, getImageResolver());
this.properties.put(qname.toString(), value);
}
this.propsRetrieved = true;
@@ -458,4 +449,30 @@ public class TemplateNode extends BasePermissionsNode
{
return this.imageResolver;
}
// ------------------------------------------------------------------------------
// Inner classes
/**
* Class to convert properties into template accessable objects
*/
class TemplatePropertyConverter extends PropertyConverter
{
@Override
public Serializable convertProperty(
Serializable value, QName name, ServiceRegistry services, TemplateImageResolver resolver)
{
if (value instanceof ContentData)
{
// ContentData object properties are converted to TemplateContentData objects
// so the content and other properties of those objects can be accessed
return new TemplateContentData((ContentData)value, name);
}
else
{
return super.convertProperty(value, name, services, resolver);
}
}
}
}

View File

@@ -180,7 +180,7 @@ public interface ScriptService
*
* @param scriptProcessor
*/
@Auditable(parameters = {"scriptProcessot"})
@Auditable(parameters = {"scriptProcessor"})
public void registerScriptProcessor(ScriptProcessor scriptProcessor);
/**
@@ -203,6 +203,7 @@ public interface ScriptService
*
* @return A Map of global scope scriptable Node objects
*/
@Auditable(parameters = {"person", "companyHome", "userHome", "script", "document", "document"})
public Map<String, Object> buildDefaultModel(
NodeRef person,
NodeRef companyHome,

View File

@@ -169,7 +169,7 @@ public interface TemplateService
* @param imageResolver the image resolver (optional)
* @return
*/
@Auditable(parameters = {"person", "compantHome", "userHome", "template", "imageResolver"})
@Auditable(parameters = {"person", "companyHome", "userHome", "template", "imageResolver"})
public Map<String, Object> buildDefaultModel(
NodeRef person,
NodeRef companyHome,