org.apache.axis2.wsdl.databinding
Interface TypeMapper

All Known Implementing Classes:

CDefaultTypeMapper, CTypeMapper, DefaultTypeMapper, JavaTypeMapper, TypeMappingAdapter

public interface TypeMapper

Method Summary

void	addTypeMappingName(javax.xml.namespace.QName qname, java.lang.String value) Adds a type mapping name to the type mapper.
void	addTypeMappingObject(javax.xml.namespace.QName qname, java.lang.Object value) Adds a type mapping object to the type mapper.
void	addTypeMappingStatus(javax.xml.namespace.QName qName, java.lang.Object status) Allows the storage of a status object with a mapping to the qname.
java.util.Map	getAllMappedNames()
java.util.Map	getAllMappedObjects()
java.lang.String	getDefaultMappingName()
java.lang.String	getParameterName(javax.xml.namespace.QName qname) Gets the parameter name.
java.lang.Object	getQNameToMappingObject(javax.xml.namespace.QName qname)
java.lang.String	getTypeMappingName(javax.xml.namespace.QName qname) Gets the type mapping class name.
java.lang.Object	getTypeMappingObject(javax.xml.namespace.QName qname) Gets the type mapping Object.
java.lang.Object	getTypeMappingStatus(javax.xml.namespace.QName qName) Returns the relevant status object given the qName of the xml element
boolean	isObjectMappingPresent() Returns whether the mapping is the object type or the normal class name type
void	setDefaultMappingName(java.lang.String defaultMapping) Sets the default type mapping - the databinders may change the default mapping to suit their default mapping

Method Detail

isObjectMappingPresent

boolean isObjectMappingPresent()

Returns whether the mapping is the object type or the normal class name type

Returns:

Returns boolean.

getTypeMappingName

java.lang.String getTypeMappingName(javax.xml.namespace.QName qname)

Gets the type mapping class name.

Parameters:

qname - name of the XML element to be mapped

Returns:

Returns a string that represents the particular type.

getTypeMappingObject

java.lang.Object getTypeMappingObject(javax.xml.namespace.QName qname)

Gets the type mapping Object.

Parameters:

qname - name of the XML element to be mapped

Returns:

Returns an Object that represents the particular class in a pre specified form. It can be a specific format to the databinding framework used. This allows tight integrations with the databinding framework, allowing the emitter to write the databinding classes in its own way.

getQNameToMappingObject

java.lang.Object getQNameToMappingObject(javax.xml.namespace.QName qname)

getParameterName

java.lang.String getParameterName(javax.xml.namespace.QName qname)

Gets the parameter name.

Parameters:

qname - name of the XML element to get a parameter

Returns:

Returns a unique parameter name.

addTypeMappingName

void addTypeMappingName(javax.xml.namespace.QName qname,
                        java.lang.String value)

Adds a type mapping name to the type mapper.

Parameters:

qname -

value -

See Also:

getTypeMappingName(javax.xml.namespace.QName)

addTypeMappingObject

void addTypeMappingObject(javax.xml.namespace.QName qname,
                          java.lang.Object value)

Adds a type mapping object to the type mapper.

Parameters:

qname - the xml Qname that this type refers to

value - the type mapping object

See Also:

getTypeMappingObject(javax.xml.namespace.QName)

getAllMappedNames

java.util.Map getAllMappedNames()

Returns:

Returns a map containing all type mapping names i.e. Qname to classname

getAllMappedObjects

java.util.Map getAllMappedObjects()

Returns:

Returns a map containing all type mapping model objects i.e. Qname to model objects

getDefaultMappingName

java.lang.String getDefaultMappingName()

Returns:

the default mapping name for this type mapper

setDefaultMappingName

void setDefaultMappingName(java.lang.String defaultMapping)

Sets the default type mapping - the databinders may change the default mapping to suit their default mapping

Parameters:

defaultMapping -

addTypeMappingStatus

void addTypeMappingStatus(javax.xml.namespace.QName qName,
                          java.lang.Object status)

Allows the storage of a status object with a mapping to the qname. This may be used to store certain status information that will be used by different type mappers. A given type mapper may choose not to implement this!

Parameters:

qname -

status -

getTypeMappingStatus

java.lang.Object getTypeMappingStatus(javax.xml.namespace.QName qName)

Returns the relevant status object given the qName of the xml element

Parameters:

qName -

Returns:

the status object

See Also:

addTypeMappingStatus(javax.xml.namespace.QName, Object)