org.apache.commons.digester
Class CallParamRule

java.lang.Object
  |
  +--org.apache.commons.digester.Rule
        |
        +--org.apache.commons.digester.CallParamRule

public class CallParamRule

extends Rule

Rule implementation that saves a parameter from either an attribute of this element, or from the element body, to be used in a call generated by a surrounding CallMethodRule rule.

Version:

$Revision: 1.7 $ $Date: 2002/03/23 17:45:57 $

Author:

Craig McClanahan

Field Summary

protected java.lang.String	attributeName The attribute from which to save the parameter value
protected java.lang.String	bodyText The body text collected from this element.
protected int	paramIndex The zero-relative index of the parameter we are saving.

Fields inherited from class org.apache.commons.digester.Rule

digester, namespaceURI

Constructor Summary

CallParamRule(Digester digester, int paramIndex)
Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use CallParamRule(int paramIndex) instead.

CallParamRule(Digester digester, int paramIndex, java.lang.String attributeName)
Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use CallParamRule(int paramIndex, String attributeName) instead.

CallParamRule(int paramIndex)
Construct a "call parameter" rule that will save the body text of this element as the parameter value.

CallParamRule(int paramIndex, java.lang.String attributeName)
Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.

Method Summary

void	begin(org.xml.sax.Attributes attributes) Process the start of this element.
void	body(java.lang.String bodyText) Process the body text of this element.
void	end() Process the end of this element.
void	finish() Clean up after parsing is complete.
java.lang.String	toString() Render a printable version of this Rule.

Methods inherited from class org.apache.commons.digester.Rule

getDigester, getNamespaceURI, setDigester, setNamespaceURI

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

attributeName

protected java.lang.String attributeName

The attribute from which to save the parameter value

bodyText

protected java.lang.String bodyText

The body text collected from this element.

paramIndex

protected int paramIndex

The zero-relative index of the parameter we are saving.

Constructor Detail

CallParamRule

public CallParamRule(Digester digester,
                     int paramIndex)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use CallParamRule(int paramIndex) instead.

Construct a "call parameter" rule that will save the body text of this element as the parameter value.

Parameters:

digester - The associated Digester

paramIndex - The zero-relative parameter number

CallParamRule

public CallParamRule(Digester digester,
                     int paramIndex,
                     java.lang.String attributeName)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use CallParamRule(int paramIndex, String attributeName) instead.

Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.

Parameters:

digester - The associated Digester

paramIndex - The zero-relative parameter number

attributeName - The name of the attribute to save

CallParamRule

public CallParamRule(int paramIndex)

Construct a "call parameter" rule that will save the body text of this element as the parameter value.

Parameters:

paramIndex - The zero-relative parameter number

CallParamRule

public CallParamRule(int paramIndex,
                     java.lang.String attributeName)

Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.

Parameters:

paramIndex - The zero-relative parameter number

attributeName - The name of the attribute to save

Method Detail

begin

public void begin(org.xml.sax.Attributes attributes)
           throws java.lang.Exception

Process the start of this element.

Overrides:

begin in class Rule

Parameters:

attributes - The attribute list for this element

body

public void body(java.lang.String bodyText)
          throws java.lang.Exception

Process the body text of this element.

Overrides:

body in class Rule

Parameters:

bodyText - The body text of this element

end

public void end()
         throws java.lang.Exception

Process the end of this element.

Overrides:

end in class Rule

finish

public void finish()
            throws java.lang.Exception

Clean up after parsing is complete.

Overrides:

finish in class Rule

toString

public java.lang.String toString()

Render a printable version of this Rule.

Overrides:

toString in class java.lang.Object