ohair@286: /*
ohair@286:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.bind.v2.runtime.property;
ohair@286: 
ohair@286: import java.io.IOException;
alanb@368: import java.lang.reflect.Modifier;
ohair@286: 
alanb@368: import javax.xml.bind.JAXBElement;
ohair@286: import javax.xml.stream.XMLStreamException;
ohair@286: 
ohair@286: import com.sun.xml.internal.bind.api.AccessorException;
alanb@368: import com.sun.xml.internal.bind.v2.model.core.ID;
ohair@286: import com.sun.xml.internal.bind.v2.model.core.PropertyKind;
ohair@286: import com.sun.xml.internal.bind.v2.model.runtime.RuntimeElementPropertyInfo;
ohair@286: import com.sun.xml.internal.bind.v2.model.runtime.RuntimeTypeRef;
alanb@368: import com.sun.xml.internal.bind.v2.runtime.ClassBeanInfoImpl;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.Name;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.XMLSerializer;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.reflect.Accessor;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.reflect.TransducedAccessor;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.ChildLoader;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.DefaultValueLoaderDecorator;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.LeafPropertyLoader;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.LeafPropertyXsiLoader;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.Loader;
ohair@286: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.XsiNilLoader;
ohair@286: import com.sun.xml.internal.bind.v2.util.QNameMap;
ohair@286: 
ohair@286: import org.xml.sax.SAXException;
ohair@286: 
ohair@286: /**
ohair@286:  * {@link Property} that contains a leaf value.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
ohair@286:  */
ohair@286: final class SingleElementLeafProperty<BeanT> extends PropertyImpl<BeanT> {
ohair@286: 
ohair@286:     private final Name tagName;
ohair@286:     private final boolean nillable;
ohair@286:     private final Accessor acc;
ohair@286:     private final String defaultValue;
ohair@286:     private final TransducedAccessor<BeanT> xacc;
ohair@286:     private final boolean improvedXsiTypeHandling;
alanb@368:     private final boolean idRef;
ohair@286: 
ohair@286:     public SingleElementLeafProperty(JAXBContextImpl context, RuntimeElementPropertyInfo prop) {
ohair@286:         super(context, prop);
ohair@286:         RuntimeTypeRef ref = prop.getTypes().get(0);
ohair@286:         tagName = context.nameBuilder.createElementName(ref.getTagName());
ohair@286:         assert tagName != null;
ohair@286:         nillable = ref.isNillable();
ohair@286:         defaultValue = ref.getDefaultValue();
ohair@286:         this.acc = prop.getAccessor().optimize(context);
ohair@286: 
ohair@286:         xacc = TransducedAccessor.get(context, ref);
ohair@286:         assert xacc != null;
ohair@286: 
ohair@286:         improvedXsiTypeHandling = context.improvedXsiTypeHandling;
alanb@368:         idRef = ref.getSource().id() == ID.IDREF;
ohair@286:     }
ohair@286: 
ohair@286:     public void reset(BeanT o) throws AccessorException {
ohair@286:         acc.set(o, null);
ohair@286:     }
ohair@286: 
ohair@286:     public String getIdValue(BeanT bean) throws AccessorException, SAXException {
ohair@286:         return xacc.print(bean).toString();
ohair@286:     }
ohair@286: 
ohair@286:     @Override
ohair@286:     public void serializeBody(BeanT o, XMLSerializer w, Object outerPeer) throws SAXException, AccessorException, IOException, XMLStreamException {
ohair@286:         boolean hasValue = xacc.hasValue(o);
ohair@286: 
ohair@286:         Object obj = null;
ohair@286: 
ohair@286:         try {
ohair@286:             obj = acc.getUnadapted(o);
ohair@286:         } catch (AccessorException ae) {
ohair@286:             ; // noop
ohair@286:         }
ohair@286: 
ohair@286:         Class valueType = acc.getValueType();
ohair@286: 
ohair@286:         // check for different type than expected. If found, add xsi:type declaration
alanb@368:         if (xsiTypeNeeded(o, w, obj, valueType)) {
ohair@286:             w.startElement(tagName, outerPeer);
alanb@368:             w.childAsXsiType(obj, fieldName, w.grammar.getBeanInfo(valueType), false);
ohair@286:             w.endElement();
ohair@286:         } else {  // current type is expected
ohair@286:             if (hasValue) {
ohair@286:                 xacc.writeLeafElement(w, tagName, o, fieldName);
ohair@286:             } else if (nillable) {
ohair@286:                 w.startElement(tagName, null);
ohair@286:                 w.writeXsiNilTrue();
ohair@286:                 w.endElement();
ohair@286:             }
ohair@286:         }
ohair@286:     }
ohair@286: 
alanb@368:     /**
alanb@368:      * Checks if xsi type needed to be specified
alanb@368:      */
alanb@368:     private boolean xsiTypeNeeded(BeanT bean, XMLSerializer w, Object value, Class valueTypeClass) {
alanb@368:         if (!improvedXsiTypeHandling) // improved xsi type set
alanb@368:             return false;
alanb@368:         if (acc.isAdapted()) // accessor is not adapted
alanb@368:             return false;
alanb@368:         if (value == null) // value is not null
alanb@368:             return false;
alanb@368:         if (value.getClass().equals(valueTypeClass)) // value represented by different class
alanb@368:             return false;
alanb@368:         if (idRef) // IDREF
alanb@368:             return false;
alanb@368:         if (valueTypeClass.isPrimitive()) // is not primitive
alanb@368:             return false;
alanb@368:         return acc.isValueTypeAbstractable() || isNillableAbstract(bean, w.grammar, value, valueTypeClass);
alanb@368:     }
alanb@368: 
alanb@368:     /**
alanb@368:      * Checks if element is nillable and represented by abstract class.
alanb@368:      */
alanb@368:     private boolean isNillableAbstract(BeanT bean, JAXBContextImpl context, Object value, Class valueTypeClass) {
alanb@368:         if (!nillable) // check if element is nillable
alanb@368:             return false;
alanb@368:         if (valueTypeClass != Object.class) // required type wasn't recognized
alanb@368:             return false;
alanb@368:         if (bean.getClass() != JAXBElement.class) // is JAXBElement
alanb@368:             return false;
alanb@368:         JAXBElement jaxbElement = (JAXBElement) bean;
alanb@368:         Class valueClass = value.getClass();
alanb@368:         Class declaredTypeClass = jaxbElement.getDeclaredType();
alanb@368:         if (declaredTypeClass.equals(valueClass)) // JAXBElement<class> is different from unadapted class)
alanb@368:             return false;
alanb@368:         if (!declaredTypeClass.isAssignableFrom(valueClass)) // and is subclass from it
alanb@368:             return false;
alanb@368:         if (!Modifier.isAbstract(declaredTypeClass.getModifiers())) // declared class is abstract
alanb@368:             return false;
alanb@368:         return acc.isAbstractable(declaredTypeClass); // and is not builtin type
alanb@368:     }
alanb@368: 
ohair@286:     public void buildChildElementUnmarshallers(UnmarshallerChain chain, QNameMap<ChildLoader> handlers) {
ohair@286:         Loader l = new LeafPropertyLoader(xacc);
ohair@286:         if (defaultValue != null)
ohair@286:             l = new DefaultValueLoaderDecorator(l, defaultValue);
ohair@286:         if (nillable || chain.context.allNillable)
ohair@286:             l = new XsiNilLoader.Single(l, acc);
ohair@286: 
ohair@286:         // LeafPropertyXsiLoader doesn't work well with nillable elements
alanb@368:         if (improvedXsiTypeHandling)
ohair@286:             l = new LeafPropertyXsiLoader(l, xacc, acc);
ohair@286: 
ohair@286:         handlers.put(tagName, new ChildLoader(l, null));
ohair@286:     }
ohair@286: 
ohair@286: 
ohair@286:     public PropertyKind getKind() {
ohair@286:         return PropertyKind.ELEMENT;
ohair@286:     }
ohair@286: 
ohair@286:     @Override
ohair@286:     public Accessor getElementPropertyAccessor(String nsUri, String localName) {
ohair@286:         if (tagName.equals(nsUri, localName))
ohair@286:             return acc;
ohair@286:         else
ohair@286:             return null;
ohair@286:     }
ohair@286: }