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
voidaddProperty(Property vProperty)
Method addProperty
voidaddProperty(int index, Property vProperty)
Method addProperty
voidclearProperty()
Method clearProperty
voiddeleteReference()
Method deleteReference
voiddeleteTransient()
Method deleteTransient
EnumerationenumerateProperty()
Method enumerateProperty
BindXmlAutoNamingTypegetAutoNaming()
Returns the value of field 'autoNaming'.
ClassMappinggetClassMapping()
Returns the value of field 'classMapping'.
StringgetLocation()
Returns the value of field 'location'.
StringgetMatches()
Returns the value of field 'matches'.
StringgetName()
Returns the value of field 'name'.
BindXmlNodeTypegetNode()
Returns the value of field 'node'.
PropertygetProperty(int index)
Method getProperty
Property[]getProperty()
Method getProperty
intgetPropertyCount()
Method getPropertyCount
StringgetQNamePrefix()
Returns the value of field 'QNamePrefix'.
booleangetReference()
Returns the value of field 'reference'.
booleangetTransient()
Returns the value of field 'transient'.
StringgetType()
Returns the value of field 'type'.
booleanhasReference()
Method hasReference
booleanhasTransient()
Method hasTransient
booleanisValid()
Method isValid
voidmarshal(Writer out)
Method marshal
voidmarshal(ContentHandler handler)
Method marshal
booleanremoveProperty(Property vProperty)
Method removeProperty
voidsetAutoNaming(BindXmlAutoNamingType autoNaming)
Sets the value of field 'autoNaming'.
voidsetClassMapping(ClassMapping classMapping)
Sets the value of field 'classMapping'.
voidsetLocation(String location)
Sets the value of field 'location'.
voidsetMatches(String matches)
Sets the value of field 'matches'.
voidsetName(String name)
Sets the value of field 'name'.
voidsetNode(BindXmlNodeType node)
Sets the value of field 'node'.
voidsetProperty(int index, Property vProperty)
Method setProperty
voidsetProperty(Property[] propertyArray)
Method setProperty
voidsetQNamePrefix(String QNamePrefix)
Sets the value of field 'QNamePrefix'.
voidsetReference(boolean reference)
Sets the value of field 'reference'.
voidsetTransient(boolean _transient)
Sets the value of field 'transient'.
voidsetType(String type)
Sets the value of field 'type'.
static BindXmlunmarshal(Reader reader)
Method unmarshal
voidvalidate()
Method validate

Constructor Detail

BindXml

public BindXml()

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

setNode

public void setNode(BindXmlNodeType node)
Sets the value of field 'node'.

Parameters: node the value of field 'node'.

setProperty

public void setProperty(int index, Property vProperty)
Method setProperty

Parameters: index vProperty

setProperty

public void setProperty(Property[] propertyArray)
Method setProperty

Parameters: propertyArray

setQNamePrefix

public void setQNamePrefix(String QNamePrefix)
Sets the value of field 'QNamePrefix'.

Parameters: QNamePrefix the value of field 'QNamePrefix'.

setReference

public void setReference(boolean reference)
Sets the value of field 'reference'.

Parameters: reference the value of field 'reference'.

setTransient

public void setTransient(boolean _transient)
Sets the value of field 'transient'.

Parameters: _transient transient the value of field 'transient'.

setType

public void setType(String type)
Sets the value of field 'type'.

Parameters: type the value of field 'type'.

unmarshal

public static BindXml unmarshal(Reader reader)
Method unmarshal

Parameters: reader

Returns: BindXml

validate

public void validate()
Method validate
Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com