|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
XML field descriptor. Wraps FieldDescriptor
and adds
XML-related information, type conversion, etc.
Field Summary | |
static java.lang.String |
PROPERTY_XML_LANG
The xml:lang property |
static java.lang.String |
PROPERTY_XML_SPACE
The xml:space property |
Method Summary | |
int |
getConstructorArgumentIndex()
Returns the index within the constructor argument array where the value of this field should be. |
java.lang.String |
getLocationPath()
Returns the "relative" XML path for the field being described. |
java.lang.String |
getNameSpacePrefix()
Return the "suggested" namespace prefix to use when marshalling as XML. |
java.lang.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. |
java.lang.String |
getProperty(java.lang.String propertyName)
Returns the value property with the given name or null if no such property exists. |
java.lang.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. |
java.lang.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 |
isNillable()
Returns true if the field described by this descriptor may be nillable. |
boolean |
isReference()
Returns true if the field described by this descriptor is a reference (ie. |
boolean |
matches(java.lang.String xmlName)
Returns true if this descriptor can be used to handle elements or attributes with the given XML name. |
boolean |
matches(java.lang.String xmlName,
java.lang.String namespace)
Returns true if this descriptor can be used to handle elements or attributes with the given XML name. |
Methods inherited from interface org.exolab.castor.mapping.FieldDescriptor |
getClassDescriptor, getContainingClassDescriptor, getFieldName, getFieldType, getHandler, isImmutable, isRequired, isTransient, setContainingClassDescriptor |
Field Detail |
public static final java.lang.String PROPERTY_XML_SPACE
public static final java.lang.String PROPERTY_XML_LANG
Method Detail |
public int getConstructorArgumentIndex()
isConstructorArgument
public java.lang.String getNameSpacePrefix()
public java.lang.String getNameSpaceURI()
public NodeType getNodeType()
public java.lang.String getProperty(java.lang.String propertyName)
propertyName
- the name of the property whose value
should be returned.
public FieldValidator getValidator()
public java.lang.String getXMLName()
public java.lang.String getLocationPath()
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"
public java.lang.String getSchemaType()
public boolean isConstructorArgument()
public boolean isIncremental()
public boolean isMultivalued()
isMultivalued
in interface FieldDescriptor
public boolean isMapped()
public boolean isNillable()
public boolean isReference()
public boolean isContainer()
public boolean matches(java.lang.String xmlName)
xmlName
- the XML name to compare
public boolean matches(java.lang.String xmlName, java.lang.String namespace)
xmlName
- the XML name to comparenamespace
- the namespace URI
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |