/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001-2003 The Apache Software Foundation.  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 following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Axis" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * 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 APACHE SOFTWARE FOUNDATION 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.axis.encoding.ser;

import org.apache.axis.Constants;
import org.apache.axis.components.logger.LogFactory;
import org.apache.axis.encoding.SerializationContext;
import org.apache.axis.encoding.Serializer;
import org.apache.axis.utils.Messages;
import org.apache.axis.wsdl.fromJava.Types;
import org.apache.commons.logging.Log;
import org.w3c.dom.Element;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.AttributesImpl;

import javax.xml.namespace.QName;
import java.io.IOException;
import java.util.Iterator;
import java.util.Map;

/**
 * A <code>MapSerializer</code> is be used to serialize and
 * deserialize Maps using the <code>SOAP-ENC</code>
 * encoding style.<p>
 *
 * @author Glen Daniels (gdaniels@macromedia.com)
 *         Modified by @author Rich Scheuerle (scheu@us.ibm.com)
 */

public class MapSerializer implements Serializer
{
   private static Log log =
           LogFactory.getLog(MapSerializer.class.getName());

   // QNames we deal with
   private static final QName QNAME_KEY = new QName("", "key");
   private static final QName QNAME_ITEM = new QName("", "item");
   private static final QName QNAME_VALUE = new QName("", "value");

   /**
    * Serialize a Map
    * <p/>
    * Walk the collection of keys, serializing each key/value pair
    * inside an <item> element.
    *
    * @param name       the desired QName for the element
    * @param attributes the desired attributes for the element
    * @param value      the Object to serialize
    * @param context    the SerializationContext in which to do all this
    * @throws IOException
    */
   public void serialize(QName name, Attributes attributes,
                         Object value, SerializationContext context)
           throws IOException
   {
      if (!(value instanceof Map))
         throw new IOException(Messages.getMessage("noMap00", "MapSerializer", value.getClass().getName()));

      Map map = (Map)value;

      context.startElement(name, attributes);

      AttributesImpl itemsAttributes = new AttributesImpl();
      String encodingURI = context.getMessageContext().getSOAPConstants().getEncodingURI();
      String encodingPrefix = context.getPrefixForURI(encodingURI);
      String soapPrefix = context.getPrefixForURI(Constants.SOAP_MAP.getNamespaceURI());
      itemsAttributes.addAttribute(encodingURI, "type", encodingPrefix + ":type",
              "CDATA", encodingPrefix + ":Array");
      itemsAttributes.addAttribute(encodingURI, "arrayType", encodingPrefix + ":arrayType",
              "CDATA", soapPrefix + ":item[" + map.size() + "]");

      for (Iterator i = map.entrySet().iterator(); i.hasNext();)
      {
         Map.Entry entry = (Map.Entry)i.next();
         Object key = entry.getKey();
         Object val = entry.getValue();

         context.startElement(QNAME_ITEM, null);

         context.serialize(QNAME_KEY, null, key);
         context.serialize(QNAME_VALUE, null, val);

         context.endElement();
      }

      context.endElement();
   }

   public String getMechanismType()
   {
      return Constants.AXIS_SAX;
   }

   /**
    * Return XML schema for the specified type, suitable for insertion into
    * the &lt;types&gt; element of a WSDL document, or underneath an
    * &lt;element&gt; or &lt;attribute&gt; declaration.
    *
    * @param javaType the Java Class we're writing out schema for
    * @param types    the Java2WSDL Types object which holds the context
    *                 for the WSDL being generated.
    * @return a type element containing a schema simpleType/complexType
    * @see org.apache.axis.wsdl.fromJava.Types
    */
   public Element writeSchema(Class javaType, Types types) throws Exception
   {
      Element complexType = types.createElement("complexType");
      complexType.setAttribute("name", "Map");
      Element seq = types.createElement("sequence");
      complexType.appendChild(seq);
      Element element = types.createElement("element");
      element.setAttribute("name", "item");
      element.setAttribute("minOccurs", "0");
      element.setAttribute("maxOccurs", "unbounded");
      element.setAttribute("type", types.getQNameString(new QName(Constants.NS_URI_XMLSOAP, "mapItem")));
      seq.appendChild(element);

      Element itemType = types.createElement("complexType");
      itemType.setAttribute("name", "mapItem");
      Element seq2 = types.createElement("sequence");
      itemType.appendChild(seq2);
      Element element2 = types.createElement("element");
      element2.setAttribute("name", "key");
      element2.setAttribute("nillable", "true");
      element2.setAttribute("type", "xsd:string");
      seq2.appendChild(element2);
      Element element3 = types.createElement("element");
      element3.setAttribute("name", "value");
      element3.setAttribute("nillable", "true");
      element3.setAttribute("type", "xsd:string");
      seq2.appendChild(element3);
      types.writeSchemaElement(Constants.SOAP_MAP, itemType);

      return complexType;
   }
}
