org.simpleframework.xml.load.ElementMapLabel Maven / Gradle / Ivy
/*
* ElementMapLabel.java July 2007
*
* Copyright (C) 2007, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml.load;
import org.simpleframework.xml.ElementMap;
import org.simpleframework.xml.stream.Style;
/**
* The ElementMapLabel represents a label that is used
* to represent an XML element map in a class schema. This element
* list label can be used to convert an XML node into a map object
* of composite or primitive key value pairs. Each element converted
* with the converter this creates must be an XML serializable element.
*
* @author Niall Gallagher
*
* @see org.simpleframework.xml.ElementMap
*/
class ElementMapLabel implements Label {
/**
* This references the annotation that the field uses.
*/
private ElementMap label;
/**
* This contains the details of the annotated contact object.
*/
private Signature detail;
/**
* The entry object contains the details on how to write the map.
*/
private Entry entry;
/**
* This is the type of map object this list will instantiate.
*/
private Class type;
/**
* Represents the type of objects this map object will hold.
*/
private Class[] items;
/**
* This is the name of the XML entry from the annotation.
*/
private String parent;
/**
* This is the name of the element for this label instance.
*/
private String name;
/**
* Constructor for the ElementMapLabel object. This
* creates a label object, which can be used to convert an XML
* node to a Map of XML serializable objects.
*
* @param contact this is the contact that this label represents
* @param label the annotation that contains the schema details
*/
public ElementMapLabel(Contact contact, ElementMap label) {
this.detail = new Signature(contact, this);
this.entry = new Entry(contact, label);
this.type = contact.getType();
this.name = label.name();
this.label = label;
}
/**
* This method returns a Converter which can be used to
* convert an XML node into an object value and vice versa. The
* converter requires only the source object in order to perform
* serialization or deserialization of the provided XML node.
*
* @param root this is the source object for the serialization
*
* @return this returns an object that is used for conversion
*/
public Converter getConverter(Source root) throws Exception {
if(!label.inline()) {
return new CompositeMap(root, entry, type);
}
return new CompositeInlineMap(root, entry, type);
}
/**
* This is used to acquire the name of the element or attribute
* that is used by the class schema. The name is determined by
* checking for an override within the annotation. If it contains
* a name then that is used, if however the annotation does not
* specify a name the the field or method name is used instead.
*
* @param source this is the source used to style the nanme
*
* @return returns the name that is used for the XML property
*/
public String getName(Source source) throws Exception {
Style style = source.getStyle();
String name = entry.getEntry();
if(!label.inline()) {
name = detail.getName();
}
return style.getElement(name);
}
/**
* This is used to provide a configured empty value used when the
* annotated value is null. This ensures that XML can be created
* with required details regardless of whether values are null or
* not. It also provides a means for sensible default values.
*
* @param root this is the source object for the serialization
*
* @return this returns the string to use for default values
*/
public Object getEmpty(Source root) throws Exception {
Factory factory = new MapFactory(root, type);
if(!label.empty()) {
return factory.getInstance();
}
return null;
}
/**
* This is used to acquire the dependant type for the annotated
* list. This will simply return the type that the map object is
* composed to hold. This must be a serializable type, that is,
* a type that is annotated with the Root class.
*
* @return this returns the component type for the map object
*/
public Class getDependant() throws Exception {
Contact contact = getContact();
if(items == null) {
items = contact.getDependants();
}
if(items == null) {
throw new ElementException("Unable to determine type for %s", label);
}
return items[0];
}
/**
* This is used to either provide the entry value provided within
* the annotation or compute a entry value. If the entry string
* is not provided the the entry value is calculated as the type
* of primitive the object is as a simplified class name.
*
* @return this returns the name of the XML entry element used
*/
public String getEntry() throws Exception {
if(detail.isEmpty(parent)) {
parent = detail.getEntry();
}
return parent;
}
/**
* This is used to acquire the name of the element or attribute
* that is used by the class schema. The name is determined by
* checking for an override within the annotation. If it contains
* a name then that is used, if however the annotation does not
* specify a name the the field or method name is used instead.
*
* @return returns the name that is used for the XML property
*/
public String getName() throws Exception{
if(label.inline()) {
return entry.getEntry();
}
return detail.getName();
}
/**
* This acts as a convinience method used to determine the type of
* contact this represents. This is used when an object is written
* to XML. It determines whether a class attribute
* is required within the serialized XML element, that is, if the
* class returned by this is different from the actual value of the
* object to be serialized then that type needs to be remembered.
*
* @return this returns the type of the contact class
*/
public Class getType() {
return type;
}
/**
* This is used to acquire the contact object for this label. The
* contact retrieved can be used to set any object or primitive that
* has been deserialized, and can also be used to acquire values to
* be serialized in the case of object persistance. All contacts
* that are retrieved from this method will be accessible.
*
* @return returns the contact that this label is representing
*/
public Contact getContact() {
return detail.getContact();
}
/**
* This is used to acquire the name of the element or attribute
* as taken from the annotation. If the element or attribute
* explicitly specifies a name then that name is used for the
* XML element or attribute used. If however no overriding name
* is provided then the method or field is used for the name.
*
* @return returns the name of the annotation for the contact
*/
public String getOverride() {
return name;
}
/**
* This is used to determine whether the annotation requires it
* and its children to be written as a CDATA block. This is done
* when a primitive or other such element requires a text value
* and that value needs to be encapsulated within a CDATA block.
*
* @return currently the element list does not require CDATA
*/
public boolean isData() {
return label.data();
}
/**
* This is used to determine whether the XML element is required.
* This ensures that if an XML element is missing from a document
* that deserialization can continue. Also, in the process of
* serialization, if a value is null it does not need to be
* written to the resulting XML document.
*
* @return true if the label represents a some required data
*/
public boolean isRequired() {
return label.required();
}
/**
* This is used to determine whether the list has been specified
* as inline. If the list is inline then no overrides are needed
* and the outer XML element for the list is not used.
*
* @return this returns whether the annotation is inline
*/
public boolean isInline() {
return label.inline();
}
/**
* This is used to describe the annotation and method or field
* that this label represents. This is used to provide error
* messages that can be used to debug issues that occur when
* processing a method. This will provide enough information
* such that the problem can be isolated correctly.
*
* @return this returns a string representation of the label
*/
public String toString() {
return detail.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy