oracle.toplink.ox.mappings.converters
Class XMLJavaTypeConverter

java.lang.Object
  oracle.toplink.ox.mappings.converters.XMLConverterAdapter
      oracle.toplink.ox.mappings.converters.XMLJavaTypeConverter

All Implemented Interfaces:

java.io.Serializable, Converter, XMLConverter

public class XMLJavaTypeConverter
extends XMLConverterAdapter

Converter that wraps an XmlAdapter.

See Also:

XmlAdapter, Serialized Form

Constructor Summary

XMLJavaTypeConverter()
The default constructor.

XMLJavaTypeConverter(java.lang.Class xmlAdapterClass)
This constructor takes the XmlAdapter class to be used with this converter.

XMLJavaTypeConverter(java.lang.Class xmlAdapterClass, javax.xml.namespace.QName schemaType)
This constructor takes the XmlAdapter class to be used with this converter, as well as a schema type to be used during the conversion operation.

XMLJavaTypeConverter(java.lang.String xmlAdapterClassName)
This constructor takes an adapter class name.

XMLJavaTypeConverter(java.lang.String xmlAdapterClassName, javax.xml.namespace.QName schemaType)
This constructor takes the XmlAdapter class name to be used with this converter (loaded during initialization), as well as a schema type to be used during the conversion operation.

Method Summary

java.lang.Object	convertDataValueToObjectValue(java.lang.Object dataValue, Session session, XMLUnmarshaller unmarshaller) Wraps the XmlAdapter unmarshal method.
java.lang.Object	convertObjectValueToDataValue(java.lang.Object objectValue, Session session, XMLMarshaller marshaller) Wraps the XmlAdapter marshal method.
javax.xml.namespace.QName	getSchemaType() Get the schema type to be used during conversion.
java.lang.Class	getXmlAdapterClass() Return the XmlAdapter class for this converter.
java.lang.String	getXmlAdapterClassName() Return the XmlAdapter class name for this converter.
void	initialize(DatabaseMapping mapping, Session session) Figure out the BoundType and ValueType for the XmlAdapter class, then either create an instance of the XmlAdapter, or if an instance is set on the marshaller, use it.
boolean	isMutable() Satisfy the interface.
void	setSchemaType(javax.xml.namespace.QName qname) Set the schema type to be used during conversion - if one is required.
void	setXmlAdapterClass(java.lang.Class xmlAdapterClass) Set the XmlAdapter class to be used with this converter.
void	setXmlAdapterClassName(java.lang.String xmlAdapterClassName) Set the XmlAdapter class to be used with this converter.

Methods inherited from class oracle.toplink.ox.mappings.converters.XMLConverterAdapter

convertDataValueToObjectValue, convertObjectValueToDataValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLJavaTypeConverter

public XMLJavaTypeConverter()

The default constructor. This constructor should be used in conjunction with the setXmlAdapterClass method or setXmlAdapterClassName method.

See Also:

setXmlAdapterClass(Class)

XMLJavaTypeConverter

public XMLJavaTypeConverter(java.lang.Class xmlAdapterClass)

This constructor takes the XmlAdapter class to be used with this converter.

Parameters:

xmlAdapter -

XMLJavaTypeConverter

public XMLJavaTypeConverter(java.lang.String xmlAdapterClassName)

This constructor takes an adapter class name. The adapter class will be loaded during initialization.

Parameters:

xmlAdapterClassName -

XMLJavaTypeConverter

public XMLJavaTypeConverter(java.lang.Class xmlAdapterClass,
                            javax.xml.namespace.QName schemaType)

This constructor takes the XmlAdapter class to be used with this converter, as well as a schema type to be used during the conversion operation. During unmarshal, the value type will be converted to the schema type, then from that type to the bound type. The opposite will occur during marshal.

Parameters:

xmlAdapter -

schemaType -

XMLJavaTypeConverter

public XMLJavaTypeConverter(java.lang.String xmlAdapterClassName,
                            javax.xml.namespace.QName schemaType)

This constructor takes the XmlAdapter class name to be used with this converter (loaded during initialization), as well as a schema type to be used during the conversion operation. During unmarshal, the value type will be converted to the schema type, then from that type to the bound type. The opposite will occur during marshal.

Parameters:

xmlAdapter -

schemaType -

Method Detail

convertDataValueToObjectValue

public java.lang.Object convertDataValueToObjectValue(java.lang.Object dataValue,
                                                      Session session,
                                                      XMLUnmarshaller unmarshaller)

Wraps the XmlAdapter unmarshal method.

convertObjectValueToDataValue

public java.lang.Object convertObjectValueToDataValue(java.lang.Object objectValue,
                                                      Session session,
                                                      XMLMarshaller marshaller)

Wraps the XmlAdapter marshal method.

getSchemaType

public javax.xml.namespace.QName getSchemaType()

Get the schema type to be used during conversion.

getXmlAdapterClass

public java.lang.Class getXmlAdapterClass()

Return the XmlAdapter class for this converter.

Returns:

xmlAdapterClass

getXmlAdapterClassName

public java.lang.String getXmlAdapterClassName()

Return the XmlAdapter class name for this converter. If null, the name will be set to "".

Returns:

xmlAdapterClassName

initialize

public void initialize(DatabaseMapping mapping,
                       Session session)

Figure out the BoundType and ValueType for the XmlAdapter class, then either create an instance of the XmlAdapter, or if an instance is set on the marshaller, use it.

Parameters:

mapping -

session -

isMutable

public boolean isMutable()

Satisfy the interface.

setSchemaType

public void setSchemaType(javax.xml.namespace.QName qname)

Set the schema type to be used during conversion - if one is required.

setXmlAdapterClass

public void setXmlAdapterClass(java.lang.Class xmlAdapterClass)

Set the XmlAdapter class to be used with this converter.

Parameters:

xmlAdapterClass -

setXmlAdapterClassName

public void setXmlAdapterClassName(java.lang.String xmlAdapterClassName)

Set the XmlAdapter class to be used with this converter.

Parameters:

xmlAdapterClass -