/*-- 

 Copyright (C) 2001 Brett McLaughlin.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions, and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions, and the disclaimer that follows 
    these conditions in the documentation and/or other materials 
    provided with the distribution.

 3. The name "Java and XML" must not be used to endorse or promote products
    derived from this software without prior written permission.  For
    written permission, please contact brett@newInstance.com.
 
 In addition, we request (but do not require) that you include in the 
 end-user documentation provided with the redistribution and/or in the 
 software itself an acknowledgement equivalent to the following:
     "This product includes software developed for the
      'Java and XML' book, by Brett McLaughlin (O'Reilly & Associates)."

 THIS SOFTWARE IS PROVIDED ``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 THE JDOM AUTHORS OR THE PROJECT
 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.

 */
package javaxml2;

import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;

// JDOM imports
import org.jdom.Element;

/**
 * Node Decorator for an <code>Element</code>.
 *
 * <p>Implementing each basic type of JDOM nodes are Strategies
 *   for those types, this one for <code>org.jdom.Element</code>.
 *   Each class implementing <code>JDOMNode</code> will implement 
 *   the node in an appropriate way for the type of class it 
 *   decorates</p>.
 */
public class ElementNode implements JDOMNode {
	
    /** the decorated Element */
    protected Element decorated;
	
    /**
     * <p>Constructor for the decorated element.</p>
     * 
     * @param element <code>Element</code> to decorate
     */
    public ElementNode(Element element) {
        this.decorated = element;
    }
	
    /**
     * <p>This returns the decorated attribute.</p>
     *
     * @return <code>Object</code> - the decorated object.
     */
    public Object getNode() {
        return decorated;
    }

    /**
     * <p>This returns the name of the node.</p>
     * 
     * @return <code>String</code> - name of the node.
     */
    public String getNodeName() {
        if (decorated != null) {
            return decorated.getName();
        }
        return "";
    }

    /**
     * <p>This returns the parent of the node, as
     *  a <code>{@link JDOMNode}</code>.
     * 
     * @return <code>JDOMNode</code> - this node's parent.
     */
    public JDOMNode getParentNode() {
        if (decorated.getParent() != null) {
            return new ElementNode(decorated.getParent());
        }
        return null;
    }
	
    /**
     * <p>This returns the qualified name of this Node.</p>
     * 
     * @return <code>String</code> - this node's qualified name
     */
    public String getQName() {
        if (decorated.getNamespacePrefix().equals("")) { 
            return decorated.getName();
        } else {
            return new StringBuffer(decorated.getNamespacePrefix())
                           .append(":")
                           .append(decorated.getName()).toString();
        }
    }
	
    /**
     * <p>This returns an <code>Iterator</code> over this element's
     *   content.</p>
     * 
     * @return java.util.Iterator
     */
    public Iterator iterator() {
        List list = decorated.getAttributes();
        ArrayList content = new ArrayList(list);

        // put the element's content in the list in order
        Iterator i = decorated.getMixedContent().iterator();
        while (i.hasNext()) {
            content.add(i.next());
        }
        return content.iterator();
    }

    /**
     * <p>This is the base attribute's 
     *   <code>{@link Attribute#toString()}</code> call.</p>
     *
     * @return <code>String</code> - description of attribute.
     */
    public String toString() {
        return decorated.toString();
    }
}