¿Qué hace elementFormDefault en XSD?

Considere el siguiente tipo complejo AuthorType utilizado por el elemento author

<xsd:complexType name="AuthorType">
  <!-- compositor goes here -->
  <xsd:sequence>
     <xsd:element name="name" type="xsd:string"/>
     <xsd:element name="phone" type="tns:Phone"/>
  </xsd:sequence>
  <xsd:attribute name="id" type="tns:AuthorId"/>
</xsd:complexType>
<xsd:element name="author" type="tns:AuthorType"/>

Si elementFormDefault="unqualified"

Entonces la siguiente instancia XML es válida

<x:author xmlns:x="http://example.org/publishing">
   <name>Aaron Skonnard</name>
   <phone>(801)390-4552</phone>
</x:author>

El atributo nombre de los autores está permitido sin especificar el espacio de nombres(no calificado). Cualquier elemento que forme parte de <xsd:complexType> se considera local a complexType.

Si elementFormDefault="qualified"

Entonces la instancia debe tener los elementos locales calificados

<x:author xmlns:x="http://example.org/publishing">
   <x:name>Aaron Skonnard</name>
   <x:phone>(801)390-4552</phone>
</x:author>

Por favor refiérase este enlace para más detalles

_{Nueva y detallada respuesta y explicación a una vieja pregunta frecuente...}

Respuesta corta: Si no agrega elementFormDefault="qualified" a xsd:schema, entonces el valor predeterminado unqualified significa que los elementos declarados localmente están en sin espacio de nombres.

Hay mucha confusión con respecto a lo que hace elementFormDefault, pero esto se puede aclarar rápidamente con un breve ejemplo...

Versión simplificada de su XSD:

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:target="http://www.levijackson.net/web340/ns"
        targetNamespace="http://www.levijackson.net/web340/ns">
  <element name="assignments">
    <complexType>
      <sequence>
        <element name="assignment" type="target:assignmentInfo" 
                 minOccurs="1" maxOccurs="unbounded"/>
      </sequence>
    </complexType>
  </element>
  <complexType name="assignmentInfo">
    <sequence>
      <element name="name" type="string"/>
    </sequence>
    <attribute name="id" type="string" use="required"/>
  </complexType>
</schema>

Clave puntos:

• El elemento assignment está definido localmente.
• Los elementos definidos localmente en XSD no están en ningún espacio de nombres por defecto.
  • Esto se debe a que el valor predeterminado para elementFormDefault es unqualified.
  • Esto podría ser un error de diseño de los creadores de XSD.
  • La práctica habitual es utilizar siempre elementFormDefault="qualified" así que assignment está en el espacio de nombres de destino como uno esperar.

XML aparentemente válido

Este XML parece que debería ser válido de acuerdo con el XSD anterior:

<assignments xmlns="http://www.levijackson.net/web340/ns"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://www.levijackson.net/web340/ns try.xsd">
  <assignment id="a1">
    <name>John</name>
  </assignment>
</assignments>

Aviso:

• El espacio de nombres predeterminado en assignments coloca assignments y todos sus descendientes en el espacio de nombres predeterminado (http://www.levijackson.net/web340/ns).

Error de validación Desconcertante

A pesar de parecer válido, el XML anterior produce el siguiente error de validación confuso:

[Error] try.xml: 4: 23: cvc-complex-type.2.4.r: El contenido no válido fue encontrado a partir de elemento 'asignación'. Uno de '{asignación} ' es previsto.

Notas:

• No sería el primer desarrollador en maldecir este diagnóstico que parece decir que el contenido no es válido porque esperaba encontrar un elemento assignment, pero en realidad encontró un elemento assignment. (WTF )
• Lo que esto realmente significa: El { y } alrededor de assignment significa que la validación se esperaba assignment en ningún espacio de nombres aquí. Desafortunadamente, cuando dice que encontró un elemento assignment, no menciona que lo encontró en un espacio de nombres predeterminado que difiere de ningún espacio de nombres.

Solución

• La mayor parte del tiempo: Agrega elementFormDefault="qualified" al elemento xsd:schema del XSD. Esto significa que XML válido debe colocar elementos en el espacio de nombres de destino cuando se declare localmente en el XSD; de lo contrario, XML válido debe colocar elementos declarados localmente en ningún espacio de nombres.
• Minúscula minoría de los tiempo: Cambiar el XML para cumplir con los XSD requisito de que assignment no esté en ningún espacio de nombres. Esto se puede lograr, por ejemplo, añadiendo xmlns="" al elemento assignment.

Importante tener en cuenta con elementFormDefault es que se aplica a localmente elementos definidos, típicamente llamados elementos dentro de un bloque complexType, a diferencia de los elementos globales definidos en el nivel superior del esquema. Con elementFormDefault= "qualified" puede abordar elementos locales del esquema desde el documento xml utilizando el espacio de nombres de destino del esquema como espacio de nombres predeterminado del documento.

En la práctica, use elementFormDefault= "qualified" para poder declarar elementos en bloques anidados, de lo contrario tendrá que declarar todos los elementos en el nivel superior y referirse a ellos en el esquema en elementos anidados utilizando el atributo ref, lo que resulta en un esquema mucho menos compacto.

Este bit del primer Esquema XML habla de ello: http://www.w3.org/TR/xmlschema-0/#NS

ElementFormDefault="qualified" se usa para controlar el uso de espacios de nombres en documentos de instancia XML (.xml), en lugar de espacios de nombres en el propio documento de esquema (.archivo xsd).

Al especificar elementFormDefault="qualified" aplicamos la declaración de espacio de nombres para ser utilizada en documentos validados con este esquema.

Es práctica común especificar este valor para declarar que los elementos deben estar calificados en lugar de no calificados. Sin embargo, desde attributeFormDefault= "unqualified" es el valor predeterminado, no necesita ser especificado en el documento de esquema, si uno no quiere calificar los espacios de nombres.

He notado que XMLSpy(al menos la versión 2011)necesita un targetNamespace definido si se utiliza elementFormDefault="qualified". De lo contrario no se validará. Y tampoco generará xmls con prefijos de espacio de nombres