aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.runtime.property;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: import java.util.HashMap;
aoqi@0: import java.util.LinkedHashMap;
aoqi@0: import java.util.Map;
aoqi@0: import java.util.TreeMap;
aoqi@0: import java.util.Collection;
aoqi@0: import java.util.Collections;
aoqi@0: import java.util.Arrays;
aoqi@0: import java.util.Set;
aoqi@0: 
aoqi@0: import javax.xml.stream.XMLStreamException;
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.api.AccessorException;
aoqi@0: import com.sun.xml.internal.bind.v2.ClassFactory;
aoqi@0: import com.sun.xml.internal.bind.v2.util.QNameMap;
aoqi@0: import com.sun.xml.internal.bind.v2.model.core.PropertyKind;
aoqi@0: import com.sun.xml.internal.bind.v2.model.runtime.RuntimeMapPropertyInfo;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.JaxBeanInfo;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.Name;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.XMLSerializer;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.ChildLoader;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.TagName;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.Loader;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.Receiver;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.UnmarshallingContext;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.UnmarshallingContext.State;
aoqi@0: 
aoqi@0: import org.xml.sax.SAXException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: final class SingleMapNodeProperty<BeanT,ValueT extends Map> extends PropertyImpl<BeanT> {
aoqi@0: 
aoqi@0:     private final Accessor<BeanT,ValueT> acc;
aoqi@0:     /**
aoqi@0:      * The tag name that surrounds the whole property.
aoqi@0:      */
aoqi@0:     private final Name tagName;
aoqi@0:     /**
aoqi@0:      * The tag name that corresponds to the 'entry' element.
aoqi@0:      */
aoqi@0:     private final Name entryTag;
aoqi@0:     private final Name keyTag;
aoqi@0:     private final Name valueTag;
aoqi@0: 
aoqi@0:     private final boolean nillable;
aoqi@0: 
aoqi@0:     private JaxBeanInfo keyBeanInfo;
aoqi@0:     private JaxBeanInfo valueBeanInfo;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The implementation class for this property.
aoqi@0:      * If the property is null, we create an instance of this class.
aoqi@0:      */
aoqi@0:     private final Class<? extends ValueT> mapImplClass;
aoqi@0: 
aoqi@0:     public SingleMapNodeProperty(JAXBContextImpl context, RuntimeMapPropertyInfo prop) {
aoqi@0:         super(context, prop);
aoqi@0:         acc = prop.getAccessor().optimize(context);
aoqi@0:         this.tagName = context.nameBuilder.createElementName(prop.getXmlName());
aoqi@0:         this.entryTag = context.nameBuilder.createElementName("","entry");
aoqi@0:         this.keyTag = context.nameBuilder.createElementName("","key");
aoqi@0:         this.valueTag = context.nameBuilder.createElementName("","value");
aoqi@0:         this.nillable = prop.isCollectionNillable();
aoqi@0:         this.keyBeanInfo = context.getOrCreate(prop.getKeyType());
aoqi@0:         this.valueBeanInfo = context.getOrCreate(prop.getValueType());
aoqi@0: 
aoqi@0:         // infer the implementation class
aoqi@0:         //noinspection unchecked
aoqi@0:         Class<ValueT> sig = (Class<ValueT>) Utils.REFLECTION_NAVIGATOR.erasure(prop.getRawType());
aoqi@0:         mapImplClass = ClassFactory.inferImplClass(sig,knownImplClasses);
aoqi@0:         // TODO: error check for mapImplClass==null
aoqi@0:         // what is the error reporting path for this part of the code?
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final Class[] knownImplClasses = {
aoqi@0:         HashMap.class, TreeMap.class, LinkedHashMap.class
aoqi@0:     };
aoqi@0: 
aoqi@0:     public void reset(BeanT bean) throws AccessorException {
aoqi@0:         acc.set(bean,null);
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * A Map property can never be ID.
aoqi@0:      */
aoqi@0:     public String getIdValue(BeanT bean) {
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public PropertyKind getKind() {
aoqi@0:         return PropertyKind.MAP;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void buildChildElementUnmarshallers(UnmarshallerChain chain, QNameMap<ChildLoader> handlers) {
aoqi@0:         keyLoader = keyBeanInfo.getLoader(chain.context,true);
aoqi@0:         valueLoader = valueBeanInfo.getLoader(chain.context,true);
aoqi@0:         handlers.put(tagName,new ChildLoader(itemsLoader,null));
aoqi@0:     }
aoqi@0: 
aoqi@0:     private Loader keyLoader;
aoqi@0:     private Loader valueLoader;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Handles &lt;items> and &lt;/items>.
aoqi@0:      *
aoqi@0:      * The target will be set to a {@link Map}.
aoqi@0:      */
aoqi@0:     private final Loader itemsLoader = new Loader(false) {
aoqi@0: 
aoqi@0:         private ThreadLocal<BeanT> target = new ThreadLocal<BeanT>();
aoqi@0:         private ThreadLocal<ValueT> map = new ThreadLocal<ValueT>();
aoqi@0:         private int depthCounter = 0; // needed to clean ThreadLocals
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void startElement(UnmarshallingContext.State state, TagName ea) throws SAXException {
aoqi@0:             // create or obtain the Map object
aoqi@0:             try {
aoqi@0:                 target.set((BeanT)state.prev.target);
aoqi@0:                 map.set(acc.get(target.get()));
aoqi@0:                 depthCounter++;
aoqi@0:                 if(map.get() == null) {
aoqi@0:                     map.set(ClassFactory.create(mapImplClass));
aoqi@0:                 }
aoqi@0:                 map.get().clear();
aoqi@0:                 state.target = map.get();
aoqi@0:             } catch (AccessorException e) {
aoqi@0:                 // recover from error by setting a dummy Map that receives and discards the values
aoqi@0:                 handleGenericException(e,true);
aoqi@0:                 state.target = new HashMap();
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void leaveElement(State state, TagName ea) throws SAXException {
aoqi@0:             super.leaveElement(state, ea);
aoqi@0:             try {
aoqi@0:                 acc.set(target.get(), map.get());
aoqi@0:                 if (--depthCounter == 0) {
aoqi@0:                     target.remove();
aoqi@0:                     map.remove();
aoqi@0:                 }
aoqi@0:             } catch (AccessorException ex) {
aoqi@0:                 handleGenericException(ex,true);
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void childElement(UnmarshallingContext.State state, TagName ea) throws SAXException {
aoqi@0:             if(ea.matches(entryTag)) {
aoqi@0:                 state.loader = entryLoader;
aoqi@0:             } else {
aoqi@0:                 super.childElement(state,ea);
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Collection<QName> getExpectedChildElements() {
aoqi@0:             return Collections.singleton(entryTag.toQName());
aoqi@0:         }
aoqi@0:     };
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Handles &lt;entry> and &lt;/entry>.
aoqi@0:      *
aoqi@0:      * The target will be set to a {@link Map}.
aoqi@0:      */
aoqi@0:     private final Loader entryLoader = new Loader(false) {
aoqi@0:         @Override
aoqi@0:         public void startElement(UnmarshallingContext.State state, TagName ea) {
aoqi@0:             state.target = new Object[2];  // this is inefficient
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void leaveElement(UnmarshallingContext.State state, TagName ea) {
aoqi@0:             Object[] keyValue = (Object[])state.target;
aoqi@0:             Map map = (Map) state.prev.target;
aoqi@0:             map.put(keyValue[0],keyValue[1]);
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public void childElement(UnmarshallingContext.State state, TagName ea) throws SAXException {
aoqi@0:             if(ea.matches(keyTag)) {
aoqi@0:                 state.loader = keyLoader;
aoqi@0:                 state.receiver = keyReceiver;
aoqi@0:                 return;
aoqi@0:             }
aoqi@0:             if(ea.matches(valueTag)) {
aoqi@0:                 state.loader = valueLoader;
aoqi@0:                 state.receiver = valueReceiver;
aoqi@0:                 return;
aoqi@0:             }
aoqi@0:             super.childElement(state,ea);
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public Collection<QName> getExpectedChildElements() {
aoqi@0:             return Arrays.asList(keyTag.toQName(),valueTag.toQName());
aoqi@0:         }
aoqi@0:     };
aoqi@0: 
aoqi@0:     private static final class ReceiverImpl implements Receiver {
aoqi@0:         private final int index;
aoqi@0:         public ReceiverImpl(int index) {
aoqi@0:             this.index = index;
aoqi@0:         }
aoqi@0:         public void receive(UnmarshallingContext.State state, Object o) {
aoqi@0:             ((Object[])state.target)[index] = o;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final Receiver keyReceiver = new ReceiverImpl(0);
aoqi@0:     private static final Receiver valueReceiver = new ReceiverImpl(1);
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public void serializeBody(BeanT o, XMLSerializer w, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException {
aoqi@0:         ValueT v = acc.get(o);
aoqi@0:         if(v!=null) {
aoqi@0:             bareStartTag(w,tagName,v);
aoqi@0:             for( Map.Entry e : (Set<Map.Entry>)v.entrySet() ) {
aoqi@0:                 bareStartTag(w,entryTag,null);
aoqi@0: 
aoqi@0:                 Object key = e.getKey();
aoqi@0:                 if(key!=null) {
aoqi@0:                     w.startElement(keyTag,key);
aoqi@0:                     w.childAsXsiType(key,fieldName,keyBeanInfo, false);
aoqi@0:                     w.endElement();
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 Object value = e.getValue();
aoqi@0:                 if(value!=null) {
aoqi@0:                     w.startElement(valueTag,value);
aoqi@0:                     w.childAsXsiType(value,fieldName,valueBeanInfo, false);
aoqi@0:                     w.endElement();
aoqi@0:                 }
aoqi@0: 
aoqi@0:                 w.endElement();
aoqi@0:             }
aoqi@0:             w.endElement();
aoqi@0:         } else
aoqi@0:         if(nillable) {
aoqi@0:             w.startElement(tagName,null);
aoqi@0:             w.writeXsiNilTrue();
aoqi@0:             w.endElement();
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void bareStartTag(XMLSerializer w, Name tagName, Object peer) throws IOException, XMLStreamException, SAXException {
aoqi@0:         w.startElement(tagName,peer);
aoqi@0:         w.endNamespaceDecls(peer);
aoqi@0:         w.endAttributes();
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public Accessor getElementPropertyAccessor(String nsUri, String localName) {
aoqi@0:         if(tagName.equals(nsUri,localName))
aoqi@0:             return acc;
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: }