/*
    * Copyright 2002 - 2007 JEuclid, http://jeuclid.sf.net
    * 
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  /* $Id: Semantics.java,v bc1d5fde7b73 2009/06/01 14:40:54 maxberger $ */
  
  package net.sourceforge.jeuclid.elements.content.semantic;
  
  import net.sourceforge.jeuclid.elements.presentation.AbstractContainer;
  
  import org.apache.batik.dom.AbstractDocument;
  import org.w3c.dom.Node;
  import org.w3c.dom.mathml.MathMLElement;
  import org.w3c.dom.mathml.MathMLSemanticsElement;
  
  /**
   * This class represents a semantics element.
   * 
   * @version $Revision: bc1d5fde7b73 $
   */
  public final class Semantics extends AbstractContainer implements
          MathMLSemanticsElement {
  
      /**
       * The XML element from this class.
       */
      public static final String ELEMENT = "semantics";
  
      private static final long serialVersionUID = 1L;
  
      /**
       * Default constructor. Sets MathML Namespace.
       * 
       * @param qname
       *            Qualified name.
       * @param odoc
       *            Owner Document.
       */
      public Semantics(final String qname, final AbstractDocument odoc) {
          super(qname, odoc);
      }
  
      /** {@inheritDoc} */
      @Override
      protected Node newNode() {
          return new Semantics(this.nodeName, this.ownerDocument);
      }
  
      /** {@inheritDoc} */
      public void deleteAnnotation(final int index) {
          this.removeAnnotation(index);
      }
  
      /** {@inheritDoc} */
      public MathMLElement getAnnotation(final int index) {
          // Index is 1-based!
          return (MathMLElement) this.getChildNodes().item(index);
      }
  
      /** {@inheritDoc} */
      public MathMLElement getBody() {
          return (MathMLElement) this.getFirstChild();
      }
  
      /** {@inheritDoc} */
      public int getNAnnotations() {
          return Math.max(0, this.getChildNodes().getLength() - 1);
      }
  
      /** {@inheritDoc} */
      public MathMLElement insertAnnotation(final MathMLElement newAnnotation,
              final int index) {
          if (index == 0) {
              if (this.getNAnnotations() == 0) {
                  this.setAnnotation(newAnnotation, 1);
              } else {
                  this.addMathElement(newAnnotation);
              }
          } else {
              final MathMLElement oldChild = this.getAnnotation(index);
              if (oldChild == null) {
                  this.setAnnotation(newAnnotation, index);
              } else {
                  this.insertBefore(newAnnotation, oldChild);
              }
          }
          return newAnnotation;
     }
 
     /** {@inheritDoc} */
     public MathMLElement removeAnnotation(final int index) {
         final MathMLElement oldChild = this.getAnnotation(index);
         return (MathMLElement) this.removeChild(oldChild);
     }
 
     /** {@inheritDoc} */
     public MathMLElement setAnnotation(final MathMLElement newAnnotation,
             final int index) {
         // Index is 1-based!
         this.setMathElement(index, newAnnotation);
         return newAnnotation;
     }
 
     /** {@inheritDoc} */
     public void setBody(final MathMLElement body) {
         this.setMathElement(0, body);
     }
 
 }