Public Member Functions | Static Public Member Functions

org.exolab.castor.mapping.xml.BindXml Class Reference

List of all members.

Public Member Functions

 BindXml ()
void addProperty (Property vProperty) throws java.lang.IndexOutOfBoundsException
void addProperty (int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
void deleteReference ()
void deleteTransient ()
java.util.Enumeration enumerateProperty ()
org.exolab.castor.mapping.xml.types.BindXmlAutoNamingType getAutoNaming ()
org.exolab.castor.mapping.xml.ClassMapping getClassMapping ()
java.lang.String getLocation ()
java.lang.String getMatches ()
java.lang.String getName ()
org.exolab.castor.mapping.xml.types.BindXmlNodeType getNode ()
Property getProperty (int index) throws java.lang.IndexOutOfBoundsException
Property[] getProperty ()
int getPropertyCount ()
java.lang.String getQNamePrefix ()
boolean getReference ()
boolean getTransient ()
java.lang.String getType ()
boolean hasReference ()
boolean hasTransient ()
boolean isValid ()
void marshal (java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
void marshal (org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
void removeAllProperty ()
Property removeProperty (int index)
void setAutoNaming (org.exolab.castor.mapping.xml.types.BindXmlAutoNamingType autoNaming)
void setClassMapping (org.exolab.castor.mapping.xml.ClassMapping classMapping)
void setLocation (java.lang.String location)
void setMatches (java.lang.String matches)
void setName (java.lang.String name)
void setNode (org.exolab.castor.mapping.xml.types.BindXmlNodeType node)
void setProperty (int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
void setProperty (Property[] propertyArray)
void setQNamePrefix (java.lang.String QNamePrefix)
void setReference (boolean reference)
void setTransient (boolean _transient)
void setType (java.lang.String type)
void validate () throws org.exolab.castor.xml.ValidationException

Static Public Member Functions

static java.lang.Object unmarshal (java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException

Detailed Description

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:
1.4
Date:
2004/03/08 07:38:34

Constructor & Destructor Documentation

org.exolab.castor.mapping.xml.BindXml.BindXml (  ) 

Member Function Documentation

void org.exolab.castor.mapping.xml.BindXml.addProperty ( Property  vProperty  )  throws java.lang.IndexOutOfBoundsException

Method addProperty

Parameters:
vProperty 

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.addProperty ( int  index,
Property  vProperty 
) throws java.lang.IndexOutOfBoundsException

Method addProperty

Parameters:
index 
vProperty 
void org.exolab.castor.mapping.xml.BindXml.deleteReference (  ) 

Method deleteReference

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.deleteTransient (  ) 

Method deleteTransient

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

java.util.Enumeration org.exolab.castor.mapping.xml.BindXml.enumerateProperty (  ) 

Method enumerateProperty

org.exolab.castor.mapping.xml.types.BindXmlAutoNamingType org.exolab.castor.mapping.xml.BindXml.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:
the value of field 'autoNaming'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

org.exolab.castor.mapping.xml.ClassMapping org.exolab.castor.mapping.xml.BindXml.getClassMapping (  ) 

Returns the value of field 'classMapping'.

Returns:
the value of field 'classMapping'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

java.lang.String org.exolab.castor.mapping.xml.BindXml.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:
the value of field 'location'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

java.lang.String org.exolab.castor.mapping.xml.BindXml.getMatches (  ) 

Returns the value of field 'matches'.

Returns:
the value of field 'matches'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

java.lang.String org.exolab.castor.mapping.xml.BindXml.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:
the value of field 'name'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

org.exolab.castor.mapping.xml.types.BindXmlNodeType org.exolab.castor.mapping.xml.BindXml.getNode (  ) 

Returns the value of field 'node'.

Returns:
the value of field 'node'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

Property org.exolab.castor.mapping.xml.BindXml.getProperty ( int  index  )  throws java.lang.IndexOutOfBoundsException

Method getProperty

Parameters:
index 

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

Property [] org.exolab.castor.mapping.xml.BindXml.getProperty (  ) 

Method getProperty

int org.exolab.castor.mapping.xml.BindXml.getPropertyCount (  ) 

Method getPropertyCount

java.lang.String org.exolab.castor.mapping.xml.BindXml.getQNamePrefix (  ) 

Returns the value of field 'QNamePrefix'.

Returns:
the value of field 'QNamePrefix'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

boolean org.exolab.castor.mapping.xml.BindXml.getReference (  ) 

Returns the value of field 'reference'.

Returns:
the value of field 'reference'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

boolean org.exolab.castor.mapping.xml.BindXml.getTransient (  ) 

Returns the value of field 'transient'.

Returns:
the value of field 'transient'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

java.lang.String org.exolab.castor.mapping.xml.BindXml.getType (  ) 

Returns the value of field 'type'.

Returns:
the value of field 'type'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor(), and org.exolab.castor.xml.XMLMappingLoader.createFieldDesc().

boolean org.exolab.castor.mapping.xml.BindXml.hasReference (  ) 

Method hasReference

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

boolean org.exolab.castor.mapping.xml.BindXml.hasTransient (  ) 

Method hasTransient

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

boolean org.exolab.castor.mapping.xml.BindXml.isValid (  ) 

Method isValid

References org.exolab.castor.mapping.xml.BindXml.validate().

void org.exolab.castor.mapping.xml.BindXml.marshal ( org.xml.sax.ContentHandler  handler  )  throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException

Method marshal

Parameters:
handler 
void org.exolab.castor.mapping.xml.BindXml.marshal ( java.io.Writer  out  )  throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException

Method marshal

Parameters:
out 
void org.exolab.castor.mapping.xml.BindXml.removeAllProperty (  ) 

Method removeAllProperty

Property org.exolab.castor.mapping.xml.BindXml.removeProperty ( int  index  ) 

Method removeProperty

Parameters:
index 
void org.exolab.castor.mapping.xml.BindXml.setAutoNaming ( org.exolab.castor.mapping.xml.types.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'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setClassMapping ( org.exolab.castor.mapping.xml.ClassMapping  classMapping  ) 

Sets the value of field 'classMapping'.

Parameters:
classMapping the value of field 'classMapping'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.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'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setMatches ( java.lang.String  matches  ) 

Sets the value of field 'matches'.

Parameters:
matches the value of field 'matches'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.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'.

Referenced by org.exolab.castor.tools.MappingTool.addClass(), and org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setNode ( org.exolab.castor.mapping.xml.types.BindXmlNodeType  node  ) 

Sets the value of field 'node'.

Parameters:
node the value of field 'node'.

Referenced by org.exolab.castor.tools.MappingTool.addClass(), and org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setProperty ( int  index,
Property  vProperty 
) throws java.lang.IndexOutOfBoundsException

Method setProperty

Parameters:
index 
vProperty 
void org.exolab.castor.mapping.xml.BindXml.setProperty ( Property[]  propertyArray  ) 

Method setProperty

Parameters:
propertyArray 
void org.exolab.castor.mapping.xml.BindXml.setQNamePrefix ( java.lang.String  QNamePrefix  ) 

Sets the value of field 'QNamePrefix'.

Parameters:
QNamePrefix the value of field 'QNamePrefix'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setReference ( boolean  reference  ) 

Sets the value of field 'reference'.

Parameters:
reference the value of field 'reference'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setTransient ( boolean  _transient  ) 

Sets the value of field 'transient'.

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

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

void org.exolab.castor.mapping.xml.BindXml.setType ( java.lang.String  type  ) 

Sets the value of field 'type'.

Parameters:
type the value of field 'type'.

Referenced by org.exolab.castor.mapping.xml.BindXmlDescriptor.BindXmlDescriptor().

static java.lang.Object org.exolab.castor.mapping.xml.BindXml.unmarshal ( java.io.Reader  reader  )  throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException [static]

Method unmarshal

Parameters:
reader 
void org.exolab.castor.mapping.xml.BindXml.validate (  )  throws org.exolab.castor.xml.ValidationException

Method validate

Referenced by org.exolab.castor.mapping.xml.BindXml.isValid().

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:46 for ACS-10.0 Java API by  doxygen 1.7.0