org.exolab.castor.xml
public interface XMLFieldDescriptor extends FieldDescriptor
Version: $Revision: 1.5 $ $Date: 2003/04/24 02:09:01 $
Method Summary | |
---|---|
int | getConstructorArgumentIndex()
Returns the index within the constructor argument array where the
value of this field should be. |
String | getLocationPath()
Returns the "relative" XML path for the field being described.
|
String | getNameSpacePrefix()
Return the "suggested" namespace prefix to use when marshalling
as XML.
|
String | getNameSpaceURI()
Returns the namespace URI to be used when marshalling and
unmarshalling as XML.
|
NodeType | getNodeType()
Returns the NodeType of the Field being described. |
String | getSchemaType()
Returns the XML Schema type of the XML field being described.
|
FieldValidator | getValidator()
Returns a specific validator for the field described by
this descriptor. |
String | getXMLName()
Returns the XML Name for the field being described.
|
boolean | isConstructorArgument()
Returns true if the value of the field represented by this
descriptor should be set via the constructor of the containing
class. |
boolean | isContainer()
Returns true if the field described by this descriptor is a container
field. |
boolean | isIncremental()
Returns the incremental flag which when true indicates that this
member may be safely added before the unmarshaller is finished
unmarshalling it. |
boolean | isMapped()
Returns true if the field described by this descriptor
is Map or Hashtable. |
boolean | isMultivalued()
Returns true if the field described by this descriptor can
contain more than one value |
boolean | isReference()
Returns true if the field described by this descriptor is
a reference (ie. |
boolean | matches(String xmlName)
Returns true if this descriptor can be used to handle elements
or attributes with the given XML name. |
boolean | matches(String xmlName, String namespace)
Returns true if this descriptor can be used to handle elements
or attributes with the given XML name. |
Returns: the index within the constructor argument array for this field.
See Also: isConstructorArgument
class Root {
Bar bar;
}
class Bar {
String value;
}
And the following XML:
<root>
<foo>
<bar> value of bar </bar>
</foo>
</root>
Since foo has no associated class, the path for 'bar'
would be: "foo"
UNKNOWN: the "relative" XML path for the field being described.
Returns: the "suggested" namespace prefix.
Returns: the namespace URI.
Returns: the NodeType of the Field being described.
Returns: the XML Schema type of the XML field being described.
Returns: the field validator for the described field
Returns: the XML name.
Returns: true if the value of the field represented by this descriptor should be set via the constructor of the containing class.
Returns: true if the field is a container
Returns: true if the Object can safely be added before the unmarshaller is finished unmarshalling the Object.
Returns: true if the field described by this desciptor is a Map or Hashtable, otherwise false.
Returns: true if the field described by this descriptor can contain more than one value
Parameters: xmlName the XML name to compare
Returns: true if this descriptor can be used to handle elements or attributes with the given XML name.
Parameters: xmlName the XML name to compare namespace the namespace URI
Returns: true if this descriptor can be used to handle elements or attributes with the given XML name.