Java/JAXB: Unmarshall Xml a sottoclasse specifica basata su un attributo

Question

È possibile utilizzare JAXB per unmarshall xml in una classe Java specifica basata su un attributo di xml?

<shapes> 
    <shape type="square" points="4" square-specific-attribute="foo" /> 
    <shape type="triangle" points="3" triangle-specific-attribute="bar" /> 
</shapes> 

desidero avere un elenco di oggetti Shape contenenti un triangolo e un quadrato, ciascuna con il proprio attributo specifico forma. IE:

abstract class Shape { 
    int points; 
    //...etc 
} 

class Square extends Shape { 
    String square-specific-attribute; 
    //...etc 
} 

class Triangle extends Shape { 
    String triangle-specific-attribute; 
    //...etc 
} 

Attualmente sto solo mettendo tutti gli attributi in un unico grande "Shape" di classe ed è tutt'altro che ideali.

Potrei farlo funzionare se le forme fossero denominate correttamente elementi xml, ma sfortunatamente non ho il controllo dell'xml che sto recuperando.

Grazie!

Answer 1

JAXB è una specifica, implementazioni specifiche forniranno punti di estensione per fare cose come questa. Se si utilizza EclipseLink JAXB (MOXy) si potrebbe modificare la classe Shape come segue:

import javax.xml.bind.annotation.XmlAttribute; 
import org.eclipse.persistence.oxm.annotations.XmlCustomizer; 

@XmlCustomizer(ShapeCustomizer.class) 
public abstract class Shape { 

    int points; 

    @XmlAttribute 
    public int getPoints() { 
     return points; 
    } 

    public void setPoints(int points) { 
     this.points = points; 
    } 

} 

Poi utilizzando il Moxy @XMLCustomizer si poteva accedere al InheritancePolicy e modificare il campo indica la classe da "@xsi: tipo" a "tipo" solo :

import org.eclipse.persistence.config.DescriptorCustomizer; 
import org.eclipse.persistence.descriptors.ClassDescriptor; 

public class ShapeCustomizer implements DescriptorCustomizer { 

    @Override 
    public void customize(ClassDescriptor descriptor) throws Exception { 
     descriptor.getInheritancePolicy().setClassIndicatorFieldName("@type"); 
    } 
} 

sarà necessario assicurarsi di avere un file di jaxb.properties con voi classi del modello (forma, Piazza, ecc) con la seguente voce specificando l'attuazione EclipseLink Moxy JAXB:

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory 

Di seguito il resto delle classi del modello:

forme

import java.util.ArrayList; 
import java.util.List; 

import javax.xml.bind.annotation.XmlRootElement; 

@XmlRootElement 
public class Shapes { 

    private List<Shape> shape = new ArrayList<Shape>();; 

    public List<Shape> getShape() { 
     return shape; 
    } 

    public void setShape(List<Shape> shape) { 
     this.shape = shape; 
    } 

} 

Piazza

import javax.xml.bind.annotation.XmlAttribute; 

public class Square extends Shape { 
    private String squareSpecificAttribute; 

    @XmlAttribute(name="square-specific-attribute") 
    public String getSquareSpecificAttribute() { 
     return squareSpecificAttribute; 
    } 

    public void setSquareSpecificAttribute(String s) { 
     this.squareSpecificAttribute = s; 
    } 

} 

Triangolo

import javax.xml.bind.annotation.XmlAttribute; 

public class Triangle extends Shape { 
    private String triangleSpecificAttribute; 

    @XmlAttribute(name="triangle-specific-attribute") 
    public String getTriangleSpecificAttribute() { 
     return triangleSpecificAttribute; 
    } 

    public void setTriangleSpecificAttribute(String t) { 
     this.triangleSpecificAttribute = t; 
    } 

} 

Qui di seguito è un programma demo per verificare che tutto funzioni :

import java.io.StringReader; 
import javax.xml.bind.JAXBContext; 
import javax.xml.bind.Marshaller; 
import javax.xml.bind.Unmarshaller; 

public class Demo { 

    public static void main(String[] args) throws Exception { 
     JAXBContext jaxbContext = JAXBContext.newInstance(Shapes.class, Triangle.class, Square.class); 

     StringReader xml = new StringReader("<shapes><shape square-specific-attribute='square stuff' type='square'><points>4</points></shape><shape triangle-specific-attribute='triangle stuff' type='triangle'><points>3</points></shape></shapes>"); 
     Unmarshaller unmarshaller = jaxbContext.createUnmarshaller(); 
     Shapes root = (Shapes) unmarshaller.unmarshal(xml); 

     Marshaller marshaller = jaxbContext.createMarshaller(); 
     marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); 
     marshaller.marshal(root, System.out); 
    } 
} 

Spero che questo aiuti.

Per ulteriori informazioni su EclipseLink Moxy vedere:

• http://www.eclipse.org/eclipselink/moxy.php

EDIT

In EclipseLink 2.2 stiamo rendendo questo più facile da configurare, controllare il seguente articolo per ulteriori informazioni:

• http://bdoughan.blogspot.com/2010/11/jaxb-and-inheritance-moxy-extension.html

Answer 2

No, temo che non sia un'opzione, JAXB non è così flessibile.

Il meglio che posso suggerire è che si mette un metodo sulla classe Shape che istanzia il tipo "corretto" in base all'attributo. Il codice client invocerebbe quel metodo di fabbrica per ottenerlo.

Il meglio che posso venire, mi dispiace.

Answer 3

AFAIK, dovrete scrivere un XmlAdapter che sa come gestire il marshall/unmarshalling della forma.

Answer 4

L'annotazione @XmlElements consente di specificare quali tag corrisponde con la quale sottoclasse.

@XmlElements({ 
    @XmlElement(name="square", type=Square.class), 
    @XmlElement(name="triangle", type=Triangle.class) 
}) 
public List<Shape> getShape() { 
    return shape; 
} 

vedono anche javadoc per @XmlElements

Answer 5

C'è @XmlSeeAlso annotazione per dire di legare sottoclassi.

Ad esempio, con le seguenti definizioni delle classi:

class Animal {} 
class Dog extends Animal {} 
class Cat extends Animal {} 

All'utente viene richiesto di creare JAXBContext come JAXBContext.newInstance (Dog.class, Cat.class) (Animale verrà automaticamente preso dal cane e Cat si riferisce ad essa)

XmlSeeAlso annotazione permetterebbe di scrivere:.

@XmlSeeAlso({Dog.class,Cat.class}) 
class Animal {} 
class Dog extends Animal {} 
class Cat extends Animal {}