/*
    * Redistribution and use of this software and associated documentation ("Software"), with or
    * without modification, are permitted provided that the following conditions are met:
    *
    * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
    * must also contain a copy of this document.
    *
    * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
    * conditions and the following disclaimer in the documentation and/or other materials provided with
   * the distribution.
   *
   * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
   * without prior written permission of Intalio, Inc. For written permission, please contact
   * info@exolab.org.
   *
   * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
   * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
   * Intalio, Inc.
   *
   * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
   *
   * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
   * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   *
   * Copyright 2001-2004 (C) Intalio, Inc. All Rights Reserved.
   *
   * $Id$ Date Author Changes 04/06/2001 Arnaud Blandin Created 09/09/2004 Keith Visco Modified for
   * SAX 2 support
   */
  package org.exolab.castor.xml.util;
  
  import java.util.HashSet;
  import java.util.Set;
  
  import org.exolab.castor.types.AnyNode;
  import org.exolab.castor.xml.Namespaces;
  import org.exolab.castor.xml.NamespacesStack;
  import org.xml.sax.ContentHandler;
  import org.xml.sax.SAXException;
  import org.xml.sax.helpers.AttributesImpl;
  
  /**
   * A class for converting an AnyNode to SAX events.
   *
   * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
   * @author <a href="mailto:blandin@intalio.com">Arnaud Blandin</a>
   *
   * @version $Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
   */
  public class AnyNode2SAX2 {
  
    /** The AnyNode we are firing events for. */
    private AnyNode _node;
    /** The Content Handler. */
    private ContentHandler _handler;
    /** The stack to store the elements. */
    private Set<AnyNode> _elements;
    /** The namespace stack. */
    private NamespacesStack namespacesStack;
  
    /**
     * No-arg constructor.
     */
    public AnyNode2SAX2() {
      this(null, null);
    }
  
    /**
     * Creates a AnyNode2SAX for the given node.
     * 
     * @param node the AnyNode to create AnyNode2SAX2 for.
     */
    public AnyNode2SAX2(final AnyNode node) {
      this(node, null);
    }
  
    /**
     * Creates a AnyNode2SAX2 for the given node and the namespace context.
     * 
     * @param node the AnyNode to create AnyNode2SAX for.
     * @param namespacesStack a namespace context
     */
    public AnyNode2SAX2(final AnyNode node, final NamespacesStack namespacesStack) {
      _elements = new HashSet<AnyNode>();
      _node = node;
      this.namespacesStack = namespacesStack != null ? namespacesStack : new NamespacesStack();
    }
  
    /**
     * Set the ContentHandler to send events to.
     *
     * @param handler the document handler to set
     */
   public void setContentHandler(final ContentHandler handler) {
     if (handler == null) {
       throw new IllegalArgumentException("AnyNode2SAX2#setContentHandler 'null' value for handler");
     }
     _handler = handler;
   }
 
   public static void fireEvents(final AnyNode node, final ContentHandler handler)
       throws SAXException {
     fireEvents(node, handler, null);
   }
 
   public static void fireEvents(final AnyNode node, final ContentHandler handler,
       final NamespacesStack namespacesStack) throws SAXException {
     AnyNode2SAX2 eventProducer = new AnyNode2SAX2(node, namespacesStack);
     eventProducer.setContentHandler(handler);
 
     // inject a namespace declaration for the AnyNode element
     if (node != null && namespacesStack != null && node.getNamespacePrefix() != null
         && namespacesStack.getNamespaceURI(node.getNamespacePrefix()) == null) {
       handler.startPrefixMapping(node.getNamespacePrefix(), node.getNamespaceURI());
     }
 
     eventProducer.start();
   }
 
   public void start() throws org.xml.sax.SAXException {
     if (_node == null || _handler == null) {
       return;
     }
     processAnyNode(_node, _handler);
   }
 
   private void processAnyNode(final AnyNode node, final ContentHandler handler)
       throws SAXException {
     if (_node == null || _handler == null) {
       throw new IllegalArgumentException();
     }
 
     // -- so we don't potentially get into an endlessloop
     if (!_elements.add(node)) {
       return;
     }
 
     if (node.getNodeType() == AnyNode.ELEMENT) {
       // -- node local name
       String name = node.getLocalName();
 
       // -- retrieve the namespaces declaration and handle them
       AnyNode tempNode = node.getFirstNamespace();
       String prefix = null;
       while (tempNode != null) {
         prefix = tempNode.getNamespacePrefix();
         if (prefix == null) {
           prefix = "";
         }
         String value = tempNode.getNamespaceURI();
         if (value == null) {
           value = "";
         }
         handler.startPrefixMapping(prefix, value);
         if (value != null && value.length() > 0) {
           namespacesStack.addNamespace(prefix, value);
         }
         tempNode = tempNode.getNextSibling();
       } // namespaceNode
 
       // -- retrieve the attributes and handle them
       AttributesImpl atts = new AttributesImpl();
       tempNode = node.getFirstAttribute();
       String xmlName = null;
       String value = null;
       String attUri = null;
       String attPrefix = null;
       while (tempNode != null) {
         xmlName = tempNode.getLocalName();
         String localName = xmlName;
         // --retrieve a prefix?
         attUri = tempNode.getNamespaceURI();
         if (attUri != null) {
           attPrefix = namespacesStack.getNamespacePrefix(attUri);
         } else {
           attUri = "";
         }
 
         if (attPrefix != null && attPrefix.length() > 0) {
           xmlName = attPrefix + ':' + xmlName;
         }
 
         value = tempNode.getStringValue();
         atts.addAttribute(attUri, localName, xmlName, "CDATA", value);
         tempNode = tempNode.getNextSibling();
       } // attributes
 
       // -- namespace management
       // _context = _context.createNamespaces();
       String nsPrefix = node.getNamespacePrefix();
       String nsURI = node.getNamespaceURI();
 
       String qName = null;
       // maybe the namespace is already bound to a prefix in the
       // namespace context
       if (nsURI != null && nsURI.length() > 0) {
         String tempPrefix = namespacesStack.getNamespacePrefix(nsURI);
         if (tempPrefix != null) {
           nsPrefix = tempPrefix;
         } else {
           namespacesStack.addNamespace(nsPrefix, nsURI);
         }
       } else {
         nsURI = "";
       }
 
       if (nsPrefix != null) {
         int len = nsPrefix.length();
         if (len > 0) {
           qName = nsPrefix + ':' + name;
         } else {
           qName = name;
         }
       } else {
         qName = name;
       }
 
       try {
         // _context.declareAsAttributes(atts,true);
         handler.startElement(nsURI, name, qName, atts);
       } catch (SAXException sx) {
         throw new SAXException(sx);
       }
 
       // -- handle child&daughter elements
       tempNode = node.getFirstChild();
       while (tempNode != null) {
         namespacesStack.addNewNamespaceScope();
         processAnyNode(tempNode, handler);
         tempNode = tempNode.getNextSibling();
       }
 
       // -- finish element
       try {
         handler.endElement(nsURI, name, qName);
         namespacesStack.removeNamespaceScope();
 
         // -- retrieve the namespaces declaration and handle them
         tempNode = node.getFirstNamespace();
         while (tempNode != null) {
           prefix = tempNode.getNamespacePrefix();
           if (prefix == null) {
             prefix = "";
           }
           handler.endPrefixMapping(prefix);
           tempNode = tempNode.getNextSibling();
         } // namespaceNode
       } catch (org.xml.sax.SAXException sx) {
         throw new SAXException(sx);
       }
     } else {
       // ELEMENTS
       if (node.getNodeType() == AnyNode.TEXT) {
         String value = node.getStringValue();
         if ((value != null) && (value.length() > 0)) {
           char[] chars = value.toCharArray();
           try {
             handler.characters(chars, 0, chars.length);
           } catch (org.xml.sax.SAXException sx) {
             throw new SAXException(sx);
           }
         }
       }
     }
   }
 
 }