XmlSchemaGroup.cs :  » 2.6.4-mono-.net-core » System.Xml » System » Xml » Schema » C# / CSharp Open Source

//
// System.Xml.Schema.XmlSchemaGroup.cs
//
// Author:
//  Dwivedi, Ajay kumar  Adwiv@Yahoo.com
//  Atsushi Enomoto  ginga@kit.hi-ho.ne.jp
//

//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections;
using System.Xml.Serialization;
using System.Xml;

namespace System.Xml.Schema{
  /// <summary>
  /// refers to the named group
  /// </summary>
  public class XmlSchemaGroup : XmlSchemaAnnotated
  {
    private string name;
    private XmlSchemaGroupBase particle;
    private XmlQualifiedName qualifiedName;
    private bool isCircularDefinition;
    
    const string xmlname = "group";

    public XmlSchemaGroup()
    {
      qualifiedName = XmlQualifiedName.Empty;
    }

    [System.Xml.Serialization.XmlAttribute("name")]
    public string Name 
    {
      get{ return  name; } 
      set{ name = value; }
    }

    [XmlElement("all",typeof(XmlSchemaAll))]
    [XmlElement("choice",typeof(XmlSchemaChoice))]
    [XmlElement("sequence",typeof(XmlSchemaSequence))]
    public XmlSchemaGroupBase Particle
    {
      get{ return  particle; }
      set{ particle = value; }
    }

    [XmlIgnore]
#if NET_2_0
    public XmlQualifiedName QualifiedName 
#else
    internal XmlQualifiedName QualifiedName 
#endif
    {
      get{ return qualifiedName;}
    }

    internal bool IsCircularDefinition
    {
      get { return isCircularDefinition; }
    }

    internal override void SetParent (XmlSchemaObject parent)
    {
      base.SetParent (parent);
      if (Particle != null)
        Particle.SetParent (this);
    }

    // 1. name must be present
    // 2. MinOccurs & MaxOccurs of the Particle must be absent
    internal override int Compile(ValidationEventHandler h, XmlSchema schema)
    {
      // If this is already compiled this time, simply skip.
      if (CompilationId == schema.CompilationId)
        return 0;

      if(Name == null)
        error(h,"Required attribute name must be present");
      else if(!XmlSchemaUtil.CheckNCName(this.name)) 
        error(h,"attribute name must be NCName");
      else
        qualifiedName = new XmlQualifiedName(Name, AncestorSchema.TargetNamespace);

      if(Particle == null)
      {
        error(h,"Particle is required");
      }
      else 
      {
        if(Particle.MaxOccursString != null)
          Particle.error(h,"MaxOccurs must not be present when the Particle is a child of Group");
        if(Particle.MinOccursString != null)
          Particle.error(h,"MinOccurs must not be present when the Particle is a child of Group");
      
        Particle.Compile (h, schema);
      }
      
      XmlSchemaUtil.CompileID(Id,this,schema.IDCollection,h);

      this.CompilationId = schema.CompilationId;
      return errorCount;
    }
    
    internal override int Validate(ValidationEventHandler h, XmlSchema schema)
    {
      if (this.IsValidated (schema.ValidationId))
        return errorCount;

      // 3.8.6 Model Group Correct :: 2. Circular group disallowed.
      if (Particle != null) {  // in case of invalid schema.
        Particle.parentIsGroupDefinition = true;

        try {
          Particle.CheckRecursion (0, h, schema);
        } catch (XmlSchemaException ex) {
          error (h, ex.Message, ex);
          this.isCircularDefinition = true;
          return errorCount;
        }
        errorCount += Particle.Validate (h,schema);

        Particle.ValidateUniqueParticleAttribution (new XmlSchemaObjectTable (),
          new ArrayList (), h, schema);
        Particle.ValidateUniqueTypeAttribution (
          new XmlSchemaObjectTable (), h, schema);
      }

      this.ValidationId = schema.ValidationId;
      return errorCount;
    }

    //From the Errata
    //<group 
    //  id = ID
    //  name = NCName
    //  {any attributes with non-schema namespace . . .}>
    //  Content: (annotation?, (all | choice | sequence)?)
    //</group>
    internal static XmlSchemaGroup Read(XmlSchemaReader reader, ValidationEventHandler h)
    {
      XmlSchemaGroup group = new XmlSchemaGroup();
      reader.MoveToElement();

      if(reader.NamespaceURI != XmlSchema.Namespace || reader.LocalName != xmlname)
      {
        error(h,"Should not happen :1: XmlSchemaGroup.Read, name="+reader.Name,null);
        reader.Skip();
        return null;
      }

      group.LineNumber = reader.LineNumber;
      group.LinePosition = reader.LinePosition;
      group.SourceUri = reader.BaseURI;

      while(reader.MoveToNextAttribute())
      {
        if(reader.Name == "id")
        {
          group.Id = reader.Value;
        }
        else if(reader.Name == "name")
        {
          group.name = reader.Value;
        }
        else if((reader.NamespaceURI == "" && reader.Name != "xmlns") || reader.NamespaceURI == XmlSchema.Namespace)
        {
          error(h,reader.Name + " is not a valid attribute for group",null);
        }
        else
        {
          XmlSchemaUtil.ReadUnhandledAttribute(reader,group);
        }
      }
      
      reader.MoveToElement();
      if(reader.IsEmptyElement)
        return group;

//       Content: (annotation?, (all | choice | sequence)?)
      int level = 1;
      while(reader.ReadNextElement())
      {
        if(reader.NodeType == XmlNodeType.EndElement)
        {
          if(reader.LocalName != xmlname)
            error(h,"Should not happen :2: XmlSchemaGroup.Read, name="+reader.Name,null);
          break;
        }
        if(level <= 1 && reader.LocalName == "annotation")
        {
          level = 2; //Only one annotation
          XmlSchemaAnnotation annotation = XmlSchemaAnnotation.Read(reader,h);
          if(annotation != null)
            group.Annotation = annotation;
          continue;
        }
        if(level <= 2)
        {
          if(reader.LocalName == "all")
          {
            level = 3;
            XmlSchemaAll all = XmlSchemaAll.Read(reader,h);
            if(all != null)
              group.Particle = all;
            continue;
          }
          if(reader.LocalName == "choice")
          {
            level = 3;
            XmlSchemaChoice choice = XmlSchemaChoice.Read(reader,h);
            if(choice != null)
              group.Particle = choice;
            continue;
          }
          if(reader.LocalName == "sequence")
          {
            level = 3;
            XmlSchemaSequence sequence = XmlSchemaSequence.Read(reader,h);
            if(sequence != null)
              group.Particle = sequence;
            continue;
          }
        }
        reader.RaiseInvalidElementError();
      }
      return group;
    }
  }
}