You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by si...@apache.org on 2011/05/27 17:47:30 UTC
svn commit: r1128373 -
/commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml
Author: simonetripodi
Date: Fri May 27 15:47:29 2011
New Revision: 1128373
URL: http://svn.apache.org/viewvc?rev=1128373&view=rev
Log:
fixed apidocs links
Modified:
commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml
Modified: commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml?rev=1128373&r1=1128372&r2=1128373&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml (original)
+++ commons/sandbox/digester3/trunk/src/site/xdoc/guide/core.xml Fri May 27 15:47:29 2011
@@ -74,7 +74,7 @@ the developer to focus on the processing
the order that they were listed.</li>
<li>Call the <code>digester.parse()</code> method, passing a reference to the
XML document to be parsed in one of a variety of forms. See the
- <a href="apidocs/Digester.html#parse(java.io.File)">Digester.parse()</a>
+ <a href="../apidocs/Digester.html#parse(java.io.File)">Digester.parse()</a>
documentation for details. Note that you will need to be prepared to
catch any <code>IOException</code> or <code>SAXException</code> that is
thrown by the parser, or any runtime expression that is thrown by one of
@@ -225,13 +225,13 @@ manipulated by processing rules that are
are satisfied. The usual stack-related operations are made available,
including the following:</p>
<ul>
-<li><a href="apidocs/org/apache/commons/digester3/Digester.html#clear()">clear()</a> - Clear the current contents
+<li><a href="../apidocs/org/apache/commons/digester3/Digester.html#clear()">clear()</a> - Clear the current contents
of the object stack.</li>
-<li><a href="apidocs/org/apache/commons/digester3/Digester.html#peek()">peek()</a> - Return a reference to the top
+<li><a href="../apidocs/org/apache/commons/digester3/Digester.html#peek()">peek()</a> - Return a reference to the top
object on the stack, without removing it.</li>
-<li><a href="apidocs/Digester.html#pop()">pop()</a> - Remove the top object from the
+<li><a href="../apidocs/Digester.html#pop()">pop()</a> - Remove the top object from the
stack and return it.</li>
-<li><a href="apidocs/org/apache/commons/digester3/Digester.html#push(T)">push()</a> - Push a new
+<li><a href="../apidocs/org/apache/commons/digester3/Digester.html#push(T)">push()</a> - Push a new
object onto the top of the stack.</li>
</ul>
@@ -363,25 +363,25 @@ of processing rules is to define <strong
patterns are matched.</p>
<p>Formally, a processing rule is a Java class that subclasses the
-<a href="apidocs/org/apache/commons/digester3/Rule.html">org.apache.commons.digester3.Rule</a> interface. Each Rule
+<a href="../apidocs/org/apache/commons/digester3/Rule.html">org.apache.commons.digester3.Rule</a> interface. Each Rule
implements one or more of the following event methods that are called at
well-defined times when the matching patterns corresponding to this rule
trigger it:</p>
<ul>
-<li><a href="apidocs/org/apache/commons/digester3/Rule.html#begin(java.lang.String, java.lang.String, org.xml.sax.Attributes)">
+<li><a href="../apidocs/org/apache/commons/digester3/Rule.html#begin(java.lang.String, java.lang.String, org.xml.sax.Attributes)">
begin()</a> - Called when the beginning of the matched XML element is encountered. A
data structure containing all of the attributes corresponding to this
element are passed as well.</li>
-<li><a href="apidocs/org/apache/commons/digester3/Rule.html#body(java.lang.String, java.lang.String, java.lang.String)">
+<li><a href="../apidocs/org/apache/commons/digester3/Rule.html#body(java.lang.String, java.lang.String, java.lang.String)">
body()</a> - Called when nested content (that is not itself XML elements) of the
matched element is encountered. Any leading or trailing whitespace will
have been removed as part of the parsing process.</li>
-<li><a href="apidocs/org/apache/commons/digester3/Rule.html#end(java.lang.String, java.lang.String)">end()</a> - Called
+<li><a href="../apidocs/org/apache/commons/digester3/Rule.html#end(java.lang.String, java.lang.String)">end()</a> - Called
when the ending of the matched XML element is encountered. If nested XML elements that matched other
processing rules was included in the body of this element, the appropriate
processing rules for the matched rules will have already been completed
before this method is called.</li>
-<li><a href="apidocs/org/apache/commons/digester3/Rule.html#finish()">finish()</a> - Called when the parse has
+<li><a href="../apidocs/org/apache/commons/digester3/Rule.html#finish()">finish()</a> - Called when the parse has
been completed, to give each rule a chance to clean up any temporary data
they might have created and cached.</li>
</ul>
@@ -397,7 +397,7 @@ dynamically, to implement any desired ap
which deal with many common programming scenarios. These classes include the
following:</p>
<ul>
-<li><a href="apidocs/org/apache/commons/digester3/ObjectCreateRule.html">ObjectCreateRule</a> - When the
+<li><a href="../apidocs/org/apache/commons/digester3/ObjectCreateRule.html">ObjectCreateRule</a> - When the
<code>begin()</code> method is called, this rule instantiates a new
instance of a specified Java class, and pushes it on the stack. The
class name to be used is defaulted according to a parameter passed to
@@ -407,12 +407,12 @@ following:</p>
(presumably, the one we added in the <code>begin()</code> method) will
be popped, and any reference to it (within the Digester) will be
discarded.</li>
-<li><a href="apidocs/org/apache/commons/digester3/FactoryCreateRule.html">FactoryCreateRule</a> - A variation of
+<li><a href="../apidocs/org/apache/commons/digester3/FactoryCreateRule.html">FactoryCreateRule</a> - A variation of
<code>ObjectCreateRule</code> that is useful when the Java class with
which you wish to create an object instance does not have a no-arguments
constructor, or where you wish to perform other setup processing before
the object is handed over to the Digester.</li>
-<li><a href="apidocs/org/apache/commons/digester3/SetPropertiesRule.html">SetPropertiesRule</a> - When the
+<li><a href="../apidocs/org/apache/commons/digester3/SetPropertiesRule.html">SetPropertiesRule</a> - When the
<code>begin()</code> method is called, the digester uses the standard
Java Reflection API to identify any JavaBeans property setter methods
(on the object at the top of the digester's stack)
@@ -427,7 +427,7 @@ following:</p>
pattern. This causes the creation of a new Java object, followed by
"configuration" of that object's properties based on the attributes
of the same XML element that created this object.</li>
-<li><a href="apidocs/org/apache/commons/digester3/SetPropertyRule.html">SetPropertyRule</a> - When the
+<li><a href="../apidocs/org/apache/commons/digester3/SetPropertyRule.html">SetPropertyRule</a> - When the
<code>begin()</code> method is called, the digester calls a specified
property setter (where the property itself is named by an attribute)
with a specified value (where the value is named by another attribute),
@@ -435,21 +435,21 @@ following:</p>
This is useful when your XML file conforms to a particular DTD, and
you wish to configure a particular property that does not have a
corresponding attribute in the DTD.</li>
-<li><a href="apidocs/org/apache/commons/digester3/SetNextRule.html">SetNextRule</a> - When the
+<li><a href="../apidocs/org/apache/commons/digester3/SetNextRule.html">SetNextRule</a> - When the
<code>end()</code> method is called, the digester analyzes the
next-to-top element on the stack, looking for a property setter method
for a specified property. It then calls this method, passing the object
at the top of the stack as an argument. This rule is commonly used to
establish one-to-many relationships between the two objects, with the
method name commonly being something like "addChild".</li>
-<li><a href="apidocs/org/apache/commons/digester3/SetTopRule.html">SetTopRule</a> - When the
+<li><a href="../apidocs/org/apache/commons/digester3/SetTopRule.html">SetTopRule</a> - When the
<code>end()</code> method is called, the digester analyzes the
top element on the stack, looking for a property setter method for a
specified property. It then calls this method, passing the next-to-top
object on the stack as an argument. This rule would be used as an
alternative to a SetNextRule, with a typical method name "setParent",
if the API supported by your object classes prefers this approach.</li>
-<li><a href="apidocs/org/apache/commons/digester3/CallMethodRule.html">CallMethodRule</a> - This rule sets up a
+<li><a href="../apidocs/org/apache/commons/digester3/CallMethodRule.html">CallMethodRule</a> - This rule sets up a
method call to a named method of the top object on the digester's stack,
which will actually take place when the <code>end()</code> method is
called. You configure this rule by specifying the name of the method
@@ -458,12 +458,12 @@ following:</p>
The actual parameter values, if any, will typically be accumulated from
the body content of nested elements within the element that triggered
this rule, using the CallParamRule discussed next.</li>
-<li><a href="apidocs/org/apache/commons/digester3/CallParamRule.html">CallParamRule</a> - This rule identifies
+<li><a href="../apidocs/org/apache/commons/digester3/CallParamRule.html">CallParamRule</a> - This rule identifies
the source of a particular numbered (zero-relative) parameter for a
CallMethodRule within which we are nested. You can specify that the
parameter value be taken from a particular named attribute, or from the
nested body content of this element.</li>
-<li><a href="apidocs/org/apache/commons/digester3/NodeCreateRule.html">NodeCreateRule</a> - A specialized rule
+<li><a href="../apidocs/org/apache/commons/digester3/NodeCreateRule.html">NodeCreateRule</a> - A specialized rule
that converts part of the tree into a <code>DOM Node</code> and then
pushes it onto the stack.</li>
</ul>
@@ -906,9 +906,9 @@ elements are ignored for matching purpos
pattern of nested elements as described under
<a href="#doc.Patterns">Element Matching Patterns</a>. If you prefer to use
different selection policies, however, you can create your own implementation
-of the <a href="apidocs/Rules.html">org.apache.commons.digester3.Rules</a> interface,
+of the <a href="../apidocs/Rules.html">org.apache.commons.digester3.Rules</a> interface,
or subclass the corresponding convenience base class
-<a href="apidocs/RulesBase.html">org.apache.commons.digester3.RulesBase</a>.
+<a href="../apidocs/RulesBase.html">org.apache.commons.digester3.RulesBase</a>.
Your implementation of the <code>match()</code> method will be called when the
processing for a particular element is started or ended, and you must return
a <code>List</code> of the rules that are relevant for the current nesting
@@ -927,7 +927,7 @@ that:</p>
</ul>
<subsection name="ExtendedBaseRules">
- <p><a href="apidocs/ExtendedBaseRules.html">ExtendedBaseRules</a>,
+ <p><a href="../apidocs/ExtendedBaseRules.html">ExtendedBaseRules</a>,
adds some additional expression syntax for pattern matching
to the default mechanism, but it also executes more slowly. See the
JavaDocs for more details on the new pattern matching syntax, and suggestions
@@ -943,9 +943,9 @@ following as part of your Digester initi
</subsection>
<subsection name="RegexRules">
- <p><a href="apidocs/RegexRules.html">RegexRules</a> is an advanced <code>Rules</code>
+ <p><a href="../apidocs/RegexRules.html">RegexRules</a> is an advanced <code>Rules</code>
implementation which does not build on the default pattern matching rules.
-It uses a pluggable <a href="apidocs/RegexMatcher.html">RegexMatcher</a> implementation to test
+It uses a pluggable <a href="../apidocs/RegexMatcher.html">RegexMatcher</a> implementation to test
if a path matches the pattern for a Rule. All matching rules are returned
(note that this behaviour differs from longest matching rule of the default
pattern matching rules). See the Java Docs for more details.
@@ -965,7 +965,7 @@ Example usage:
<subsection name="RegexMatchers">
<p>
<code>Digester</code> ships only with one <code>RegexMatcher</code>
-implementation: <a href="apidocs/SimpleRegexMatcher.html">SimpleRegexMatcher</a>.
+implementation: <a href="../apidocs/SimpleRegexMatcher.html">SimpleRegexMatcher</a>.
This implementation is unsophisticated and lacks many good features
lacking in more power Regex libraries. There are some good reasons
why this approach was adopted. The first is that <code>SimpleRegexMatcher</code>
@@ -1028,8 +1028,8 @@ could package a set of rules into a sing
loaded and registered with a <code>Digester</code> instance in one easy step.
</p>
-<p>The <a href="apidocs/RuleSet.html">RuleSet</a> interface (and the convenience base
-class <a href="apidocs/RuleSetBase.html">RuleSetBase</a>) make it possible to do this.
+<p>The <a href="../apidocs/RuleSet.html">RuleSet</a> interface (and the convenience base
+class <a href="../apidocs/RuleSetBase.html">RuleSetBase</a>) make it possible to do this.
In addition, the rule instances registered with a particular
<code>RuleSet</code> can optionally be associated with a particular namespace,
as described under <a href="#doc.Namespace">Namespace Aware Processing</a>.</p>
@@ -1118,11 +1118,11 @@ the term <em>named stack</em> comes from
accessed through calls to:
</p>
<ul>
- <li><a href="apidocs/org/apache/commons/digester3/Digester.html#push(java.lang.String, T)">
+ <li><a href="../apidocs/org/apache/commons/digester3/Digester.html#push(java.lang.String, T)">
void push(String stackName, Object value)</a></li>
- <li><a href="apidocs/org/apache/commons/digester3/Digester.html#pop(java.lang.String)">
+ <li><a href="../apidocs/org/apache/commons/digester3/Digester.html#pop(java.lang.String)">
Object pop(String stackName)</a></li>
- <li><a href="apidocs/org/apache/commons/digester3/Digester.html#peek(java.lang.String)">
+ <li><a href="../apidocs/org/apache/commons/digester3/Digester.html#peek(java.lang.String)">
Object peek(String stackName)</a></li>
</ul>
<p>
@@ -1259,20 +1259,20 @@ Detailed descriptions are contained with
</p>
<ul>
<li>
-<a href="apidocs/org/apache/commons/digester3/plugins/package-summary.html">plugins</a> provides a framework for the easy
+<a href="../apidocs/org/apache/commons/digester3/plugins/package-summary.html">plugins</a> provides a framework for the easy
dynamic addition of rules during a Digestion. Rules can trigger the dynamic addition
of other rules in an intuitive fashion.
</li>
<li>
-<a href="apidocs/org/apache/commons/digester3/substitution/package-summary.html">substitution</a> provides for
+<a href="../apidocs/org/apache/commons/digester3/substitution/package-summary.html">substitution</a> provides for
manipulation of attributes and element body text before it is processed by the rules.
</li>
<li>
-<a href="apidocs/org/apache/commons/digester3/xmlrules/package-summary.html">xmlrules</a> package contains a
+<a href="../apidocs/org/apache/commons/digester3/xmlrules/package-summary.html">xmlrules</a> package contains a
system allowing digester rule configurations to be specifed through an xml file.
</li>
<li>
-<a href="apidocs/org/apache/commons/digester3/annotations/package-summary.html">annotations</a> package contains a
+<a href="../apidocs/org/apache/commons/digester3/annotations/package-summary.html">annotations</a> package contains a
system allowing digester rule configurations to be specifed through Java5 Annotations.
</li>
</ul>