public class HashMapperStringToSchemaType extends java.lang.Object implements IMarshaller, IUnmarshaller, IAliasable
Custom marshaller/unmarshaller for java.util.Map
instances. This handles mapping hash maps with string keys and values that
match basic schema datatypes to and from XML. The key objects are marshalled
as simple text values, using the toString()
method to convert
them to String
if they are not already of that type. When
unmarshalling the keys are always treated as String
values. The
corresponding values can be any of the object types corresponding to basic
schema data types, and are marshalled with xsi:type attributes to specify the
type of each value. The types currently supported are Byte
,
Double
, Float
, Integer
,
Long
, java.util.Date
(as xsd:dateTime),
java.sql.Date
(as xsd:date), java.sql.Time
(as
xsd:time), java.math.BigDecimal
(with no exponent allowed, as
xsd:decimal), and java.math.BigInteger
(as xsd:integer). The
xsd:type attribute is checked when unmarshalling values to select the proper
deserialization and value type. The name of the top-level element in the XML
structure can be configured in the binding definition, but the rest of the
names are predefined and set in the code (though the namespace configured for
the top-level element will be used with all the names).
The net effect is that the XML structure will always be of the form:
<map-name size="6" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <entry key="name" xsi:type="xsd:string">John Smith</entry> <entry key="street" xsi:type="xsd:string">12345 Happy Lane</entry> <entry key="city" xsi:type="xsd:string">Plunk</entry> <entry key="state" xsi:type="xsd:string">WA</entry> <entry key="rating" xsi:type="xsd:int">6</entry> <entry key="joined" xsi:type="xsd:dateTime">2002-08-06T00:13:31Z</entry> </map-name>
where "map-name" is the configured top-level element name, the "size" attribute is the number of pairs in the hash map, and the "entry" elements are the actual entries in the hash map.
For unmarshalling this requires an active namespace declaration with a prefix for the schema namespace. All xsi:type attribute values must use this prefix. If more than one prefix is declared for the schema namespace, the innermost one declared must be used.
Modifier and Type | Field and Description |
---|---|
static int |
BOOLEAN_TYPE |
static int |
BYTE_TYPE |
static int |
BYTERRAY_TYPE |
static int |
DATE_TYPE |
static int |
DATETIME_TYPE |
static int |
DECIMAL_TYPE |
private static int |
DEFAULT_SIZE |
static int |
DOUBLE_TYPE |
private static java.lang.String |
ENTRY_ELEMENT_NAME |
static int |
FLOAT_TYPE |
static int |
INT_TYPE |
static int |
INTEGER_TYPE |
private static java.lang.String |
KEY_ATTRIBUTE_NAME |
static int |
LONG_TYPE |
private int |
m_index |
private java.lang.String |
m_name |
private java.lang.String |
m_uri |
private static EnumSet |
s_javaTypesEnum |
private static EnumSet |
s_schemaTypesEnum |
private static java.lang.String[] |
SCHEMA_NAMESPACE_PREFIXES |
private static java.lang.String[] |
SCHEMA_NAMESPACE_URIS |
static int |
SHORT_TYPE |
private static java.lang.String |
SIZE_ATTRIBUTE_NAME |
static int |
STRING_TYPE |
static int |
TIME_TYPE |
private static java.lang.String |
TYPE_ATTRIBUTE_NAME |
private static java.lang.String |
XSD_NAMESPACE_PREFIX |
private static java.lang.String |
XSD_NAMESPACE_URI |
private static java.lang.String |
XSD_PREFIX_LEAD |
private static java.lang.String |
XSI_NAMESPACE_PREFIX |
private static java.lang.String |
XSI_NAMESPACE_URI |
Constructor and Description |
---|
HashMapperStringToSchemaType()
Default constructor.
|
HashMapperStringToSchemaType(java.lang.String uri,
int index,
java.lang.String name)
Aliased constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isExtension(java.lang.String mapname)
Check if marshaller represents an extension mapping.
|
boolean |
isPresent(IUnmarshallingContext ctx)
Check if instance present in XML.
|
void |
marshal(java.lang.Object obj,
IMarshallingContext ictx)
Marshal instance of handled class.
|
java.lang.Object |
unmarshal(java.lang.Object obj,
IUnmarshallingContext ictx)
Unmarshal instance of handled class.
|
private static final java.lang.String SIZE_ATTRIBUTE_NAME
private static final java.lang.String ENTRY_ELEMENT_NAME
private static final java.lang.String KEY_ATTRIBUTE_NAME
private static final java.lang.String TYPE_ATTRIBUTE_NAME
private static final java.lang.String XSI_NAMESPACE_URI
private static final java.lang.String XSD_NAMESPACE_URI
private static final java.lang.String[] SCHEMA_NAMESPACE_URIS
private static final java.lang.String XSI_NAMESPACE_PREFIX
private static final java.lang.String XSD_NAMESPACE_PREFIX
private static final java.lang.String[] SCHEMA_NAMESPACE_PREFIXES
private static final java.lang.String XSD_PREFIX_LEAD
private static final int DEFAULT_SIZE
public static final int BOOLEAN_TYPE
public static final int BYTE_TYPE
public static final int DOUBLE_TYPE
public static final int FLOAT_TYPE
public static final int INT_TYPE
public static final int LONG_TYPE
public static final int SHORT_TYPE
public static final int DATETIME_TYPE
public static final int DECIMAL_TYPE
public static final int INTEGER_TYPE
public static final int BYTERRAY_TYPE
public static final int STRING_TYPE
public static final int DATE_TYPE
public static final int TIME_TYPE
private static final EnumSet s_javaTypesEnum
private static final EnumSet s_schemaTypesEnum
private java.lang.String m_uri
private int m_index
private java.lang.String m_name
public HashMapperStringToSchemaType()
public HashMapperStringToSchemaType(java.lang.String uri, int index, java.lang.String name)
uri
- namespace URI for the top-level element (also used for all
other names within the binding)index
- namespace index corresponding to the defined URI within the
marshalling context definitionsname
- local name for the top-level elementpublic boolean isExtension(java.lang.String mapname)
IMarshaller
isExtension
in interface IMarshaller
mapname
- marshaller mapping name (generally the class name to be
handled, or abstract mapping type name)true
if this mapping is an extension of the abstract
mapping, false
if notpublic void marshal(java.lang.Object obj, IMarshallingContext ictx) throws JiBXException
IMarshaller
marshal
in interface IMarshaller
obj
- object to be marshalled (may be null
if property
is not optional)ictx
- XML text output contextJiBXException
- on error in marshalling processpublic boolean isPresent(IUnmarshallingContext ctx) throws JiBXException
IUnmarshaller
isPresent
in interface IUnmarshaller
ctx
- unmarshalling contexttrue
if expected parse data found,
false
if notJiBXException
- on error in unmarshalling processpublic java.lang.Object unmarshal(java.lang.Object obj, IUnmarshallingContext ictx) throws JiBXException
IUnmarshaller
unmarshal
in interface IUnmarshaller
obj
- object to be unmarshalled (may be null
)ictx
- unmarshalling contextnull
)JiBXException
- on error in unmarshalling process