/*
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 *
 * This software is open source.
 * See the bottom of this file for the licence.
 */

package org.dom4j.datatype;

import com.sun.msv.datatype.xsd.XSDatatype;

import java.util.HashMap;
import java.util.Map;

import org.dom4j.Attribute;
import org.dom4j.DocumentFactory;
import org.dom4j.Element;
import org.dom4j.QName;

/**
 * <p>
 * <code>DatatypeElementFactory</code> is a factory for a specific Element in
 * an XML Schema.
 * </p>
 * 
 * @author <a href="mailto:jstrachan@apache.org">James Strachan </a>
 * @author Yuxin Ruan
 * @version $Revision: 1.9 $
 */
public class DatatypeElementFactory extends DocumentFactory {
    private QName elementQName;

    /**
     * Cache of <code>XSDatatype</code> instances per Attribute
     * <code>QName</code>
     */
    private Map attributeXSDatatypes = new HashMap();

    /**
     * Cache of <code>XSDatatype</code> instances per child Element
     * <code>QName</code>
     */
    private Map childrenXSDatatypes = new HashMap();

    public DatatypeElementFactory(QName elementQName) {
        this.elementQName = elementQName;
    }

    /**
     * DOCUMENT ME!
     * 
     * @return the QName this element factory is associated with
     */
    public QName getQName() {
        return elementQName;
    }

    /**
     * DOCUMENT ME!
     * 
     * @param attributeQName
     *            DOCUMENT ME!
     * 
     * @return the <code>XSDatatype</code> associated with the given Attribute
     *         QName
     */
    public XSDatatype getAttributeXSDatatype(QName attributeQName) {
        return (XSDatatype) attributeXSDatatypes.get(attributeQName);
    }

    /**
     * Registers the given <code>XSDatatype</code> for the given
     * &lt;attribute&gt; QNames
     * 
     * @param attributeQName
     *            DOCUMENT ME!
     * @param type
     *            DOCUMENT ME!
     */
    public void setAttributeXSDatatype(QName attributeQName, XSDatatype type) {
        attributeXSDatatypes.put(attributeQName, type);
    }

    /**
     * DOCUMENT ME!
     * 
     * @param qname
     *            DOCUMENT ME!
     * 
     * @return the <code>XSDatatype</code> associated with the given child
     *         Element QName
     */
    public XSDatatype getChildElementXSDatatype(QName qname) {
        return (XSDatatype) childrenXSDatatypes.get(qname);
    }

    public void setChildElementXSDatatype(QName qname, XSDatatype dataType) {
        childrenXSDatatypes.put(qname, dataType);
    }

    // DocumentFactory methods
    // -------------------------------------------------------------------------
    public Element createElement(QName qname) {
        // the element may have its own element factory!
        // use factory from the qname for datatype
        XSDatatype dataType = getChildElementXSDatatype(qname);

        if (dataType != null) {
            return new DatatypeElement(qname, dataType);
        }

        DocumentFactory factory = qname.getDocumentFactory();

        if (factory instanceof DatatypeElementFactory) {
            DatatypeElementFactory dtFactory = (DatatypeElementFactory) factory;
            dataType = dtFactory.getChildElementXSDatatype(qname);

            if (dataType != null) {
                return new DatatypeElement(qname, dataType);
            }
        }

        return super.createElement(qname);
    }

    public Attribute createAttribute(Element owner, QName qname, String value) {
        XSDatatype dataType = getAttributeXSDatatype(qname);

        if (dataType == null) {
            return super.createAttribute(owner, qname, value);
        } else {
            return new DatatypeAttribute(qname, dataType, value);
        }
    }
}

/*
 * 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 "DOM4J" must not be used to endorse or promote products derived
 * from this Software without prior written permission of MetaStuff, Ltd. For
 * written permission, please contact dom4j-info@metastuff.com.
 * 
 * 4. Products derived from this Software may not be called "DOM4J" nor may
 * "DOM4J" appear in their names without prior written permission of MetaStuff,
 * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
 * 
 * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
 * 
 * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. 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 METASTUFF, LTD. 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-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 */
