Dil

XML şemalarını düzenleme

XML şemasını düzenlemek, Şema Nesne Modeli'nin (SOM) en önemli özelliklerinden biridir. BIR XML şemasındaki mevcut değerleri değiştirmek için SOM'un tüm şema öncesi derleme özellikleri kullanılabilir. Xml şeması daha sonra değişiklikleri yansıtacak şekilde yeniden derlenebilir.

SOM'a yüklenen bir şemayı düzenlemenin ilk adımı şemadan geçiş yapmaktır. Bir şemayı düzenlemeye çalışmadan önce SOM API'sini kullanarak şemada geçiş yapma konusunda bilgi sahibi olmanız gerekir. Ayrıca, Post-Schema-Compilation-Infoset (PSCI) öncesi ve sonrası şema derleme özelliklerini de bilmeniz gerekir.

XML Şemasını Düzenleme

Bu bölümde, her ikisi de XML Şemaları Oluşturma konusunda oluşturulan müşteri şemasını düzenleyen iki kod örneği sağlanmıştır. İlk kod örneği öğesine yeni PhoneNumber bir öğe Customer eklerken ikinci kod örneği öğeye Title yeni FirstName bir öznitelik ekler. İlk örnek, şema öncesi derleme XmlSchema.Elements koleksiyonunu kullanırken ikinci kod örneği de müşteri şemasında geçiş yapma aracı olarak şema XmlSchema.Items derleme sonrası koleksiyonunu kullanır.

PhoneNumber Öğesi Örneği

Bu ilk kod örneği, müşteri şemasının PhoneNumber öğesine yeni Customer bir öğe ekler. Kod örneği, aşağıdaki adımlarda müşteri şemasını düzenler.

  1. Müşteri şemasını, yeni bir XmlSchemaSet nesnesine ekler ve ardından derler. Şemayı okurken veya derlerken karşılaşılan tüm şema doğrulama uyarıları ve hataları temsilci tarafından ValidationEventHandler işlenir.

  2. XmlSchema öğesinden XmlSchemaSet özelliğini yineleyerek derlenmiş Schemas() nesnesini alır. Şema derlendiği için, Şema SonrasıCompilation-Infoset (PSCI) özelliklerine ulaşılabilir.

  3. PhoneNumber öğesini XmlSchemaElement sınıfı kullanarak oluşturur, xs:string sınıfı ve XmlSchemaSimpleTypeXmlSchemaSimpleTypeRestriction sınıfını kullanarak basit tür kısıtlamasını yapar, kısıtlamanın Facets özelliğine bir desen modeli ekler ve kısıtlamayı basit türün Content özelliğine ve basit türü SchemaType özelliğiyle birlikte PhoneNumber öğesine ekler.

  4. Şema sonrası derleme XmlSchemaElement koleksiyonunun Values koleksiyonundaki her XmlSchema.Elements üzerinde yinelenir.

  5. Eğer QualifiedName öğesinin "Customer" olduğu durumda, Customer öğesinin karmaşık türünü XmlSchemaComplexType sınıfını kullanarak ve karmaşık türün sıra parçacığını XmlSchemaSequence sınıfını kullanarak alır.

  6. Yeni PhoneNumber öğeyi, dizinin şema öncesi derleme FirstName koleksiyonunu kullanarak var olan LastName ve Items öğelerini içeren diziye ekler.

  7. Son olarak, XmlSchema sınıfının Reprocess ve Compile yöntemlerini kullanarak değiştirilen XmlSchemaSet nesnesini yeniden işler ve derler ve konsola yazar.

Aşağıda tam kod örneği verilmiştir.

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

class XmlSchemaEditExample
{
    static void Main(string[] args)
    {
        // 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;
        }

        // Create the PhoneNumber element.
        XmlSchemaElement phoneElement = new XmlSchemaElement();
        phoneElement.Name = "PhoneNumber";

        // Create the xs:string simple type restriction.
        XmlSchemaSimpleType phoneType = new XmlSchemaSimpleType();
        XmlSchemaSimpleTypeRestriction restriction =
            new XmlSchemaSimpleTypeRestriction();
        restriction.BaseTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // Add a pattern facet to the restriction.
        XmlSchemaPatternFacet phonePattern = new XmlSchemaPatternFacet();
        phonePattern.Value = "\\d{3}-\\d{3}-\\d(4)";
        restriction.Facets.Add(phonePattern);

        // Add the restriction to the Content property of the simple type
        // and the simple type to the SchemaType of the PhoneNumber element.
        phoneType.Content = restriction;
        phoneElement.SchemaType = phoneType;

