Cantaloop CGimlet - API Documentation, Version: 0.2.0, Date: 2002-05-13 21:30 CEST

org.cantaloop.cgimlet
Class OptionReaderConfigurator

java.lang.Object
  |
  +--org.cantaloop.cgimlet.OptionReaderConfigurator

public class OptionReaderConfigurator
extends java.lang.Object

You can use this class to adapt a OptionReader to your needs.

Version:
0.2.0 ($Revision: 1.6 $)
Author:
David Leuschner, Stefan Heimann

Constructor Summary
OptionReaderConfigurator(org.dom4j.Namespace ns)
          Shorthand for OptionReaderConfigurator(new QName("option", ns)).
OptionReaderConfigurator(org.dom4j.QName elemName)
          Shorthand for OptionReaderConfigurator(elemName, "name", "value").
OptionReaderConfigurator(org.dom4j.QName elemName, java.lang.String keyAttr, java.lang.String valueAttr)
          Creates a new OptionReaderConfigurator instance.
 
Method Summary
 org.dom4j.QName getElementName()
          Get the QName of the elements that contains the options.
 java.lang.String getKeyAttributeName()
          Get the name of the attribute that holds the key of the option
 java.lang.String getValueAttributeName()
          Get the name of the attribute that holds the value of the option
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionReaderConfigurator

public OptionReaderConfigurator(org.dom4j.Namespace ns)
Shorthand for OptionReaderConfigurator(new QName("option", ns)).
Parameters:
ns - a Namespace value

OptionReaderConfigurator

public OptionReaderConfigurator(org.dom4j.QName elemName)
Shorthand for OptionReaderConfigurator(elemName, "name", "value").
Parameters:
elemName - a QName value

OptionReaderConfigurator

public OptionReaderConfigurator(org.dom4j.QName elemName,
                                java.lang.String keyAttr,
                                java.lang.String valueAttr)
Creates a new OptionReaderConfigurator instance.
Parameters:
elemName - the QName of the element that holds a option
keyAttr - the name of the attribute of the element that holds the key of the option
valueAttr - the name of the attribute of the element that holds the value of the option
Method Detail

getElementName

public org.dom4j.QName getElementName()
Get the QName of the elements that contains the options.
Returns:
a QName value

getKeyAttributeName

public java.lang.String getKeyAttributeName()
Get the name of the attribute that holds the key of the option
Returns:
a String value

getValueAttributeName

public java.lang.String getValueAttributeName()
Get the name of the attribute that holds the value of the option
Returns:
a String value

Copyright 2001, 2002 Stefan Heimann, David Leuschner. All rights reserved.