org.apache.axis.description

Class FieldDesc

public class FieldDesc extends Object implements Serializable

FieldDescs are metadata objects which control the mapping of a given Java field to/from XML.

Author: Glen Daniels (gdaniels@apache.org)

Constructor Summary
protected FieldDesc(boolean isElement)
Can't construct the base class directly, must construct either an ElementDesc or an AttributeDesc.
Method Summary
StringgetFieldName()
Obtain the field name.
ClassgetJavaType()
QNamegetXmlName()
Obtain the XML QName for this field
QNamegetXmlType()
Returns the XML type (e.g. xsd:string) for this field
booleanisElement()
Check if this is an element or an attribute.
booleanisIndexed()
booleanisMinOccursZero()
Check if this field can be omitted.
voidsetFieldName(String fieldName)
Set the field name.
voidsetJavaType(Class javaType)
voidsetMinOccursIs0(boolean minOccursIs0)
voidsetXmlName(QName xmlName)
Set the XML QName for this field
voidsetXmlType(QName xmlType)
Returns the XML type (e.g. xsd:string) for this field

Constructor Detail

FieldDesc

protected FieldDesc(boolean isElement)
Can't construct the base class directly, must construct either an ElementDesc or an AttributeDesc.

Method Detail

getFieldName

public String getFieldName()
Obtain the field name.

getJavaType

public Class getJavaType()

getXmlName

public QName getXmlName()
Obtain the XML QName for this field

getXmlType

public QName getXmlType()
Returns the XML type (e.g. xsd:string) for this field

isElement

public boolean isElement()
Check if this is an element or an attribute.

Returns: true if this is an ElementDesc, or false if an AttributeDesc

isIndexed

public boolean isIndexed()

isMinOccursZero

public boolean isMinOccursZero()
Check if this field can be omitted.

setFieldName

public void setFieldName(String fieldName)
Set the field name.

setJavaType

public void setJavaType(Class javaType)

setMinOccursIs0

public void setMinOccursIs0(boolean minOccursIs0)

Deprecated: this functionality, which is only relevant to ElementDescs, now lives in ElementDesc and is more flexible (you can set minOccurs and maxOccurs as you please)

Parameters: minOccursIs0

setXmlName

public void setXmlName(QName xmlName)
Set the XML QName for this field

setXmlType

public void setXmlType(QName xmlType)
Returns the XML type (e.g. xsd:string) for this field
Copyright B) 2005 Apache Web Services Project. All Rights Reserved.