        // Iterate over each XmlSchemaElement in the Values collection
        // of the Elements property.
        foreach (XmlSchemaElement element in customerSchema.Elements.Values)
        {
            // If the qualified name of the element is "Customer",
            // get the complex type of the Customer element
            // and the sequence particle of the complex type.
            if (element.QualifiedName.Name.Equals("Customer"))
            {
                XmlSchemaComplexType customerType =
                    element.ElementSchemaType as XmlSchemaComplexType;
                XmlSchemaSequence sequence =
                    customerType.Particle as XmlSchemaSequence;

                // Add the new PhoneNumber element to the sequence.
                sequence.Items.Add(phoneElement);
            }
        }

        // Reprocess and compile the modified XmlSchema object and write it to the console.
        schemaSet.Reprocess(customerSchema);
        schemaSet.Compile();
        customerSchema.Write(Console.Out);
    }

    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.Xml
Imports System.Xml.Schema

Class XmlSchemaEditExample

    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

        ' Create the PhoneNumber element.
        Dim phoneElement As XmlSchemaElement = New XmlSchemaElement()
        phoneElement.Name = "PhoneNumber"

        ' Create the xs:string simple type restriction.
        Dim phoneType As XmlSchemaSimpleType = New XmlSchemaSimpleType()
        Dim restriction As XmlSchemaSimpleTypeRestriction = _
            New XmlSchemaSimpleTypeRestriction()
        restriction.BaseTypeName = New XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema")

        ' Add a pattern facet to the restriction.
        Dim phonePattern As XmlSchemaPatternFacet = New XmlSchemaPatternFacet()
        phonePattern.Value = "\\d{3}-\\d{3}-\\d(4)"
        restriction.Facets.Add(phonePattern)

        ' Add the restriction to the Content property of the simple type
        ' and the simple type to the SchemaType of the PhoneNumber element.
        phoneType.Content = restriction
        phoneElement.SchemaType = phoneType

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

            ' If the qualified name of the element is "Customer", 
            ' get the complex type of the Customer element  
            ' and the sequence particle of the complex type.
            If element.QualifiedName.Name.Equals("Customer") Then

                Dim customerType As XmlSchemaComplexType = _
                    CType(element.ElementSchemaType, XmlSchemaComplexType)
                Dim sequence As XmlSchemaSequence = _
                    CType(customerType.Particle, XmlSchemaSequence)

                ' Add the new PhoneNumber element to the sequence.
                sequence.Items.Add(phoneElement)
            End If
        Next

        ' Reprocess and compile the modified XmlSchema object and write it to the console.
        schemaSet.Reprocess(customerSchema)
        schemaSet.Compile()
        customerSchema.Write(Console.Out)
    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şağıda, XML Şemaları Oluşturma konusunda oluşturulan değiştirilmiş müşteri şeması yer almaktadır.

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:tns="http://www.tempuri.org" targetNamespace="http://www.tempuri.org" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="FirstName" type="xs:string" />
        <xs:element name="LastName" type="tns:LastNameType" />
        <xs:element name="PhoneNumber">           <xs:simpleType>             <xs:restriction base="xs:string">               <xs:pattern value="\d{3}-\d{3}-\d(4)" />             </xs:restriction>           </xs:simpleType>         </xs:element>
      </xs:sequence>
      <xs:attribute name="CustomerId" type="xs:positiveInteger" use="required" />
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="LastNameType">
    <xs:restriction base="xs:string">
      <xs:maxLength value="20" />
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Başlık Özniteliği Örneği

Bu ikinci kod örneği, müşteri şemasının Title öğesine yeni FirstName bir öznitelik ekler. İlk kod örneğinde, FirstName öğesinin türü xs:string'dir. öğesinin FirstName dize içeriğiyle birlikte bir özniteliği olması için, türünün basit içerik uzantısı içerik modeliyle karmaşık bir türe değiştirilmesi gerekir.

Kod örneği, aşağıdaki adımlarda müşteri şemasını düzenler.

  1. Müşteri şemasını, yeni bir XmlSchemaSet nesnesine ekler ve ardından derler. Şemayı okurken veya derlerken karşılaşılan tüm şema doğrulama uyarıları ve hataları temsilci tarafından ValidationEventHandler işlenir.

  2. XmlSchema öğesinden XmlSchemaSet özelliğini yineleyerek derlenmiş Schemas() nesnesini alır. Şema derlendiği için, Şema SonrasıCompilation-Infoset (PSCI) özelliklerine ulaşılabilir.

  3. FirstName öğesi için XmlSchemaComplexType sınıfını kullanarak yeni bir karmaşık tür oluşturur.

  4. xs:string temel türüne sahip yeni bir basit içerik uzantısı, XmlSchemaSimpleContent ve XmlSchemaSimpleContentExtension sınıflarını kullanarak oluşturur.

  5. Title sınıfını, XmlSchemaAttribute içeren bir SchemaTypeName ile kullanarak yeni xs:string özniteliğini oluşturur ve özniteliği basit içerik genişletmesine ekler.

  6. Basit içeriğin içerik modelini basit içerik uzantısına, karmaşık türün içerik modelini ise basit içeriğe ayarlar.

  7. Yeni karmaşık türü şema öncesi derleme XmlSchema.Items koleksiyonuna ekler.

  8. Şema öncesi derleme XmlSchemaObject koleksiyonundaki her bir XmlSchema.Items üzerinde yinelenir.

