Save This Page
Home » xml-commons-external-1.4.01-src » javax » xml » bind » annotation » [javadoc | source]
javax.xml.bind.annotation
public class: XmlID [javadoc | source]
javax.xml.bind.annotation.XmlID

Maps a JavaBean property to XML ID.

To preserve referential integrity of an object graph across XML serialization followed by a XML deserialization, requires an object reference to be marshalled by reference or containment appropriately. Annotations @XmlID and @XmlIDREF together allow a customized mapping of a JavaBean property's type by containment or reference.

Usage

The @XmlID annotation can be used with the following program elements:

See "Package Specification" in javax.xml.bind.package javadoc for additional common information.

The usage is subject to the following constraints:

Example: Map a JavaBean property's type to xs:ID

   // Example: code fragment
   public class Customer {
       @XmlAttribute
       @XmlID
       public String getCustomerID();
       public void setCustomerID(String id);
       .... other properties not shown
   }

   <!-- Example: XML Schema fragment -->
   <xs:complexType name="Customer">
     <xs:complexContent>
       <xs:sequence>
         ....
       </xs:sequence>
       <xs:attribute name="customerID" type="xs:ID"/>
     </xs:complexContent>
   </xs:complexType>