public class SetPropertiesRule extends Rule
Rule implementation that sets properties on the object at the top of the stack, based on attributes with corresponding names.
This rule supports custom mapping of attribute names to property names.
The default mapping for particular attributes can be overridden by using
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.
Type | Property and Description |
---|---|
boolean |
isIgnoreMissing
Gets the value of the property ignoreMissingProperty.
|
Modifier and Type | Field and Description |
---|---|
private java.lang.String[] |
attributeNames
Attribute names used to override natural attribute->property mapping
|
private boolean |
ignoreMissingProperty
Used to determine whether the parsing should fail if an property specified
in the XML is missing from the bean.
|
private java.lang.String[] |
propertyNames
Property names used to override natural attribute->property mapping
|
digester, namespaceURI
Constructor and Description |
---|
SetPropertiesRule()
Base constructor.
|
SetPropertiesRule(Digester digester)
Deprecated.
The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method.
Use SetPropertiesRule() instead. |
SetPropertiesRule(java.lang.String[] attributeNames,
java.lang.String[] propertyNames)
Constructor allows attribute->property mapping to be overriden.
|
SetPropertiesRule(java.lang.String attributeName,
java.lang.String propertyName)
Convenience constructor overrides the mapping for just one property.
|
Modifier and Type | Method and Description |
---|---|
void |
addAlias(java.lang.String attributeName,
java.lang.String propertyName)
Add an additional attribute name to property name mapping.
|
void |
begin(org.xml.sax.Attributes attributes)
Process the beginning of this element.
|
boolean |
isIgnoreMissingProperty()
Gets the value of the property ignoreMissingProperty.
|
void |
setIgnoreMissingProperty(boolean ignoreMissingProperty)
Sets whether attributes found in the xml without matching properties
should be ignored.
|
java.lang.String |
toString()
Render a printable version of this Rule.
|
begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
public boolean isIgnoreMissingProperty
private java.lang.String[] attributeNames
private java.lang.String[] propertyNames
private boolean ignoreMissingProperty
public SetPropertiesRule(Digester digester)
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method.
Use SetPropertiesRule()
instead.digester
- The digester with which this rule is associatedpublic SetPropertiesRule()
public SetPropertiesRule(java.lang.String attributeName, java.lang.String propertyName)
Convenience constructor overrides the mapping for just one property.
For details about how this works, see
SetPropertiesRule(String[] attributeNames, String[] propertyNames)
.
attributeName
- map this attributepropertyName
- to a property with this namepublic SetPropertiesRule(java.lang.String[] attributeNames, java.lang.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.
The following constructs a rule that maps the alt-city
attribute to the city
property and the alt-state
to the state
property.
All other attributes are mapped as usual using exact name matching.
SetPropertiesRule(
new String[] {"alt-city", "alt-state"},
new String[] {"city", "state"});
The following constructs a rule that maps the class
attribute to the className
property.
The attribute ignore-me
is not mapped.
All other attributes are mapped as usual using exact name matching.
SetPropertiesRule(
new String[] {"class", "ignore-me"},
new String[] {"className"});
attributeNames
- names of attributes to mappropertyNames
- names of properties mapped topublic void begin(org.xml.sax.Attributes attributes) throws java.lang.Exception
public void addAlias(java.lang.String attributeName, java.lang.String propertyName)
Add an additional attribute name to property name mapping. This is intended to be used from the xml rules.
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isIgnoreMissingProperty()
public void setIgnoreMissingProperty(boolean ignoreMissingProperty)
NoSuchMethodException
if an unmatched
attribute is found. This allows to trap misspellings in the XML file.ignoreMissingProperty
- false to stop the parsing on unmatched attributes.Copyright 2001-2005 The Apache Software Foundation.