Package org.apache.openjpa.meta

Class XMLFieldMetaData

java.lang.Object

org.apache.openjpa.meta.XMLFieldMetaData

All Implemented Interfaces:

java.io.Serializable, XMLMetaData

public class XMLFieldMetaData
extends java.lang.Object
implements XMLMetaData

Contains metadata about an xml element or attribute

Since:

1.0.0

Author:

Catalina Wei

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.openjpa.meta.XMLMetaData

ATTRIBUTE, defaultName, ELEMENT, XMLTYPE

Constructor Summary

Constructors

Constructor	Description
XMLFieldMetaData()
XMLFieldMetaData(java.lang.Class type, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addField(java.lang.String name, XMLMetaData field)
XMLMetaData	getFieldMapping(java.lang.String name)	Return XMLMapping for a given field.
java.lang.String	getName()	Return the mapping name.
java.lang.Class	getType()	Return type.
int	getTypeCode()	Return type code.
java.lang.String	getXmlname()	Return xml element tag name or xml attribute name.
java.lang.String	getXmlnamespace()	Return xml namespace.
int	getXmltype()	Return xmltype
boolean	isXmlAttribute()	Return true if mapping on an XmlAttribute.
boolean	isXmlElement()	Return true if mapping on an XmlElement.
boolean	isXmlRootElement()	Return true if mapping on an XmlRootElement.
void	setName(java.lang.String name)	Set field name.
void	setType(java.lang.Class type)	Set type.
void	setTypeCode(int code)
void	setXmlname(java.lang.String name)	Set xml element or attribute name.
void	setXmlnamespace(java.lang.String name)	Set namespace.
void	setXmlRootElement(boolean isXmlRootElement)
void	setXmltype(int type)	Set xmltype

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLFieldMetaData

public XMLFieldMetaData()

XMLFieldMetaData

public XMLFieldMetaData(java.lang.Class type,
                        java.lang.String name)

Method Detail

getType

public java.lang.Class getType()

Description copied from interface: XMLMetaData

Return type.

Specified by:

getType in interface XMLMetaData

setType

public void setType(java.lang.Class type)

Description copied from interface: XMLMetaData

Set type.

Specified by:

setType in interface XMLMetaData

getTypeCode

public int getTypeCode()

Description copied from interface: XMLMetaData

Return type code.

Specified by:

getTypeCode in interface XMLMetaData

setTypeCode

public void setTypeCode(int code)

setName

public void setName(java.lang.String name)

Description copied from interface: XMLMetaData

Set field name.

Specified by:

setName in interface XMLMetaData

Parameters:

name - the field name.

getName

public java.lang.String getName()

Description copied from interface: XMLMetaData

Return the mapping name.

Specified by:

getName in interface XMLMetaData

setXmlname

public void setXmlname(java.lang.String name)

Description copied from interface: XMLMetaData

Set xml element or attribute name.

Specified by:

setXmlname in interface XMLMetaData

Parameters:

name - the element name or attribute name

getXmlname

public java.lang.String getXmlname()

Description copied from interface: XMLMetaData

Return xml element tag name or xml attribute name.

Specified by:

getXmlname in interface XMLMetaData

setXmlnamespace

public void setXmlnamespace(java.lang.String name)

Description copied from interface: XMLMetaData

Set namespace.

Specified by:

setXmlnamespace in interface XMLMetaData

getXmlnamespace

public java.lang.String getXmlnamespace()

Description copied from interface: XMLMetaData

Return xml namespace.

Specified by:

getXmlnamespace in interface XMLMetaData

setXmltype

public void setXmltype(int type)

Description copied from interface: XMLMetaData

Set xmltype

Specified by:

setXmltype in interface XMLMetaData

Parameters:

type - XMLTYPE, ELEMENT, or ATTRIBUTE

getXmltype

public int getXmltype()

Description copied from interface: XMLMetaData

Return xmltype

Specified by:

getXmltype in interface XMLMetaData

Returns:

xmltype

isXmlRootElement

public boolean isXmlRootElement()

Description copied from interface: XMLMetaData

Return true if mapping on an XmlRootElement.

Specified by:

isXmlRootElement in interface XMLMetaData

isXmlElement

public boolean isXmlElement()

Description copied from interface: XMLMetaData

Return true if mapping on an XmlElement.

Specified by:

isXmlElement in interface XMLMetaData

isXmlAttribute

public boolean isXmlAttribute()

Description copied from interface: XMLMetaData

Return true if mapping on an XmlAttribute.

Specified by:

isXmlAttribute in interface XMLMetaData

getFieldMapping

public XMLMetaData getFieldMapping(java.lang.String name)

Description copied from interface: XMLMetaData

Return XMLMapping for a given field.

Specified by:

getFieldMapping in interface XMLMetaData

Parameters:

name - the field name.

Returns:

XMLMapping.

setXmlRootElement

public void setXmlRootElement(boolean isXmlRootElement)

Specified by:

setXmlRootElement in interface XMLMetaData

addField

public void addField(java.lang.String name,
                     XMLMetaData field)

Specified by:

addField in interface XMLMetaData