/*-- 

 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.Collections;
import java.util.Iterator;

// JDOM imports
import org.jdom.Element;

/**
 * A <code>JDOMNode</code> Strategy for <code>String</code>
 *   content.
 * 
 * <p>This will have to be updated when the <code>String</code>
 *   content is replaced with a real <code>org.jdom.Text</code>
 *   node.</p>
 * 
 * <p>At this time, <code>{@link #getParentNode()}</code> fails unless 
 *   you call <code>{@link #setParentNode()}</code> separately after 
 *   constructing the instance.</p>
 * 
 */
public class TextNode implements JDOMNode {
	
    /** The decorated String */
    protected String decorated;
	
    /** The manually set parent of this string content */
    private Element parent = null;
	
    /**
     * <p>Constructor for the decorated attribute.</p>
     * 
     * @param string <code>String</code> to decorate
     */
    public TextNode(String string) {
        decorated = string;
    }
	
    /**
     * <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() {
        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 (parent == null) {
            throw new RuntimeException(
                "The parent of this String content has not been set!");
        }	
        return new ElementNode(parent);
    }
	
    /**
     * <p>This returns the qualified name of this Node.</p>
     * 
     * @return <code>String</code> - this node's qualified name
     */
    public String getQName() {
        // text nodes have no name
        return "";
    }
	
    /**
     * <p>This always returns an empty <code>Iterator</code>.</p>
     * 
     * @return <code>Iterator</code> - always empty
     */
    public Iterator iterator() {
        return Collections.EMPTY_LIST.iterator();
    }

    /**
     * <p> This is a special case function, because a 
     *   <code>String</code> can't have a parent.
     * 
     * @return TextNode
     * @param parent org.jdom.Element
     */
    public TextNode setParent(Element parent) {
        this.parent = parent;
        return this;
    }

    /**
     * <p>This is the actual textual content of the node.</p>
     *
     * @return <code>String</code> - node's content.
     */
    public String toString() {
        return decorated;
    }
}