Uyarı

FirstName öğesi şemada genel bir öğe olmadığı için, XmlSchema.Items ve XmlSchema.Elements koleksiyonlarında kullanılabilir durumda değildir. Kod örneği, önce FirstName öğesini bularak Customer öğesini bulur.

İlk kod örneği, şema sonrası derleme XmlSchema.Elements koleksiyonunu kullanarak şemada geçiş yaptı. Bu örnekte, şemayı çapraz geçiş yapmak için şema öncesi derleme XmlSchema.Items koleksiyonu kullanılır. Her iki koleksiyon da şemadaki genel öğelere erişim sağlasa da, şemadaki tüm genel öğeleri yinelemeniz gerektiğinden Items ve herhangi bir PSCI özelliği olmadığından koleksiyonda yineleme yapmak daha fazla zaman alır. PSCI koleksiyonları (XmlSchema.Elements, XmlSchema.Attributes, XmlSchema.SchemaTypesvb.), genel öğelerine, özniteliklerine, türlerine ve PSCI özelliklerine doğrudan erişim sağlar.

  1. Eğer XmlSchemaObject bir öğe ise, QualifiedName sınıfını kullanarak "Customer" öğesinin karmaşık türünü alır ve Customer sınıfını kullanarak karmaşık türün sıra parçacığını elde eder.

  2. Şema öncesi derleme XmlSchemaParticle koleksiyonundaki her bir XmlSchemaSequence.Items üzerinde yinelenir.

  3. Eğer XmlSchemaParticle bir öğeyse ve QualifiedName"FirstName" ise, SchemaTypeName öğesinin FirstName’sini yeni FirstName karmaşık türü olarak ayarlayın.

  4. Son olarak, XmlSchema sınıfının Reprocess ve Compile yöntemlerini kullanarak değiştirilen XmlSchemaSet nesnesini yeniden işler ve derler ve konsola yazar.

Aşağıda tam kod örneği verilmiştir.

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

class XmlSchemaEditExample
{
    static void Main(string[] args)
    {
        // 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;
        }

        // Create a complex type for the FirstName element.
        XmlSchemaComplexType complexType = new XmlSchemaComplexType();
        complexType.Name = "FirstNameComplexType";

        // Create a simple content extension with a base type of xs:string.
        XmlSchemaSimpleContent simpleContent = new XmlSchemaSimpleContent();
        XmlSchemaSimpleContentExtension simpleContentExtension =
            new XmlSchemaSimpleContentExtension();
        simpleContentExtension.BaseTypeName =
            new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // Create the new Title attribute with a SchemaTypeName of xs:string
        // and add it to the simple content extension.
        XmlSchemaAttribute attribute = new XmlSchemaAttribute();
        attribute.Name = "Title";
        attribute.SchemaTypeName =
            new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");
        simpleContentExtension.Attributes.Add(attribute);

        // Set the content model of the simple content to the simple content extension
        // and the content model of the complex type to the simple content.
        simpleContent.Content = simpleContentExtension;
        complexType.ContentModel = simpleContent;

        // Add the new complex type to the pre-schema-compilation Items collection.
        customerSchema.Items.Add(complexType);

        // Iterate over each XmlSchemaObject in the pre-schema-compilation
        // Items collection.
        foreach (XmlSchemaObject schemaObject in customerSchema.Items)
        {
            // If the XmlSchemaObject is an element, whose QualifiedName
            // is "Customer", get the complex type of the Customer element
            // and the sequence particle of the complex type.
            if (schemaObject is XmlSchemaElement)
            {
                XmlSchemaElement element = schemaObject as XmlSchemaElement;

                if (element.QualifiedName.Name.Equals("Customer"))
                {
                    XmlSchemaComplexType customerType =
                        element.ElementSchemaType as XmlSchemaComplexType;

                    XmlSchemaSequence sequence =
                        customerType.Particle as XmlSchemaSequence;

                    // Iterate over each XmlSchemaParticle in the pre-schema-compilation
                    // Items property.
                    foreach (XmlSchemaParticle particle in sequence.Items)
                    {
                        // If the XmlSchemaParticle is an element, who's QualifiedName
                        // is "FirstName", set the SchemaTypeName of the FirstName element
                        // to the new FirstName complex type.
                        if (particle is XmlSchemaElement)
                        {
                            XmlSchemaElement childElement =
                                particle as XmlSchemaElement;

                            if (childElement.Name.Equals("FirstName"))
                            {
                                childElement.SchemaTypeName =
                                    new XmlQualifiedName("FirstNameComplexType",
                                    "http://www.tempuri.org");
                            }
                        }
                    }
                }
            }
        }

