org.apache.axis.description

Class FieldDesc

Implemented Interfaces:
Serializable
Known Direct Subclasses:
AttributeDesc, ElementDesc

public class FieldDesc
extends java.lang.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

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

Method Summary

String
getFieldName()
Obtain the field name.
Class
getJavaType()
QName
getXmlName()
Obtain the XML QName for this field
QName
getXmlType()
Returns the XML type (e.g.
boolean
isElement()
Check if this is an element or an attribute.
boolean
isIndexed()
boolean
isMinOccursZero()
Check if this field can be omitted.
void
setFieldName(String fieldName)
Set the field name.
void
setJavaType(Class javaType)
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)
void
setXmlName(QName xmlName)
Set the XML QName for this field
void
setXmlType(QName xmlType)
Returns the XML type (e.g.

Constructor Details

FieldDesc

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

Method Details

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.