org.exolab.castor.mapping.xml

Class BindXml

Implemented Interfaces:
java.io.Serializable

public class BindXml
extends java.lang.Object
implements java.io.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) $
See Also:
Serialized Form

Constructor Summary

BindXml()

Method Summary

void
addProperty(int index, Property vProperty)
Method addProperty
void
addProperty(Property vProperty)
Method addProperty
void
clearProperty()
Method clearProperty
void
deleteReference()
Method deleteReference
void
deleteTransient()
Method deleteTransient
java.util.Enumeration
enumerateProperty()
Method enumerateProperty
BindXmlAutoNamingType
getAutoNaming()
Returns the value of field 'autoNaming'.
ClassMapping
getClassMapping()
Returns the value of field 'classMapping'.
java.lang.String
getLocation()
Returns the value of field 'location'.
java.lang.String
getMatches()
Returns the value of field 'matches'.
java.lang.String
getName()
Returns the value of field 'name'.
BindXmlNodeType
getNode()
Returns the value of field 'node'.
Property[]
getProperty()
Method getProperty
Property
getProperty(int index)
Method getProperty
int
getPropertyCount()
Method getPropertyCount
java.lang.String
getQNamePrefix()
Returns the value of field 'QNamePrefix'.
boolean
getReference()
Returns the value of field 'reference'.
boolean
getTransient()
Returns the value of field 'transient'.
java.lang.String
getType()
Returns the value of field 'type'.
boolean
hasReference()
Method hasReference
boolean
hasTransient()
Method hasTransient
boolean
isValid()
Method isValid
void
marshal(java.io.Writer out)
Method marshal
void
marshal(org.xml.sax.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(java.lang.String location)
Sets the value of field 'location'.
void
setMatches(java.lang.String matches)
Sets the value of field 'matches'.
void
setName(java.lang.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(java.lang.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(java.lang.String type)
Sets the value of field 'type'.
static BindXml
unmarshal(java.io.Reader reader)
Method unmarshal
void
validate()
Method validate

Constructor Details

BindXml

public BindXml()

Method Details

addProperty

public void addProperty(int index,
                        Property vProperty)
            throws java.lang.IndexOutOfBoundsException
Method addProperty
Parameters:
index -
vProperty -

addProperty

public void addProperty(Property vProperty)
            throws java.lang.IndexOutOfBoundsException
Method addProperty
Parameters:
vProperty -

clearProperty

public void clearProperty()
Method clearProperty

deleteReference

public void deleteReference()
Method deleteReference

deleteTransient

public void deleteTransient()
Method deleteTransient

enumerateProperty

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

getClassMapping

public ClassMapping getClassMapping()
Returns the value of field 'classMapping'.
Returns:
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 "/".
Returns:
String

getMatches

public java.lang.String getMatches()
Returns the value of field 'matches'.
Returns:
String

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.
Returns:
String

getNode

public BindXmlNodeType getNode()
Returns the value of field 'node'.
Returns:
BindXmlNodeType

getProperty

public Property[] getProperty()
Method getProperty
Returns:
Property

getProperty

public Property getProperty(int index)
            throws java.lang.IndexOutOfBoundsException
Method getProperty
Parameters:
index -
Returns:
Property

getPropertyCount

public int getPropertyCount()
Method getPropertyCount
Returns:
int

getQNamePrefix

public java.lang.String getQNamePrefix()
Returns the value of field 'QNamePrefix'.
Returns:
String

getReference

public boolean getReference()
Returns the value of field 'reference'.
Returns:
boolean

getTransient

public boolean getTransient()
Returns the value of field 'transient'.
Returns:
boolean

getType

public java.lang.String getType()
Returns the value of field 'type'.
Returns:
String

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(java.io.Writer out)
            throws MarshalException,
                   ValidationException
Method marshal
Parameters:
out -

marshal

public void marshal(org.xml.sax.ContentHandler handler)
            throws java.io.IOException,
                   MarshalException,
                   ValidationException
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(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 "/".
Parameters:
location - the value of field 'location'.

setMatches

public void setMatches(java.lang.String matches)
Sets the value of field 'matches'.
Parameters:
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.
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)
            throws java.lang.IndexOutOfBoundsException
Method setProperty
Parameters:
index -
vProperty -

setProperty

public void setProperty(Property[] propertyArray)
Method setProperty
Parameters:
propertyArray -

setQNamePrefix

public void setQNamePrefix(java.lang.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 -

setType

public void setType(java.lang.String type)
Sets the value of field 'type'.
Parameters:
type - the value of field 'type'.

unmarshal

public static BindXml unmarshal(java.io.Reader reader)
            throws MarshalException,
                   ValidationException
Method unmarshal
Parameters:
reader -
Returns:
BindXml

validate

public void validate()
            throws ValidationException
Method validate

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