Aprende Java Aprende Php Aprende C++ Aprende HTML 5 Aprende JavaScript Aprende JSON Aprende MySQL Aprende SQLServer Aprende Visual Basic 6 Aprende PostgreSQL Aprende SQLite Aprende Redis Aprende Kotlin Aprende XML Aprende Linux VSC Aprende Wordpress Aprende Laravel Aprende VueJS Aprende JQuery Aprende Bootstrap Aprende Netbeans Aprende Android
Sigueme en Facebook Sigueme en Twitter Sigueme en Instagram Sigueme en Youtube Sigueme en TikTok Sigueme en Whatsapp
Home / Java / Generar clases desde Esquemas XSD

Generar clases desde Esquemas XSD

Por jc mouse lunes, febrero 18, 2019

XJC es una herramienta de linea de comandos del compilador de esquemas de JAXB que se puede utilizar para convertir un esquema XML (entre otro tipo de archivos como NG, DTD, WSDL, etc) a representaciones de clase.​ Las clases se generaran junto a anotaciones del espacio de nombres javax.xml.bind.annotation.*.

El Esquema que utilizaremos se llama MiEsquema.xsd, este esquema lo utilizamos en otro post [Validación de documentos XML con XSD] y es el esquema de un pequeño formulario.

Al ser xjc una herramienta por linea de comandos antes de continuar con el post, se debe asegurar que java este incluida en el PATH del sistema.

Comencemos.

Crea un nuevo archivo XSD en tu pc con el siguiente código y guarda con el nombre MiEsquema.xsd.

<?xml version="1.0"?>
<xs:schema version="1.0"
           xmlns:xs="http://www.w3.org/2001/XMLSchema"
           elementFormDefault="qualified">
    <xs:element name="formulario">
        <xs:complexType>
            <xs:sequence>
                <!-- Nombre de usuario -->
                <xs:element name="nombre" >
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="6" />
                            <xs:maxLength value="32" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <!-- Edad, solo mayores de 18 años -->
                <xs:element name="edad">
                    <xs:simpleType>
                        <xs:restriction base="xs:integer">
                            <xs:minInclusive value="18" />
                            <xs:maxInclusive value="99" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>              
                <!-- Correo electonico -->
                <xs:element name="mail">
                    <xs:simpleType> 
                        <xs:restriction base="xs:string"> 
                            <xs:pattern value="[^@]+@[^\.]+\..+"/> 
                        </xs:restriction> 
                    </xs:simpleType> 
                </xs:element>
                
            </xs:sequence>
        </xs:complexType>        
    </xs:element>
</xs:schema>

Abre un consola de comandos y posicionate en el lugar donde esta tu archivo XSD.

A continuación escribe:

xjc -d src -p org.example MiEsquema.xsd

donde:

  • xjc: Herramienta de linea de comandos
  • -d src: Los archivos generados se crearan en esa carpeta «src» (El directorio debe existir).
  • -p org.example: Indica el paquete (package) de destino, para este ejemplo el paquete es «org.example»
  • MiEsquema.xsd:  Es el esquema base para la creación de clases

Si deseas más información, utiliza el comando x:\>xjc -help para desplegar ayuda en pantalla

Este es el comando básico para la generación de clases java, para ejecutar el comando presiona la tecla [ENTER].

xjc ejemplo xsd

Los archivos generados son:

  • Formulario.java: Es la representación en código java del esquema XSD
  • ObjectFactory.java: Un ObjectFactory permite construir programáticamente nuevas instancias de la representación de Java para contenido XML. La representación de Java del contenido XML puede consistir en interfaces y clases derivadas de esquemas que representan el enlace de definiciones de tipo de esquema, declaraciones de elementos y grupos de modelos  Para un ejemplo como el de este post no nos sirve de mucho, su verdadera utilidad se nota con esquemas más complejos.

Archivo Formulario.java generado desde un XSD con la herramienta XJC

package org.example;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;


