The 'bind-xml' element is used for specifying XML specific
databinding
properties and behavior for a specific field. 'bind-xml' may
only appear
as a child of a 'field' element.
addProperty
public void addProperty(int index,
Property vProperty)
throws java.lang.IndexOutOfBoundsException
addProperty
public void addProperty(Property vProperty)
throws java.lang.IndexOutOfBoundsException
deleteReference
public void deleteReference()
deleteTransient
public void deleteTransient()
enumerateProperty
public java.util.Enumeration enumerateProperty()
Method enumerateProperty.
- an Enumeration over all possible elements of this
collection
getAutoNaming
public BindXmlAutoNamingType getAutoNaming()
Returns the value of field 'autoNaming'. The field
'autoNaming' has the following description: Allows
specifying how Castor should automatically determines
the XML name of this field when no name has been specified.
In most cases the XML name is determined by using the field
name,
but in some cases the user may want to use the Class name
of
the field type. This attribute allows choosing between the
two approaches. If this attribute is not specified, the
field
name is used as the XML name.
- the value of field 'AutoNaming'.
getClassMapping
public ClassMapping getClassMapping()
Returns the value of field 'classMapping'.
- the value of field 'ClassMapping'.
getLocation
public java.lang.String getLocation()
Returns the value of field 'location'. The field 'location'
has the following description: Allows specifying a nested
location path for this field,
the value should just be a simplified XPath like value
where names are separated by "/".
- the value of field 'Location'.
getMatches
public java.lang.String getMatches()
Returns the value of field 'matches'.
- the value of field 'Matches'.
getName
public java.lang.String getName()
Returns the value of field 'name'. The field 'name' has the
following description: An optional attribute used for
specifying the XML name for the
field associated with the 'bind-xml' element.
- the value of field 'Name'.
getNode
public BindXmlNodeType getNode()
Returns the value of field 'node'.
- the value of field 'Node'.
getProperty
public Property[] getProperty()
Method getProperty.Returns the contents of the collection in
an Array.
Note: Just in case the collection contents
are changing in another thread, we pass a 0-length Array of
the correct type into the API call. This way we
know
that the Array returned is of exactly the correct length.
- this collection as an Array
getProperty
public Property getProperty(int index)
throws java.lang.IndexOutOfBoundsException
Method getProperty.
- the value of the
org.exolab.castor.mapping.xml.Property at the given index
getPropertyCount
public int getPropertyCount()
Method getPropertyCount.
- the size of this collection
getQNamePrefix
public java.lang.String getQNamePrefix()
Returns the value of field 'QNamePrefix'.
- the value of field 'QNamePrefix'.
getReference
public boolean getReference()
Returns the value of field 'reference'.
- the value of field 'Reference'.
getTransient
public boolean getTransient()
Returns the value of field 'transient'.
- the value of field 'Transient'.
getType
public java.lang.String getType()
Returns the value of field 'type'.
- the value of field 'Type'.
hasReference
public boolean hasReference()
Method hasReference.
- true if at least one Reference has been added
hasTransient
public boolean hasTransient()
Method hasTransient.
- true if at least one Transient has been added
isReference
public boolean isReference()
Returns the value of field 'reference'.
- the value of field 'Reference'.
isTransient
public boolean isTransient()
Returns the value of field 'transient'.
- the value of field 'Transient'.
isValid
public boolean isValid()
Method isValid.
- true if this object is valid according to the schema
iterateProperty
public java.util.Iterator iterateProperty()
Method iterateProperty.
- an Iterator over all possible elements in this
collection
removeAllProperty
public void removeAllProperty()
removeProperty
public boolean removeProperty(Property vProperty)
Method removeProperty.
- true if the object was removed from the collection.
removePropertyAt
public Property removePropertyAt(int index)
Method removePropertyAt.
- the element removed from the collection
setAutoNaming
public void setAutoNaming(BindXmlAutoNamingType autoNaming)
Sets the value of field 'autoNaming'. The field 'autoNaming'
has the following description: Allows specifying how Castor
should automatically determines
the XML name of this field when no name has been specified.
In most cases the XML name is determined by using the field
name,
but in some cases the user may want to use the Class name
of
the field type. This attribute allows choosing between the
two approaches. If this attribute is not specified, the
field
name is used as the XML name.
autoNaming
- the value of field 'autoNaming'.
setClassMapping
public void setClassMapping(ClassMapping classMapping)
Sets the value of field 'classMapping'.
classMapping
- the value of field 'classMapping'.
setLocation
public void setLocation(java.lang.String location)
Sets the value of field 'location'. The field 'location' has
the following description: Allows specifying a nested
location path for this field,
the value should just be a simplified XPath like value
where names are separated by "/".
location
- the value of field 'location'.
setMatches
public void setMatches(java.lang.String matches)
Sets the value of field 'matches'.
matches
- the value of field 'matches'.
setName
public void setName(java.lang.String name)
Sets the value of field 'name'. The field 'name' has the
following description: An optional attribute used for
specifying the XML name for the
field associated with the 'bind-xml' element.
name
- the value of field 'name'.
setNode
public void setNode(BindXmlNodeType node)
Sets the value of field 'node'.
node
- the value of field 'node'.
setProperty
public void setProperty(int index,
Property vProperty)
throws java.lang.IndexOutOfBoundsException
setProperty
public void setProperty(Property[] vPropertyArray)
setQNamePrefix
public void setQNamePrefix(java.lang.String QNamePrefix)
Sets the value of field 'QNamePrefix'.
QNamePrefix
- the value of field 'QNamePrefix'.
setReference
public void setReference(boolean reference)
Sets the value of field 'reference'.
reference
- the value of field 'reference'.
setTransient
public void setTransient(boolean _transient)
Sets the value of field 'transient'.
setType
public void setType(java.lang.String type)
Sets the value of field 'type'.
type
- the value of field 'type'.