Author: danielf Date: Tue Jan 11 23:16:14 2005 New Revision: 124944 URL: http://svn.apache.org/viewcvs?view=rev&rev=124944 Log: Using slightly modified and extended version of TemplateObjectModelHelper from Scratchpad for oject model handling. Added: cocoon/trunk/src/blocks/template/java/org/apache/cocoon/environment/ cocoon/trunk/src/blocks/template/java/org/apache/cocoon/environment/FlowObjectModelHelper.java cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/ cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.java cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.xtest
Added: cocoon/trunk/src/blocks/template/java/org/apache/cocoon/environment/FlowObjectModelHelper.java Url: http://svn.apache.org/viewcvs/cocoon/trunk/src/blocks/template/java/org/apache/cocoon/environment/FlowObjectModelHelper.java?view=auto&rev=124944 ============================================================================== --- (empty file) +++ cocoon/trunk/src/blocks/template/java/org/apache/cocoon/environment/FlowObjectModelHelper.java Tue Jan 11 23:16:14 2005 @@ -0,0 +1,211 @@ +/* + * Copyright 1999-2004 The Apache Software Foundation. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.cocoon.environment; + +import java.beans.PropertyDescriptor; +import java.lang.reflect.Method; +import java.util.HashMap; +import java.util.Map; + +import org.apache.avalon.framework.parameters.Parameters; +import org.apache.cocoon.components.expression.ExpressionContext; +import org.apache.cocoon.components.flow.FlowHelper; +import org.apache.cocoon.components.flow.WebContinuation; +import org.apache.cocoon.components.flow.javascript.fom.FOM_WebContinuation; +import org.apache.commons.beanutils.MethodUtils; +import org.apache.commons.beanutils.PropertyUtils; +import org.apache.commons.jxpath.DynamicPropertyHandler; +import org.apache.commons.jxpath.JXPathBeanInfo; +import org.apache.commons.jxpath.JXPathIntrospector; + + +/** + * This is an utility class to create an object model which is similar to the one + * used in flow, that can be used from every component. + * + * Work-in-progress, derived from JXTemplateGenerator + * Copy of TemplateObjectModelHelper from scratchpad + * plus creation of an Expression context + * + * @version CVS $Id$ + */ +public class FlowObjectModelHelper { + + /** Avoid instantiation */ + private FlowObjectModelHelper() {} + + private static void fillContext(Object contextObject, Map map) { + // Hack: I use jxpath to populate the context object's properties + // in the jexl context + final JXPathBeanInfo bi = + JXPathIntrospector.getBeanInfo(contextObject.getClass()); + if (bi.isDynamic()) { + Class cl = bi.getDynamicPropertyHandlerClass(); + try { + DynamicPropertyHandler h = + (DynamicPropertyHandler) cl.newInstance(); + String[] result = h.getPropertyNames(contextObject); + int len = result.length; + for (int i = 0; i < len; i++) { + try { + map.put(result[i], h.getProperty(contextObject, result[i])); + } catch (Exception exc) { + exc.printStackTrace(); + } + } + } catch (Exception ignored) { + ignored.printStackTrace(); + } + } else { + PropertyDescriptor[] props = bi.getPropertyDescriptors(); + int len = props.length; + for (int i = 0; i < len; i++) { + try { + Method read = props[i].getReadMethod(); + if (read != null) { + map.put(props[i].getName(), + read.invoke(contextObject, null)); + } + } catch (Exception ignored) { + ignored.printStackTrace(); + } + } + } + } + + /** + * Create the object model. + * Currently the object model is a map with one single entry: + * cocoon + request The Request Object + * + session The Session (if available) + * + context The Context + * + continuation The Continuation (if available) + * + parameters The parameters (if provided) + */ + public static Object getTemplateObjectModel(final Map objectModel, + final Parameters parameters) { + + // first create the "cocoon object": + final Map cocoon = new HashMap(); + + // cocoon.request + final Request request = ObjectModelHelper.getRequest( objectModel ); + cocoon.put("request", new DynamicMap(request)); + + // cocoon.session + final Session session = request.getSession(false); + if (session != null) { + cocoon.put("session", new DynamicMap(session)); + } + + // cocoon.context + cocoon.put("context", ObjectModelHelper.getContext(objectModel)); + + // cocoon.continuation + final WebContinuation cont = FlowHelper.getWebContinuation(objectModel); + if ( cont != null ) { + // Changed compared to scratchpad version, using FOM_WebContinuation + // to stay compatible with JXTemplateGenerator + cocoon.put("continuation", new FOM_WebContinuation(cont)); + } + + // cocoon.parameters + if ( parameters != null ) { + cocoon.put("parameters", Parameters.toProperties(parameters)); + } + + final Map map = new HashMap(); + map.put("cocoon", cocoon); + + // Now add objects from flow context (if any) + final Object contextObject = FlowHelper.getContextObject(objectModel); + if (contextObject instanceof Map) { + map.putAll((Map)contextObject); + } else if ( contextObject != null ) { + fillContext(contextObject, map); + } + + return map; + } + + /** + * Create an expression context that contains the object model + */ + public static ExpressionContext getFOMExpressionContext(final Map objectModel, + final Parameters parameters) { + ExpressionContext context = new ExpressionContext(); + context.setVars((Map)getTemplateObjectModel(objectModel, parameters)); + context.setContextBean(FlowHelper.getContextObject(objectModel)); + + return context; + } + + /** + * This is a dynamic map that should provide the same functionality as the + * FOM wrappers for objects. + */ + public static class DynamicMap extends HashMap { + + protected final Object information; + + public DynamicMap(Object info) { + this.information = info; + } + + /* (non-Javadoc) + * @see java.util.Map#get(java.lang.Object) + */ + public Object get(Object key) { + Object result = super.get(key); + if ( result == null ) { + result = this.getDynamicInfo(key); + } + return result; + } + + + /* (non-Javadoc) + * @see java.util.Map#containsKey(java.lang.Object) + */ + public boolean containsKey(Object key) { + boolean result = super.containsKey(key); + if ( result == false ) { + result = (this.getDynamicInfo(key) != null); + } + return result; + } + + protected Object getDynamicInfo(Object key) { + Object result = null; + try { + result = PropertyUtils.getProperty(this.information, key.toString()); + } catch (Exception ignore) { + } + if ( result == null ) { + try { + result = MethodUtils.invokeMethod(this.information, + "getAttribute", + key.toString()); + } catch (Exception ignore) { + } + } + if ( result != null ) { + this.put(key, result); + } + return result; + } + } +} Added: cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.java Url: http://svn.apache.org/viewcvs/cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.java?view=auto&rev=124944 ============================================================================== --- (empty file) +++ cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.java Tue Jan 11 23:16:14 2005 @@ -0,0 +1,56 @@ +/* + * Copyright 1999-2004 The Apache Software Foundation. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.cocoon.environment; + +import org.apache.avalon.framework.parameters.Parameters; +import org.apache.avalon.framework.service.ServiceException; +import org.apache.cocoon.SitemapComponentTestCase; +import org.apache.cocoon.components.expression.Expression; +import org.apache.cocoon.components.expression.ExpressionContext; +import org.apache.cocoon.components.expression.ExpressionException; +import org.apache.cocoon.components.expression.ExpressionFactory; + +public class FOMTestCase extends SitemapComponentTestCase { + + public void testFOMJexl() throws ExpressionException, ServiceException { + ExpressionFactory factory = (ExpressionFactory)this.lookup(ExpressionFactory.ROLE); + Parameters parameters = new Parameters(); + parameters.setParameter("test", "foo"); + ExpressionContext fomContext = + FlowObjectModelHelper.getFOMExpressionContext(getObjectModel(), parameters); + + Expression expression = factory.getExpression("jexl", "cocoon.parameters.test"); + assertEquals("foo", expression.evaluate(fomContext)); + + expression = factory.getExpression("jexl", "cocoon.request.protocol"); + assertEquals("HTTP/1.1", expression.evaluate(fomContext)); + } + + public void testFOMJXPath() throws ExpressionException, ServiceException { + ExpressionFactory factory = (ExpressionFactory)this.lookup(ExpressionFactory.ROLE); + Parameters parameters = new Parameters(); + parameters.setParameter("test", "foo"); + ExpressionContext fomContext = + FlowObjectModelHelper.getFOMExpressionContext(getObjectModel(), parameters); + + Expression expression = factory.getExpression("jxpath", "$cocoon/parameters/test"); + assertEquals("foo", expression.evaluate(fomContext)); + + expression = factory.getExpression("jxpath", "$cocoon/request/protocol"); + assertEquals("HTTP/1.1", expression.evaluate(fomContext)); + } +} + Added: cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.xtest Url: http://svn.apache.org/viewcvs/cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.xtest?view=auto&rev=124944 ============================================================================== --- (empty file) +++ cocoon/trunk/src/blocks/template/test/org/apache/cocoon/environment/FOMTestCase.xtest Tue Jan 11 23:16:14 2005 @@ -0,0 +1,35 @@ +<?xml version="1.0"?> +<!-- + Copyright 1999-2004 The Apache Software Foundation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<testcase> + <roles> + <role name="org.apache.cocoon.components.expression.ExpressionCompilerSelector" + shorthand="expression-compilers" + default-class="org.apache.cocoon.core.container.DefaultServiceSelector"/> + <role name="org.apache.cocoon.components.expression.ExpressionFactory" + shorthand="expression-factory" + default-class="org.apache.cocoon.components.expression.ExpressionFactory"/> + </roles> + + <components> + <expression-compilers> + <component-instance class="org.apache.cocoon.components.expression.jexl.JexlCompiler" name="jexl"/> + <component-instance class="org.apache.cocoon.components.expression.jxpath.JXPathCompiler" name="jxpath"/> + </expression-compilers> + </components> + +</testcase>
