org.exolab.castor.mapping.xml

Class BindXml

public class BindXml extends Object implements Serializable

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.

Version: $Revision: 6104 $ $Date: 2006-01-07 15:48:31 -0700 (Sat, 07 Jan 2006) $

Constructor Summary
	BindXml()

Method Summary
void	addProperty(Property vProperty) Method addProperty
void	addProperty(int index, Property vProperty) Method addProperty
void	clearProperty() Method clearProperty
void	deleteReference() Method deleteReference
void	deleteTransient() Method deleteTransient
Enumeration	enumerateProperty() Method enumerateProperty
BindXmlAutoNamingType	getAutoNaming() Returns the value of field 'autoNaming'.
ClassMapping	getClassMapping() Returns the value of field 'classMapping'.
String	getLocation() Returns the value of field 'location'.
String	getMatches() Returns the value of field 'matches'.
String	getName() Returns the value of field 'name'.
BindXmlNodeType	getNode() Returns the value of field 'node'.
Property	getProperty(int index) Method getProperty
Property[]	getProperty() Method getProperty
int	getPropertyCount() Method getPropertyCount
String	getQNamePrefix() Returns the value of field 'QNamePrefix'.
boolean	getReference() Returns the value of field 'reference'.
boolean	getTransient() Returns the value of field 'transient'.
String	getType() Returns the value of field 'type'.
boolean	hasReference() Method hasReference
boolean	hasTransient() Method hasTransient
boolean	isValid() Method isValid
void	marshal(Writer out) Method marshal
void	marshal(ContentHandler handler) Method marshal
boolean	removeProperty(Property vProperty) Method removeProperty
void	setAutoNaming(BindXmlAutoNamingType autoNaming) Sets the value of field 'autoNaming'.
void	setClassMapping(ClassMapping classMapping) Sets the value of field 'classMapping'.
void	setLocation(String location) Sets the value of field 'location'.
void	setMatches(String matches) Sets the value of field 'matches'.
void	setName(String name) Sets the value of field 'name'.
void	setNode(BindXmlNodeType node) Sets the value of field 'node'.
void	setProperty(int index, Property vProperty) Method setProperty
void	setProperty(Property[] propertyArray) Method setProperty
void	setQNamePrefix(String QNamePrefix) Sets the value of field 'QNamePrefix'.
void	setReference(boolean reference) Sets the value of field 'reference'.
void	setTransient(boolean _transient) Sets the value of field 'transient'.
void	setType(String type) Sets the value of field 'type'.
static BindXml	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Method Detail

addProperty

public void addProperty(Property vProperty)

Method addProperty

Parameters: vProperty

addProperty

public void addProperty(int index, Property vProperty)

Method addProperty

Parameters: index vProperty

clearProperty

public void clearProperty()

Method clearProperty

deleteReference

public void deleteReference()

Method deleteReference

deleteTransient

public void deleteTransient()

Method deleteTransient

enumerateProperty

public Enumeration enumerateProperty()

Method enumerateProperty

Returns: Enumeration

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.

Returns: BindXmlAutoNamingType the value of field 'autoNaming'.

getClassMapping

public ClassMapping getClassMapping()

Returns the value of field 'classMapping'.

Returns: ClassMapping the value of field 'classMapping'.

getLocation

public 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 "/".

Returns: String the value of field 'location'.

getMatches

public String getMatches()

Returns the value of field 'matches'.

Returns: String the value of field 'matches'.

getName

public 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.

Returns: String the value of field 'name'.

getNode

public BindXmlNodeType getNode()

Returns the value of field 'node'.

Returns: BindXmlNodeType the value of field 'node'.

getProperty

public Property getProperty(int index)

Method getProperty

Parameters: index

Returns: Property

getProperty

public Property[] getProperty()

Method getProperty

Returns: Property

getPropertyCount

public int getPropertyCount()

Method getPropertyCount

Returns: int

getQNamePrefix

public String getQNamePrefix()

Returns the value of field 'QNamePrefix'.

Returns: String the value of field 'QNamePrefix'.

getReference

public boolean getReference()

Returns the value of field 'reference'.

Returns: boolean the value of field 'reference'.

getTransient

public boolean getTransient()

Returns the value of field 'transient'.

Returns: boolean the value of field 'transient'.

getType

public String getType()

Returns the value of field 'type'.

Returns: String the value of field 'type'.

hasReference

public boolean hasReference()

Method hasReference

Returns: boolean

hasTransient

public boolean hasTransient()

Method hasTransient

Returns: boolean

isValid

public boolean isValid()

Method isValid

Returns: boolean

marshal

public void marshal(Writer out)

Method marshal

Parameters: out

marshal

public void marshal(ContentHandler handler)

Method marshal

Parameters: handler

removeProperty

public boolean removeProperty(Property vProperty)

Method removeProperty

Parameters: vProperty

Returns: boolean

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.

Parameters: autoNaming the value of field 'autoNaming'.

setClassMapping

public void setClassMapping(ClassMapping classMapping)

Sets the value of field 'classMapping'.

Parameters: classMapping the value of field 'classMapping'.

setLocation

public void setLocation(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 "/".

Parameters: location the value of field 'location'.

setMatches

public void setMatches(String matches)

Sets the value of field 'matches'.

Parameters: matches the value of field 'matches'.

setName

public void setName(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.

Parameters: name the value of field 'name'.