        // Reprocess and compile the modified XmlSchema object and write it to the console.
        schemaSet.Reprocess(customerSchema);
        schemaSet.Compile();
        customerSchema.Write(Console.Out);
    }

    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.Xml
Imports System.Xml.Schema

Class XmlSchemaEditExample

    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

        ' Create a complex type for the FirstName element.
        Dim complexType As XmlSchemaComplexType = New XmlSchemaComplexType()
        complexType.Name = "FirstNameComplexType"

        ' Create a simple content extension with a base type of xs:string.
        Dim simpleContent As XmlSchemaSimpleContent = New XmlSchemaSimpleContent()
        Dim simpleContentExtension As XmlSchemaSimpleContentExtension = _
            New XmlSchemaSimpleContentExtension()
        simpleContentExtension.BaseTypeName = _
            New XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema")

        ' Create the new Title attribute with a SchemaTypeName of xs:string
        ' and add it to the simple content extension.
        Dim attribute As XmlSchemaAttribute = New XmlSchemaAttribute()
        attribute.Name = "Title"
        attribute.SchemaTypeName = _
            New XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema")
        simpleContentExtension.Attributes.Add(attribute)

        ' Set the content model of the simple content to the simple content extension
        ' and the content model of the complex type to the simple content.
        simpleContent.Content = simpleContentExtension
        complexType.ContentModel = simpleContent

        ' Add the new complex type to the pre-schema-compilation Items collection.
        customerSchema.Items.Add(complexType)

        ' Iterate over each XmlSchemaObject in the pre-schema-compilation
        ' Items collection.
        For Each schemaObject As XmlSchemaObject In customerSchema.Items

            ' If the XmlSchemaObject is an element, whose QualifiedName
            ' is "Customer", get the complex type of the Customer element
            ' and the sequence particle of the complex type.
            If schemaObject.GetType() Is GetType(XmlSchemaElement) Then

                Dim element As XmlSchemaElement = CType(schemaObject, XmlSchemaElement)

                If (element.QualifiedName.Name.Equals("Customer")) Then
                    Dim customerType As XmlSchemaComplexType = _
                        CType(element.ElementSchemaType, XmlSchemaComplexType)

                    Dim sequence As XmlSchemaSequence = _
                       CType(customerType.Particle, XmlSchemaSequence)

                    ' Iterate over each XmlSchemaParticle in the pre-schema-compilation
                    ' Items property.
                    For Each particle As XmlSchemaParticle In sequence.Items

                        ' If the XmlSchemaParticle is an element, who's QualifiedName
                        ' is "FirstName", set the SchemaTypeName of the FirstName element
                        ' to the new FirstName complex type.
                        If particle.GetType() Is GetType(XmlSchemaElement) Then
                            Dim childElement As XmlSchemaElement = _
                                CType(particle, XmlSchemaElement)

                            If childElement.Name.Equals("FirstName") Then
                                childElement.SchemaTypeName = _
                                   New XmlQualifiedName("FirstNameComplexType", _
                                  "http://www.tempuri.org")
                            End If
                        End If
                    Next
                End If
            End If
        Next

        ' Reprocess and compile the modified XmlSchema object and write it to the console.
        schemaSet.Reprocess(customerSchema)
        schemaSet.Compile()
        customerSchema.Write(Console.Out)
    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şağıda, XML Şemaları Oluşturma konusunda oluşturulan değiştirilmiş müşteri şeması yer almaktadır.

<?xml version="1.0" encoding=" utf-8"?>
<xs:schema xmlns:tns="http://www.tempuri.org" targetNamespace="http://www.tempuri.org" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Customer">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="FirstName" type="tns:FirstNameComplexType" />
        <xs:element name="LastName" type="tns:LastNameType" />
      </xs:sequence>
      <xs:attribute name="CustomerId" type="xs:positiveInteger" use="required" />
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="LastNameType">
    <xs:restriction base="xs:string">
      <xs:maxLength value="20" />
    </xs:restriction>
  </xs:simpleType>
  <xs:complexType name="FirstNameComplexType">     <xs:simpleContent>       <xs:extension base="xs:string">         <xs:attribute name="Title" type="xs:string" />       </xs:extension>     </xs:simpleContent>   </xs:complexType>
</xs:schema>

Ayrıca bakınız