FileDocCategorySizeDatePackage
FieldDesc.javaAPI DocApache Axis 1.43492Sat Apr 22 18:57:28 BST 2006org.apache.axis.description

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)

Fields Summary
private String
fieldName
The name of the Java field in question
private QName
xmlName
The XML QName this field maps to
private QName
xmlType
The XML Type this field maps to/from
private Class
javaType
The Java type of this field
private boolean
_isElement
An indication of whether this should be an element or an attribute
private boolean
minOccursIs0
An indication that minoccurs is zero
Constructors Summary
protected FieldDesc(boolean isElement)
Can't construct the base class directly, must construct either an ElementDesc or an AttributeDesc.

    
                       
      
    
        _isElement = isElement;
    
Methods Summary
public java.lang.StringgetFieldName()
Obtain the field name.

        return fieldName;
    
public java.lang.ClassgetJavaType()

        return javaType;
    
public javax.xml.namespace.QNamegetXmlName()
Obtain the XML QName for this field

        return xmlName;
    
public javax.xml.namespace.QNamegetXmlType()
Returns the XML type (e.g. xsd:string) for this field

        return xmlType;
    
public booleanisElement()
Check if this is an element or an attribute.

return
true if this is an ElementDesc, or false if an AttributeDesc

        return _isElement;
    
public booleanisIndexed()

        return false;
    
public booleanisMinOccursZero()
Check if this field can be omitted.

        return minOccursIs0;
    
public voidsetFieldName(java.lang.String fieldName)
Set the field name.

        this.fieldName = fieldName;
    
public voidsetJavaType(java.lang.Class javaType)

        this.javaType = javaType;
    
public voidsetMinOccursIs0(boolean minOccursIs0)

param
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)

        this.minOccursIs0 = minOccursIs0;
    
public voidsetXmlName(javax.xml.namespace.QName xmlName)
Set the XML QName for this field

        this.xmlName = xmlName;
    
public voidsetXmlType(javax.xml.namespace.QName xmlType)
Returns the XML type (e.g. xsd:string) for this field

        this.xmlType = xmlType;