/**
 * <p>Clase Java para anonymous complex type.
 * 
 * <p>El siguiente fragmento de esquema especifica el contenido que se espera que haya en esta clase.
 * 
 * <pre>
 * &lt;complexType>
 *   &lt;complexContent>
 *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
 *       &lt;sequence>
 *         &lt;element name="nombre">
 *           &lt;simpleType>
 *             &lt;restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *               &lt;minLength value="6"/>
 *               &lt;maxLength value="32"/>
 *             &lt;/restriction>
 *           &lt;/simpleType>
 *         &lt;/element>
 *         &lt;element name="edad">
 *           &lt;simpleType>
 *             &lt;restriction base="{http://www.w3.org/2001/XMLSchema}integer">
 *               &lt;minInclusive value="18"/>
 *               &lt;maxInclusive value="99"/>
 *             &lt;/restriction>
 *           &lt;/simpleType>
 *         &lt;/element>
 *         &lt;element name="mail">
 *           &lt;simpleType>
 *             &lt;restriction base="{http://www.w3.org/2001/XMLSchema}string">
 *               &lt;pattern value="[^@]+@[^\.]+\..+"/>
 *             &lt;/restriction>
 *           &lt;/simpleType>
 *         &lt;/element>
 *       &lt;/sequence>
 *     &lt;/restriction>
 *   &lt;/complexContent>
 * &lt;/complexType>
 * </pre>
 * 
 * 
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "nombre",
    "edad",
    "mail"
})
@XmlRootElement(name = "formulario")
public class Formulario {

    @XmlElement(required = true)
    protected String nombre;
    protected int edad;
    @XmlElement(required = true)
    protected String mail;

    /**
     * Obtiene el valor de la propiedad nombre.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getNombre() {
        return nombre;
    }

    /**
     * Define el valor de la propiedad nombre.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setNombre(String value) {
        this.nombre = value;
    }

    /**
     * Obtiene el valor de la propiedad edad.
     * 
     */
    public int getEdad() {
        return edad;
    }

    /**
     * Define el valor de la propiedad edad.
     * 
     */
    public void setEdad(int value) {
        this.edad = value;
    }

    /**
     * Obtiene el valor de la propiedad mail.
     * 
     * @return
     *     possible object is
     *     {@link String }
     *     
     */
    public String getMail() {
        return mail;
    }

    /**
     * Define el valor de la propiedad mail.
     * 
     * @param value
     *     allowed object is
     *     {@link String }
     *     
     */
    public void setMail(String value) {
        this.mail = value;
    }

}

Como vimos en este post el código generado por xjc es bastante limpio y nos ahorra mucho tiempo de programación. Si bien el código generado se puede agregar directamente a un proyecto java, en ocasiones tendremos que realizar pequeñas modificaciones sobre este, pero aun así, es mucho más rápido que tener que hacerlo todo por nosotros mismos.

enjoy!!!

Tags

Artículos similares

JavaScript: Script y Web para generar banderas ondeando

Online Flag Waver es una páginas web con la que podemos generar banderas ondeando con la textura que elijamos ya sea des[...]

Tutorial HeidiSQL: Sesion, Base de datos y Tablas

HeidiSQL es un software libre y de código abierto que permite conectarse a servidores MySQL, MariaDB, Percona Server, Mi[...]

Búsqueda binaria (Binary Search)

Un algoritmo de búsqueda binaria se emplea para buscar un valor en particular en un arreglo previamente ordenado. Para i[...]

Sistema de gestión de stock – El Controlador (Parte 5)

Para terminar el tutorial, debemos unir tanto la VISTA como el MODELO y para eso esta el CONTROLADOR. o.O El controlador[...]

Lector Feed con Java/Rome

En este tutorial crearemos un lector de Feeds en Java/netbeans, pero antes debemosa saber que es un Feed, según Santa Wi[...]

Manejo de BLOB: Escritura y lectura de archivos

Un BLOB en SQL es un tipo incorporado que almacena un Objeto Binario Grande como un valor de columna en una fila de una[...]