Difference between revisions of "EclipseLink/UserGuide/MOXy/Type Level/Handling Inheritance"

From Eclipsepedia

Jump to: navigation, search
Line 109: Line 109:
 
You can also use the MOXY-specific '''@XmlDescriminatorNode''' and '''@XmlDescrimintatorValue''' annotations available in EclipseLink 2.2 to represent inheritance. With this approach, you can select the attribute to represent the subtype.
 
You can also use the MOXY-specific '''@XmlDescriminatorNode''' and '''@XmlDescrimintatorValue''' annotations available in EclipseLink 2.2 to represent inheritance. With this approach, you can select the attribute to represent the subtype.
  
In this example an abstract super class ('''ContactInfo'') contains all types of contact information. The '''ContactInfo''' uses the '''@XmlDescriminatorNode''' annotation to specify the XML attribute ('''classifier''') to indicate the subtype.
+
Using the same example from above, the '''ContactInfo''' class uses the '''@XmlDescriminatorNode''' annotation to specify the XML attribute ('''classifier''') that will hold the subclass indicator. '''Address''' and '''PhoneNumber''' are annotated with '''@XmlDescriminatorValue''', indicating that class' indicator name ('''address-classifier''' and '''phone-number-classifier''').
 
+
'''Address''' and '''PhoneNumber''' are the concrete implementations of '''ContactInfo'''. The '''@XmlDescriminatorValue''' is used to override the default type name.
+
  
 
<source lang="java">
 
<source lang="java">

Revision as of 16:16, 19 April 2011

EclipseLink MOXy

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source

Contents

Handling Inheritance

EclipseLink MOXy provides several ways to represent your inheritance hierarchy in XML.


Using xsi:type

By default, EclipseLink will use the xsi:type attribute to represent inheritance in XML.

In this example an abstract super class (ContactInfo) contains all types of contact information. Address and PhoneNumber are the concrete implementations of ContactInfo.

public abstract class ContactInfo {
}
 
public class Address extends ContactInfo {
 
   private String street;
   ... 
 
}
 
public class PhoneNumber extends ContactInfo {
 
   private String number;
   ...
 
}


Because the Customer object can have different types of contact information, its property refers to the superclass.

 
@XmlRootElement
public class Customer {
 
   private ContactInfo contactInfo;
   ... 
 
}


Marshalling an example Customer would produce the following XML:

<customer>
   <contactInfo 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xsi:type="address">
      <street>323 Main Street</street>
   </contactInfo>
</customer>

Note the xsi:type attribute on the contactInfo element.


Using Substitution Groups

Another way to model inheritance in XML is through XML Schema's substitution groups functionality. Using this approach, the element name itself determines which subclass to use.

Taking the same example from above, we will add @XmlRootElement annotations to each of the subclasses, which will act as the inheritance indicator.

public abstract class ContactInfo {
}
 
@XmlRootElement
public class Address extends ContactInfo {
 
   private String street;
   ... 
 
}
 
@XmlRootElement
public class PhoneNumber extends ContactInfo {
 
   private String number;
   ...
 
}


Using this approach, marshalling an example Customer would produce the following XML:

<customer>
   <address>
      <street>323 Main Street</street>
   </address>
</customer>

Note that the Address object is marshalled to the address element.


Using @XmlDescriminatorNode / @XmlDescrimintatorValue

You can also use the MOXY-specific @XmlDescriminatorNode and @XmlDescrimintatorValue annotations available in EclipseLink 2.2 to represent inheritance. With this approach, you can select the attribute to represent the subtype.

Using the same example from above, the ContactInfo class uses the @XmlDescriminatorNode annotation to specify the XML attribute (classifier) that will hold the subclass indicator. Address and PhoneNumber are annotated with @XmlDescriminatorValue, indicating that class' indicator name (address-classifier and phone-number-classifier).

@XmlDiscriminatorNode("@classifier")
public abstract class ContactInfo {
}
 
@XmlDiscriminatorValue("address-classifier")
public class Address extends ContactInfo {
 
   private String street;
   ... 
 
}
 
@XmlDiscriminatorValue("phone-number-classifier")
public class PhoneNumber extends ContactInfo {
 
   private String number;
   ...
 
}


An example Customer would then produce the following The above sample produces the following XML:

<customer>
   <contactInfo classifier="address-classifier">
      <street>323 Main Street</street>
   </contactInfo>
</customer>

Notice that Address is marshalled to the contactInfo element. Its classifier attribute contains the discriminator node value address-classifier.


Eclipselink-logo.gif
Version: 2.2.0 DRAFT
Other versions...