henning 2003/07/15 08:16:39
Added: src/java/org/apache/turbine/services/template/mapper
TemplateScreenDefaultMapper.java
Log:
This is a mapper which can be used for e.g. screen template mapping. It
doesn't look only for the Screen name itself, but also for a Screen called
"Default" + templating engine extension (e.g. Default.vm) in the same
package.
Revision Changes Path
1.1
jakarta-turbine-2/src/java/org/apache/turbine/services/template/mapper/TemplateScreenDefaultMapper.java
Index: TemplateScreenDefaultMapper.java
===================================================================
package org.apache.turbine.services.template.mapper;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" 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",
* "Apache Turbine", 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/>.
*/
import java.util.List;
import java.util.ArrayList;
import java.util.Arrays;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.turbine.services.template.TemplateEngineService;
import org.apache.turbine.services.template.TemplateService;
import org.apache.turbine.services.template.TurbineTemplate;
/**
* This is a pretty simple mapper which returns template pathes for
* a supplied template name. If the path does not exist, it looks for
* a templated called "Default" in the same package.
* This path can be used by the TemplateEngine to access
* a certain resource to actually render the template.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
* @version $Id: TemplateScreenDefaultMapper.java,v 1.1 2003/07/15 15:16:39 henning
Exp $
*/
public class TemplateScreenDefaultMapper
extends TemplateBaseLayoutMapper
implements TemplateMapper
{
/** Logging */
private static Log log = LogFactory.getLog(TemplateScreenDefaultMapper.class);
/**
* Default C'tor. If you use this C'tor, you must use
* the bean setter to set the various properties needed for
* this mapper before first usage.
*/
public TemplateScreenDefaultMapper()
{
}
/**
* C'tor
*
* @param useCache If true, then the resulting mapper will cache mappings.
* @param cacheSize Size of the internal map cache. Must be > 0 if useCache is
true.
* @param defaultProperty The name of the default property to pull from the
TemplateEngine
* @param separator The separator for this mapper.
* @param prefix A prefix used to provide various hierarchies for screens,
layouts, navigation...
*/
public TemplateScreenDefaultMapper(boolean useCache,
int cacheSize,
String defaultProperty,
String separator,
String prefix)
{
super(useCache, cacheSize, defaultProperty, separator, prefix);
}
/**
* Look for a given Template, then try the
* default.
*
* @param template The template name.
* @return The parsed module name.
*/
public String doMapping(String template)
{
log.debug("doMapping(" + template + ")");
// Copy our elements into an array
List components
= new ArrayList(Arrays.asList(StringUtils.split(
template,
String.valueOf(TemplateService.TEMPLATE_PARTS_SEPARATOR))));
int componentSize = components.size() - 1 ;
// This method never gets an empty string passed.
// So this is never < 0
String templateName = (String) components.get(componentSize);
components.remove(componentSize--);
log.debug("templateName is " + templateName);
// Last element decides, which template Service to use...
TemplateEngineService tes =
TurbineTemplate.getTemplateEngineService(templateName);
if (tes == null)
{
return null;
}
String defaultName = "Default.vm";
// This is an optimization. If the name we're looking for is
// already the default name for the template, don't do a "first run"
// which looks for an exact match.
boolean firstRun = !templateName.equals(defaultName);
for(;;)
{
String templatePackage = StringUtils.join(components.iterator(),
separator);
log.debug("templatePackage is now: " + templatePackage);
StringBuffer testName = new StringBuffer();
if (!components.isEmpty())
{
testName.append(templatePackage);
testName.append(separator);
}
testName.append((firstRun)
? templateName
: defaultName);
// But the Templating service must look for the name with prefix
StringBuffer templatePath = new StringBuffer();
if (StringUtils.isNotEmpty(prefix))
{
templatePath.append(prefix);
templatePath.append(separator);
}
templatePath.append(testName);
log.debug("Looking for " + templatePath);
if (tes.templateExists(templatePath.toString()))
{
log.debug("Found it, returning " + testName);
return testName.toString();
}
if (firstRun)
{
firstRun = false;
}
else
{
// We run this loop only two times. The
// first time with the 'real' name and the
// second time with "Default". The second time
// we will end up here and break the for(;;) loop.
break;
}
}
log.debug("Returning default");
return getDefaultName(template);
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
