package org.teiid.query.xquery.saxon;

import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import net.sf.saxon.Configuration;
import net.sf.saxon.om.DocumentInfo;
import net.sf.saxon.om.NamePool;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.type.Type;
import nu.xom.Attribute;
import nu.xom.Document;
import nu.xom.Element;
import nu.xom.Node;

/**
 * The root node of an XPath tree. (Or equivalently, the tree itself).
 * <P>
 * This class is used not only for a document, but also for the root
 * of a document-less tree fragment.
 * 
 * @author Michael H. Kay
 * @author Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM)
 * @author Steve Hawkins (Ported to Saxon 9.1 for Teiid)
 */

public class DocumentWrapper extends NodeWrapper implements DocumentInfo {

	protected Configuration config;

	protected String baseURI;

	protected long documentNumber;

    private HashMap idIndex;

	private Map<String, Object> userData = new HashMap<String, Object>();

	/**
	 * Create a Saxon wrapper for a XOM root node
	 * 
	 * @param root
	 *            The XOM root node
	 * @param baseURI
	 *            The base URI for all the nodes in the tree
	 * @param config
	 *            The configuration which defines the name pool used for all
	 *            names in this tree
	 */
	public DocumentWrapper(Node root, String baseURI, Configuration config) {
		super(root, null, 0);
		if (root.getParent() != null) 
			throw new IllegalArgumentException("root node must not have a parent node");
		this.baseURI = baseURI;
		this.docWrapper = this;
		setConfiguration(config);
	}
	
	/**
	 * Wrap a node in the XOM document.
	 * 
	 * @param node
	 *            The node to be wrapped. This must be a node in the same
	 *            document (the system does not check for this).
	 * @return the wrapping NodeInfo object
	 */

	public NodeInfo wrap(Node node) {
		if (node == this.node) {
            return this;
        }
		return makeWrapper(node, this);
	}

	/**
	 * Set the configuration, which defines the name pool used for all names in
	 * this document. This is always called after a new document has been
	 * created. The implementation must register the name pool with the
	 * document, so that it can be retrieved using getNamePool(). It must also
	 * call NamePool.allocateDocumentNumber(), and return the relevant document
	 * number when getDocumentNumber() is subsequently called.
	 * 
	 * @param config
	 *            The configuration to be used
	 */

	public void setConfiguration(Configuration config) {
		this.config = config;
		this.documentNumber = config.getDocumentNumberAllocator().allocateDocumentNumber();
	}
	
    /**
	 * Get the configuration previously set using setConfiguration
	 */

	public Configuration getConfiguration() {
		return config;
	}

	/**
	 * Get the name pool used for the names in this document
	 * 
	 * @return the name pool in which all the names used in this document are
	 *         registered
	 */

	public NamePool getNamePool() {
		return config.getNamePool();
	}

	/**
	 * Get the unique document number for this document (the number is unique
	 * for all documents within a NamePool)
	 * 
	 * @return the unique number identifying this document within the name pool
	 */

	public long getDocumentNumber() {
		return documentNumber;
	}

    /**
	 * Get the element with a given ID, if any
	 * 
	 * @param id
	 *            the required ID value
	 * @param getParent
	 *            true if running the element-with-id() function rather than the id()
	 *            function; the difference is that in the case of an element of type xs:ID,
	 *            the parent of the element should be returned, not the element itself.
	 * @return the element with the given ID, or null if there is no such ID
	 *         present (or if the parser has not notified attributes as being of
	 *         type ID).
	 */

	public NodeInfo selectID(String id, boolean getParent) {
		if (idIndex == null) {
			Element elem;
			switch (nodeKind) {
				case Type.DOCUMENT : 
					elem = ((Document) node).getRootElement();
					break;
				case Type.ELEMENT : 
					elem = (Element) node;
					break;
				default: 
					return null;
			}
			idIndex = new HashMap(50);
			buildIDIndex(elem);
		}

		NodeInfo result = (NodeInfo) idIndex.get(id);

		if (result != null && getParent && result.isId() && result.getStringValue().equals(id)) {
            result = result.getParent();
        }

		return result ;
	}
	
	
	private void buildIDIndex(Element elem) {
		// walk the tree in reverse document order, to satisfy the XPath 1.0 rule
		// that says if an ID appears twice, the first one wins
		for (int i=elem.getChildCount(); --i >= 0 ; ) {
			Node child = elem.getChild(i);
			if (child instanceof Element) {
				buildIDIndex((Element)child);
			}
		}
		for (int i=elem.getAttributeCount(); --i >= 0 ; ) {
			Attribute att = elem.getAttribute(i);
			if (att.getType() == Attribute.Type.ID) {
				idIndex.put(att.getValue(), wrap(elem));
			}
		}
	}

    /**
	 * Get the unparsed entity with a given name
	 * 
	 * @param name
	 *            the name of the entity
	 * @return null: XOM does not provide access to unparsed entities
	 * @return if the entity exists, return an array of two Strings, the first
	 *         holding the system ID of the entity, the second holding the
	 *         public ID if there is one, or null if not. If the entity does not
	 *         exist, return null.
	 */

	public String[] getUnparsedEntity(String name) {
		return null;
	}

	@Override
	public Iterator getUnparsedEntityNames() {
		return Collections.EMPTY_LIST.iterator();
	}

	@Override
	public int getColumnNumber() {
		return -1;
	}

	@Override
	public boolean isId() {
		return false;
	}

	@Override
	public boolean isIdref() {
		return false;
	}

	@Override
	public boolean isNilled() {
		return false;
	}
	
	@Override
	public Object getUserData(String arg0) {
		return this.userData.get(arg0);
	}
	
	@Override
	public void setUserData(String arg0, Object arg1) {
		this.userData.put(arg0, arg1);
	}
	
	@Override
	public boolean isTyped() {
		return false;
	}

}

//
// The contents of this file are subject to the Mozilla Public License Version
// 1.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.mozilla.org/MPL/
//
// Software distributed under the License is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the License for the specific language governing rights and limitations
// under the License.
//
// The Original Code is: all this file.
//
// The Initial Developer of the Original Code is Michael Kay
//
// Portions created by (your name) are Copyright (C) (your legal entity). All
// Rights Reserved.
//
// Contributor(s): none.
//
