XML Schema has a mechanism that allows you to leave a place holder for an arbitrary attribute in a complex type definition. Using this mechanism, you can define a complex type that can have any attribute. For example, you can create a type that defines the elements <robot name="epsilon" />, <robot age="10000" />, or <robot type="weevil" /> without specifying the three attributes. This can be particularly useful when flexibility in your data is required.
Undeclared attributes are defined in XML Schema using the anyAttribute
element. It can be
used wherever an attribute element can be used. The anyAttribute
element has no attributes, as
shown in Example 14.7.
Example 14.7. Complex Type with an Undeclared Attribute
<complexType name="arbitter">
<sequence>
<element name="name" type="xsd:string" />
<element name="rate" type="xsd:float" />
</sequence>
<anyAttribute />
</complexType>
The defined type, arbitter, has two elements and can have one attribute of any type. The elements three elements shown in Example 14.8 can all be generated from the complex type arbitter.
Example 14.8. Examples of Elements Defined with a Wild Card Attribute
<officer rank="12"><name>...</name><rate>...</rate></officer> <lawyer type="divorce"><name>...</name><rate>...</rate></lawyer> <judge><name>...</name><rate>...</rate></judge>
When a complex type containing an anyAttribute
element is mapped to Java, the code
generator adds a member called otherAttributes
to the generated class.
otherAttributes
is of type java.util.Map<QName, String>
and it has a
getter method that returns a live instance of the map. Because the map returned from the getter is live, any modifications to the
map are automatically applied. Example 14.9 shows the class generated for the complex
type defined in Example 14.7.
Example 14.9. Class for a Complex Type with an Undeclared Attribute
public class Arbitter { @XmlElement(required = true) protected String name; protected float rate; @XmlAnyAttribute private Map<QName, String> otherAttributes = new HashMap<QName, String>(); public String getName() { return name; } public void setName(String value) { this.name = value; } public float getRate() { return rate; } public void setRate(float value) { this.rate = value; } public Map<QName, String> getOtherAttributes() { return otherAttributes; } }
The otherAttributes
member of the generated class expects to be populated with a
Map
object. The map is keyed using QNames
. Once you get the map ,
you can access any attributes set on the object and set new attributes on the object.
Example 14.10 shows sample code for working with undeclared attributes.
The code in Example 14.10 does the following: