Compartilhar via

Percorrer esquemas XML

A passagem de um esquema XML usando a API SOM (Modelo de Objeto de Esquema) fornece acesso aos elementos, atributos e tipos armazenados no SOM. Atravessar um esquema XML carregado no SOM também é a primeira etapa na edição de um esquema XML usando a API SOM.

Percorrendo um esquema XML

As propriedades a seguir da XmlSchema classe fornecem acesso à coleção de todos os itens globais adicionados ao esquema XML.

Propriedade Tipo de objeto armazenado na coleção ou matriz
Elements XmlSchemaElement
Attributes XmlSchemaAttribute
AttributeGroups XmlSchemaAttributeGroup
Groups XmlSchemaGroup
Includes XmlSchemaExternal, XmlSchemaInclude, XmlSchemaImportou XmlSchemaRedefine
Items XmlSchemaObject (fornece acesso a todos os elementos, atributos e tipos de nível global).
Notations XmlSchemaNotation
SchemaTypes XmlSchemaType, , XmlSchemaSimpleTypeXmlSchemaComplexType
UnhandledAttributes XmlAttribute (fornece acesso a atributos que não pertencem ao namespace de esquema)

Observação

Todas as propriedades listadas na tabela acima, exceto a Items propriedade, são propriedades PSCI (Post-Schema-Compilation-Infoset) que não estão disponíveis até que o esquema seja compilado. A Items propriedade é uma propriedade de pré-compilação de esquema que pode ser usada antes que o esquema seja compilado para acessar e editar todos os elementos, atributos e tipos de nível global.

A UnhandledAttributes propriedade fornece acesso a todos os atributos que não pertencem ao namespace de esquema. Esses atributos não são processados pelo processador de esquema.

O exemplo de código a seguir demonstra a navegação do esquema de cliente criado no tópico Construção de Esquemas XML. O exemplo de código demonstra a passagem do esquema usando as coleções descritas acima e grava todos os elementos e atributos no esquema no console.

O exemplo percorre o esquema do cliente nas etapas a seguir.

  1. Adiciona o esquema do cliente a um novo XmlSchemaSet objeto e o compila. Todos os avisos e erros de validação de esquema encontrados lendo ou compilando o esquema são tratados pelo ValidationEventHandler delegado.

  2. Recupera o objeto compilado XmlSchema a partir da XmlSchemaSet, iterando sobre a propriedade Schemas. Como o esquema é compilado, as propriedades PSCI (Post-Schema-Compilation-Infoset) são acessíveis.

  3. Itera sobre cada XmlSchemaElement na coleção Values da coleção de pós-compilação de esquema XmlSchema.Elements, escrevendo o nome de cada elemento no console.

  4. Obtém o tipo complexo do Customer elemento usando a XmlSchemaComplexType classe.

  5. Se o tipo complexo tiver quaisquer atributos, receberá um IDictionaryEnumerator para enumerar sobre cada XmlSchemaAttribute e escreverá seu nome no console.

  6. Obtém a partícula de sequência do tipo complexo usando a XmlSchemaSequence classe.

  7. Itera sobre cada elemento XmlSchemaElement da coleção XmlSchemaSequence.Items, escrevendo o nome de cada elemento filho no console.

Veja a seguir o exemplo de código completo.

using System;
using System.Collections;
using System.Xml;
using System.Xml.Schema;

class XmlSchemaTraverseExample
{
    static void Main()
    {
        // Add the customer schema to a new XmlSchemaSet and compile it.
        // Any schema validation warnings and errors encountered reading or
        // compiling the schema are handled by the ValidationEventHandler delegate.
        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.ValidationEventHandler += new ValidationEventHandler(ValidationCallback);
        schemaSet.Add("http://www.tempuri.org", "customer.xsd");
        schemaSet.Compile();

        // Retrieve the compiled XmlSchema object from the XmlSchemaSet
        // by iterating over the Schemas property.
        XmlSchema customerSchema = null;
        foreach (XmlSchema schema in schemaSet.Schemas())
        {
            customerSchema = schema;
        }

        // Iterate over each XmlSchemaElement in the Values collection
        // of the Elements property.
        foreach (XmlSchemaElement element in customerSchema.Elements.Values)
        {

            Console.WriteLine($"Element: {element.Name}");

            // Get the complex type of the Customer element.
            XmlSchemaComplexType complexType = element.ElementSchemaType as XmlSchemaComplexType;

            // If the complex type has any attributes, get an enumerator
            // and write each attribute name to the console.
            if (complexType.AttributeUses.Count > 0)
            {
                IDictionaryEnumerator enumerator =
                    complexType.AttributeUses.GetEnumerator();

                while (enumerator.MoveNext())
                {
                    XmlSchemaAttribute attribute =
                        (XmlSchemaAttribute)enumerator.Value;

                    Console.WriteLine($"Attribute: {attribute.Name}");
                }
            }

            // Get the sequence particle of the complex type.
            XmlSchemaSequence sequence = complexType.ContentTypeParticle as XmlSchemaSequence;

            // Iterate over each XmlSchemaElement in the Items collection.
            foreach (XmlSchemaElement childElement in sequence.Items)
            {
                Console.WriteLine($"Element: {childElement.Name}");
            }
        }
    }

    static void ValidationCallback(object sender, ValidationEventArgs args)
    {
        if (args.Severity == XmlSeverityType.Warning)
            Console.Write("WARNING: ");
        else if (args.Severity == XmlSeverityType.Error)
            Console.Write("ERROR: ");

        Console.WriteLine(args.Message);
    }
}

Imports System.Collections
Imports System.Xml
Imports System.Xml.Schema

Class XmlSchemaTraverseExample

    Shared Sub Main()

        ' Add the customer schema to a new XmlSchemaSet and compile it.
        ' Any schema validation warnings and errors encountered reading or 
        ' compiling the schema are handled by the ValidationEventHandler delegate.
        Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()
        AddHandler schemaSet.ValidationEventHandler, AddressOf ValidationCallback
        schemaSet.Add("http://www.tempuri.org", "customer.xsd")
        schemaSet.Compile()

        ' Retrieve the compiled XmlSchema object from the XmlSchemaSet
        ' by iterating over the Schemas property.
        Dim customerSchema As XmlSchema = Nothing
        For Each schema As XmlSchema In schemaSet.Schemas()
            customerSchema = schema
        Next

        ' Iterate over each XmlSchemaElement in the Values collection
        ' of the Elements property.
        For Each element As XmlSchemaElement In customerSchema.Elements.Values

            Console.WriteLine("Element: {0}", element.Name)

            ' Get the complex type of the Customer element.
            Dim complexType As XmlSchemaComplexType = CType(element.ElementSchemaType, XmlSchemaComplexType)

            ' If the complex type has any attributes, get an enumerator 
            ' and write each attribute name to the console.
            If complexType.AttributeUses.Count > 0 Then

                Dim enumerator As IDictionaryEnumerator = _
                    complexType.AttributeUses.GetEnumerator()

                While enumerator.MoveNext()

                    Dim attribute As XmlSchemaAttribute = _
                        CType(enumerator.Value, XmlSchemaAttribute)

                    Console.WriteLine("Attribute: {0}", Attribute.Name)
                End While
            End If

            ' Get the sequence particle of the complex type.
            Dim sequence As XmlSchemaSequence = CType(complexType.ContentTypeParticle, XmlSchemaSequence)

            For Each childElement As XmlSchemaElement In sequence.Items
                Console.WriteLine("Element: {0}", childElement.Name)
            Next
        Next

    End Sub

    Shared Sub ValidationCallback(ByVal sender As Object, ByVal args As ValidationEventArgs)
        If args.Severity = XmlSeverityType.Warning Then
            Console.Write("WARNING: ")
        Else
            If args.Severity = XmlSeverityType.Error Then
                Console.Write("ERROR: ")
            End If
        End If
        Console.WriteLine(args.Message)
    End Sub

End Class

A XmlSchemaElement.ElementSchemaType propriedade pode ser XmlSchemaSimpleType, ou XmlSchemaComplexType se for um tipo simples definido pelo usuário ou um tipo complexo. Também pode ser XmlSchemaDatatype se for um dos tipos de dados internos definidos na Recomendação de Esquema XML W3C. No esquema do cliente, o ElementSchemaType do elemento Customer é XmlSchemaComplexType, e os elementos FirstName e LastName são XmlSchemaSimpleType.

O exemplo de código no tópico Esquemas XML de Construção usou a XmlSchemaComplexType.Attributes coleção para adicionar o atributo CustomerId ao Customer elemento. Essa é uma propriedade de pré-compilação de esquema. A propriedade Post-Schema-Compilation-Infoset correspondente é a coleção XmlSchemaComplexType.AttributeUses, que contém todos os atributos do tipo complexo, incluindo aqueles que são herdados através da derivação de tipo.

Consulte também

  • Last updated on