org.apache.velocity.tools.config
Class PropertiesFactoryConfiguration

java.lang.Object
  extended by org.apache.velocity.tools.config.Configuration
      extended by org.apache.velocity.tools.config.CompoundConfiguration<ToolboxConfiguration>
          extended by org.apache.velocity.tools.config.FactoryConfiguration
              extended by org.apache.velocity.tools.config.FileFactoryConfiguration
                  extended by org.apache.velocity.tools.config.PropertiesFactoryConfiguration
All Implemented Interfaces:
Comparable<Configuration>

public class PropertiesFactoryConfiguration
extends FileFactoryConfiguration

This reads in configuration info formatted as a property file using ExtendedProperties from Commons-Collections.

Example usage:

 FactoryConfiguration cfg = new PropertiesFactoryConfiguration();
 cfg.read("my.properties");
 ToolboxFactory factory = cfg.createFactory();
 

This reads in a configuration such as:

 tools.toolbox = request,application
 tools.property.locale = en_us
 tools.property.locale.class = java.util.Locale
 tools.property.locale.converter = org.apache.velocity.tools.config.LocaleConverter
 tools.request.property.xhtml = true
 tools.request.render = org.apache.velocity.tools.view.ViewRenderTool
 tools.request.render.parseDepth = 5
 tools.request.search = com.foo.tools.MySearchTool
 tools.request.search.itemsPerPage = 10
 tools.application.math = org.apache.velocity.tools.generic.MathTool
 tools.data.foo = bar
 tools.data.foo.class = java.lang.String
 tools.data.foo.converter = org.apache.commons.beanutils.converter.StringConverter
 tools.data.version = 1.0
 tools.data.version.type = number
 tools.data.debug = false
 tools.data.debug.type = boolean
 
NOTE: "property", "data", and "toolbox" are reserved words do not use them as tool keys or toolbox scopes.

Version:
$Id: PropertiesFactoryConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
Author:
Nathan Bubna

Constructor Summary
PropertiesFactoryConfiguration()
           
PropertiesFactoryConfiguration(String id)
          Creates an instance using the specified string as an identifier to distinguish this instance when debugging.
 
Method Summary
 void read(ExtendedProperties factory)
           
 void read(InputStream input)
          Reads an properties file from an InputStream and uses it to configure this FactoryConfiguration.
protected  void readData(ExtendedProperties dataset)
           
protected  void readProperties(ExtendedProperties configProps, Configuration config)
           
protected  void readToolboxes(ExtendedProperties factory)
           
protected  void readTools(ExtendedProperties tools, ToolboxConfiguration toolbox)
           
protected  void setProperties(ExtendedProperties props, Data data)
           
 
Methods inherited from class org.apache.velocity.tools.config.FileFactoryConfiguration
findURL, read, read, read, read, read, read, read
 
Methods inherited from class org.apache.velocity.tools.config.FactoryConfiguration
addConfiguration, addData, addSource, addToolbox, createFactory, equals, getData, getData, getData, getSource, getSources, getToolbox, getToolboxes, hasData, hashCode, removeData, removeToolbox, setData, setSource, setToolboxes, toString, toString, validate
 
Methods inherited from class org.apache.velocity.tools.config.CompoundConfiguration
addChild, addConfiguration, appendChildren, getChild, getChildren, hasChildren, removeChild, setChildren
 
Methods inherited from class org.apache.velocity.tools.config.Configuration
addConfiguration, addProperty, appendProperties, compareTo, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertiesFactoryConfiguration

public PropertiesFactoryConfiguration()

PropertiesFactoryConfiguration

public PropertiesFactoryConfiguration(String id)
Creates an instance using the specified string as an identifier to distinguish this instance when debugging.

Parameters:
id - the name of the "source" of this instance
See Also:
FactoryConfiguration.setSource(String)
Method Detail

read

public void read(InputStream input)
          throws IOException

Reads an properties file from an InputStream and uses it to configure this FactoryConfiguration.

Specified by:
read in class FileFactoryConfiguration
Parameters:
input - the InputStream to read from
Throws:
IOException

read

public void read(ExtendedProperties factory)

readProperties

protected void readProperties(ExtendedProperties configProps,
                              Configuration config)

readToolboxes

protected void readToolboxes(ExtendedProperties factory)

readTools

protected void readTools(ExtendedProperties tools,
                         ToolboxConfiguration toolbox)

readData

protected void readData(ExtendedProperties dataset)

setProperties

protected void setProperties(ExtendedProperties props,
                             Data data)


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.