← Back to branch summary

~ubuntu-branches/ubuntu/maverick/libcommons-digester-java/maverick

« back to all changes in this revision

Viewing changes to src/java/org/apache/commons/digester/substitution/package.html

  • Committer: Bazaar Package Importer
  • Author(s): Wolfgang Baer
  • Date: 2006-01-15 16:51:19 UTC
  • mfrom: (0.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060115165119-e7cgj3f6o1fmvlg3
Tags: 1.7-2
* Kaffe compiler transition
* Remove Takashi from uploaders to reflect current maintainership

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/java/org/apache/commons/digester/substitution/package.html
 
1
<!-- $Id: package.html 155412 2005-02-26 12:58:36Z dirkv $
 
2
  
 
3
 Copyright 2001-2004 The Apache Software Foundation.
 
4
 
 
5
 Licensed under the Apache License, Version 2.0 (the "License");
 
6
 you may not use this file except in compliance with the License.
 
7
 You may obtain a copy of the License at
 
8
  
 
9
       http://www.apache.org/licenses/LICENSE-2.0
 
10
  
 
11
 Unless required by applicable law or agreed to in writing, software
 
12
 distributed under the License is distributed on an "AS IS" BASIS,
 
13
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 
14
 See the License for the specific language governing permissions and
 
15
 limitations under the License.
 
16
--> 
 
17
<html>
 
18
<head>
 
19
<title>Package Documentation for org.apache.commons.digester.substitution Package</title>
 
20
</head>
 
21
<body bgcolor="white">
 
22
Provides for manipulation of xml attributes and element body text before
 
23
the data is processed by any Rule objects.
 
24
<br><br>
 
25
<p>
 
26
The class org.apache.commons.digester.Substitutor defines an abstract
 
27
interface for mechanisms which manipulate xml attributes and body text.
 
28
The Digester method setSubstitutor can be used to define a concrete
 
29
substitutor that will be applied to the data before it is passed to the
 
30
matching rules.
 
31
</p>
 
32
<p>
 
33
This package provides some useful concrete implementations of the abstract
 
34
Substitutor class. In particular, it provides an implementation that allows
 
35
the application to define "variables" which the input data can reference
 
36
using a syntax such as "${user.name}".
 
37
</p>
 
38
<p>Here's an example of setting up the VariableSubstitutor:</p>
 
39
<pre>
 
40
  // set up the variables the input xml can reference
 
41
  Map vars = new HashMap();
 
42
  vars.put("user.name", "me");
 
43
  vars.put("os", "Linux");
 
44
  
 
45
  // map ${varname} to the entries in the var map
 
46
  MultiVariableExpander expander = new MultiVariableExpander();
 
47
  expander.addSource("$", vars);
 
48
 
 
49
  // allow expansion in both xml attributes and element text
 
50
  Substitutor substitutor = new VariableSubstitutor(expander);
 
51
 
 
52
  Digester digester = new Digester();
 
53
  digester.setSubstitutor(substitutor);
 
54
</pre>
 
55
</body>
 
56
</html>