Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.digester.Rule
org.apache.commons.digester.SetPropertiesRule
public class SetPropertiesRule
extends Rule
SetPropertiesRule(String[] attributeNames, String[] propertyNames)
.
This allows attributes to be mapped to properties with different names.
Certain attributes can also be marked to be ignored.
Field Summary | |
private String[] |
|
private String[] |
|
Fields inherited from class org.apache.commons.digester.Rule | |
digester , namespaceURI |
Constructor Summary | |
| |
| |
| |
|
Method Summary | |
void |
|
void |
|
String |
|
Methods inherited from class org.apache.commons.digester.Rule | |
begin , begin , body , body , end , end , finish , getDigester , getNamespaceURI , setDigester , setNamespaceURI |
private String[] attributeNames
Attribute names used to override natural attribute->property mapping
private String[] propertyNames
Property names used to override natural attribute->property mapping
public SetPropertiesRule()
Base constructor.
public SetPropertiesRule(String attributeName, String propertyName)
Convenience constructor overrides the mapping for just one property. For details about how this works, seeSetPropertiesRule(String[] attributeNames, String[] propertyNames)
.
- Parameters:
attributeName
- map this attributepropertyName
- to a property with this name
public SetPropertiesRule(String[] attributeNames, String[] propertyNames)
Constructor allows attribute->property mapping to be overriden. Two arrays are passed in. One contains the attribute names and the other the property names. The attribute name / property name pairs are match by position In order words, the first string in the attribute name list matches to the first string in the property name list and so on. If a property name is null or the attribute name has no matching property name, then this indicates that the attibute should be ignored.Example One
The following constructs a rule that maps thealt-city
attribute to thecity
property and thealt-state
to thestate
property. All other attributes are mapped as usual using exact name matching.
SetPropertiesRule( new String[] {"alt-city", "alt-state"}, new String[] {"city", "state"});Example Two
The following constructs a rule that maps theclass
attribute to theclassName
property. The attributeignore-me
is not mapped. All other attributes are mapped as usual using exact name matching.
SetPropertiesRule( new String[] {"class", "ignore-me"}, new String[] {"className"});
- Parameters:
attributeNames
- names of attributes to mappropertyNames
- names of properties mapped to
public SetPropertiesRule(Digester digester)
Deprecated. The digester instance is now set in the
Digester.addRule(String,Rule)
method. UseSetPropertiesRule()
instead.Default constructor sets only the the associated Digester.
- Parameters:
digester
- The digester with which this rule is associated
public void addAlias(String attributeName, String propertyName)
Add an additional attribute name to property name mapping. This is intended to be used from the xml rules.
public void begin(Attributes attributes) throws Exception
Process the beginning of this element.
- Overrides:
- begin in interface Rule
- Parameters:
attributes
- The attribute list of this element
public String toString()
Render a printable version of this Rule.