Package org.eclipse.persistence.oxm.annotations

Annotation Type XmlJoinNode

  • @Target({METHOD,FIELD})
@Retention(RUNTIME)
public @interface XmlJoinNode

    XmlJoinNode is used in conjunction with XmlKey to specify a reference mapping. This is similar to XmlID and XmlIDREF but allows for keys that are of types other than ID. When used with XmlJoinNodes can be used to allow composite keys. The referencedXmlPath must match the xpath of a field on the target class that has been annotated with either XmlID or XmlKey.

    Example: 

     @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
 public class Employee {

     @XmlKey
     public String id;

     public String department;

       @XmlJoinNode(xmlPath="manager/id/text()", referencedXmlPath="id/text()")
     public Employee manager;
 }
    See Also:
    XmlKey, XmlJoinNodes

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String referencedXmlPath  
      java.lang.String xmlPath  

    • Element Detail

      • xmlPath

        java.lang.String xmlPath

      • referencedXmlPath

        java.lang.String referencedXmlPath