Class ComponentBindingType

java.lang.Object
org.exolab.castor.builder.binding.xml.ComponentBindingType
All Implemented Interfaces:
Serializable

public class ComponentBindingType extends Object implements Serializable
A binding element is defined to express the binding between an XML Schema Component and Java class OR a java interface or a java member class. The XML Schema component can be an element, an attribute, a complexType or a group. Attribute cannot be mapped to class, the reader of a binding file will take care that class or interface are not used for component whose xml-type is attribute.
Version:
$Revision$ $Date$
See Also:
  • Constructor Details

    • ComponentBindingType

      public ComponentBindingType()
  • Method Details

    • addAttributeBinding

      public void addAttributeBinding(ComponentBindingType vAttributeBinding) throws IndexOutOfBoundsException
      Parameters:
      vAttributeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addAttributeBinding

      public void addAttributeBinding(int index, ComponentBindingType vAttributeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vAttributeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addComplexTypeBinding

      public void addComplexTypeBinding(ComponentBindingType vComplexTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      vComplexTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addComplexTypeBinding

      public void addComplexTypeBinding(int index, ComponentBindingType vComplexTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vComplexTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addComponentBinding

      public void addComponentBinding(ComponentBindingType vComponentBinding) throws IndexOutOfBoundsException
      Parameters:
      vComponentBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addComponentBinding

      public void addComponentBinding(int index, ComponentBindingType vComponentBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vComponentBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addElementBinding

      public void addElementBinding(ComponentBindingType vElementBinding) throws IndexOutOfBoundsException
      Parameters:
      vElementBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addElementBinding

      public void addElementBinding(int index, ComponentBindingType vElementBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vElementBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addEnumBinding

      public void addEnumBinding(ComponentBindingType vEnumBinding) throws IndexOutOfBoundsException
      Parameters:
      vEnumBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addEnumBinding

      public void addEnumBinding(int index, ComponentBindingType vEnumBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vEnumBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addGroupBinding

      public void addGroupBinding(ComponentBindingType vGroupBinding) throws IndexOutOfBoundsException
      Parameters:
      vGroupBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addGroupBinding

      public void addGroupBinding(int index, ComponentBindingType vGroupBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vGroupBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addSimpleTypeBinding

      public void addSimpleTypeBinding(ComponentBindingType vSimpleTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      vSimpleTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addSimpleTypeBinding

      public void addSimpleTypeBinding(int index, ComponentBindingType vSimpleTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vSimpleTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • enumerateAttributeBinding

      public Enumeration enumerateAttributeBinding()
      Method enumerateAttributeBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateComplexTypeBinding

      public Enumeration enumerateComplexTypeBinding()
      Method enumerateComplexTypeBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateComponentBinding

      public Enumeration enumerateComponentBinding()
      Method enumerateComponentBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateElementBinding

      public Enumeration enumerateElementBinding()
      Method enumerateElementBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateEnumBinding

      public Enumeration enumerateEnumBinding()
      Method enumerateEnumBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateGroupBinding

      public Enumeration enumerateGroupBinding()
      Method enumerateGroupBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • enumerateSimpleTypeBinding

      public Enumeration enumerateSimpleTypeBinding()
      Method enumerateSimpleTypeBinding.
      Returns:
      an Enumeration over all possible elements of this collection
    • getAttributeBinding

      public ComponentBindingType getAttributeBinding(int index) throws IndexOutOfBoundsException
      Method getAttributeBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getAttributeBinding

      public ComponentBindingType[] getAttributeBinding()
      Method getAttributeBinding.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.

      Returns:
      this collection as an Array
    • getAttributeBindingCount

      public int getAttributeBindingCount()
      Method getAttributeBindingCount.
      Returns:
      the size of this collection
    • getComplexTypeBinding

      public ComponentBindingType getComplexTypeBinding(int index) throws IndexOutOfBoundsException
      Method getComplexTypeBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getComplexTypeBinding

      public ComponentBindingType[] getComplexTypeBinding()
      Method getComplexTypeBinding.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.

      Returns:
      this collection as an Array
    • getComplexTypeBindingCount

      public int getComplexTypeBindingCount()
      Method getComplexTypeBindingCount.
      Returns:
      the size of this collection
    • getComponentBinding

      public ComponentBindingType getComponentBinding(int index) throws IndexOutOfBoundsException
      Method getComponentBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getComponentBinding

      public ComponentBindingType[] getComponentBinding()
      Method getComponentBinding.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.

      Returns:
      this collection as an Array
    • getComponentBindingCount

      public int getComponentBindingCount()
      Method getComponentBindingCount.
      Returns:
      the size of this collection
    • getComponentBindingTypeChoice

      public ComponentBindingTypeChoice getComponentBindingTypeChoice()
      Returns the value of field 'componentBindingTypeChoice'.
      Returns:
      the value of field 'ComponentBindingTypeChoice'.
    • getElementBinding

      public ComponentBindingType getElementBinding(int index) throws IndexOutOfBoundsException
      Method getElementBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getElementBinding

      public ComponentBindingType[] getElementBinding()
      Method getElementBinding.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.

      Returns:
      this collection as an Array
    • getElementBindingCount

      public int getElementBindingCount()
      Method getElementBindingCount.
      Returns:
      the size of this collection
    • getEnumBinding

      public ComponentBindingType getEnumBinding(int index) throws IndexOutOfBoundsException
      Method getEnumBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getEnumBinding

      public ComponentBindingType[] getEnumBinding()
      Method getEnumBinding.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.

      Returns:
      this collection as an Array
    • getEnumBindingCount

      public int getEnumBindingCount()
      Method getEnumBindingCount.
      Returns:
      the size of this collection
    • getGroupBinding

      public ComponentBindingType getGroupBinding(int index) throws IndexOutOfBoundsException
      Method getGroupBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getGroupBinding

      public ComponentBindingType[] getGroupBinding()
      Method getGroupBinding.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.

      Returns:
      this collection as an Array
    • getGroupBindingCount

      public int getGroupBindingCount()
      Method getGroupBindingCount.
      Returns:
      the size of this collection
    • getName

      public String getName()
      Returns the value of field 'name'.
      Returns:
      the value of field 'Name'.
    • getSimpleTypeBinding

      public ComponentBindingType getSimpleTypeBinding(int index) throws IndexOutOfBoundsException
      Method getSimpleTypeBinding.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.builder.binding.xml.ComponentBindingType at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getSimpleTypeBinding

      public ComponentBindingType[] getSimpleTypeBinding()
      Method getSimpleTypeBinding.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.

      Returns:
      this collection as an Array
    • getSimpleTypeBindingCount

      public int getSimpleTypeBindingCount()
      Method getSimpleTypeBindingCount.
      Returns:
      the size of this collection
    • isValid

      public boolean isValid()
      Method isValid.
      Returns:
      true if this object is valid according to the schema
    • iterateAttributeBinding

      public Iterator iterateAttributeBinding()
      Method iterateAttributeBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateComplexTypeBinding

      public Iterator iterateComplexTypeBinding()
      Method iterateComplexTypeBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateComponentBinding

      public Iterator iterateComponentBinding()
      Method iterateComponentBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateElementBinding

      public Iterator iterateElementBinding()
      Method iterateElementBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateEnumBinding

      public Iterator iterateEnumBinding()
      Method iterateEnumBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateGroupBinding

      public Iterator iterateGroupBinding()
      Method iterateGroupBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • iterateSimpleTypeBinding

      public Iterator iterateSimpleTypeBinding()
      Method iterateSimpleTypeBinding.
      Returns:
      an Iterator over all possible elements in this collection
    • marshal

      public void marshal(Writer out) throws MarshalException, ValidationException
      Parameters:
      out -
      Throws:
      MarshalException - if object is null or if any SAXException is thrown during marshaling
      ValidationException - if this object is an invalid instance according to the schema
    • marshal

      public void marshal(ContentHandler handler) throws IOException, MarshalException, ValidationException
      Parameters:
      handler -
      Throws:
      IOException - if an IOException occurs during marshaling
      ValidationException - if this object is an invalid instance according to the schema
      MarshalException - if object is null or if any SAXException is thrown during marshaling
    • removeAllAttributeBinding

      public void removeAllAttributeBinding()
    • removeAllComplexTypeBinding

      public void removeAllComplexTypeBinding()
    • removeAllComponentBinding

      public void removeAllComponentBinding()
    • removeAllElementBinding

      public void removeAllElementBinding()
    • removeAllEnumBinding

      public void removeAllEnumBinding()
    • removeAllGroupBinding

      public void removeAllGroupBinding()
    • removeAllSimpleTypeBinding

      public void removeAllSimpleTypeBinding()
    • removeAttributeBinding

      public boolean removeAttributeBinding(ComponentBindingType vAttributeBinding)
      Method removeAttributeBinding.
      Parameters:
      vAttributeBinding -
      Returns:
      true if the object was removed from the collection.
    • removeAttributeBindingAt

      public ComponentBindingType removeAttributeBindingAt(int index)
      Method removeAttributeBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeComplexTypeBinding

      public boolean removeComplexTypeBinding(ComponentBindingType vComplexTypeBinding)
      Method removeComplexTypeBinding.
      Parameters:
      vComplexTypeBinding -
      Returns:
      true if the object was removed from the collection.
    • removeComplexTypeBindingAt

      public ComponentBindingType removeComplexTypeBindingAt(int index)
      Method removeComplexTypeBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeComponentBinding

      public boolean removeComponentBinding(ComponentBindingType vComponentBinding)
      Method removeComponentBinding.
      Parameters:
      vComponentBinding -
      Returns:
      true if the object was removed from the collection.
    • removeComponentBindingAt

      public ComponentBindingType removeComponentBindingAt(int index)
      Method removeComponentBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeElementBinding

      public boolean removeElementBinding(ComponentBindingType vElementBinding)
      Method removeElementBinding.
      Parameters:
      vElementBinding -
      Returns:
      true if the object was removed from the collection.
    • removeElementBindingAt

      public ComponentBindingType removeElementBindingAt(int index)
      Method removeElementBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeEnumBinding

      public boolean removeEnumBinding(ComponentBindingType vEnumBinding)
      Method removeEnumBinding.
      Parameters:
      vEnumBinding -
      Returns:
      true if the object was removed from the collection.
    • removeEnumBindingAt

      public ComponentBindingType removeEnumBindingAt(int index)
      Method removeEnumBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeGroupBinding

      public boolean removeGroupBinding(ComponentBindingType vGroupBinding)
      Method removeGroupBinding.
      Parameters:
      vGroupBinding -
      Returns:
      true if the object was removed from the collection.
    • removeGroupBindingAt

      public ComponentBindingType removeGroupBindingAt(int index)
      Method removeGroupBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • removeSimpleTypeBinding

      public boolean removeSimpleTypeBinding(ComponentBindingType vSimpleTypeBinding)
      Method removeSimpleTypeBinding.
      Parameters:
      vSimpleTypeBinding -
      Returns:
      true if the object was removed from the collection.
    • removeSimpleTypeBindingAt

      public ComponentBindingType removeSimpleTypeBindingAt(int index)
      Method removeSimpleTypeBindingAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • setAttributeBinding

      public void setAttributeBinding(int index, ComponentBindingType vAttributeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vAttributeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setAttributeBinding

      public void setAttributeBinding(ComponentBindingType[] vAttributeBindingArray)
      Parameters:
      vAttributeBindingArray -
    • setComplexTypeBinding

      public void setComplexTypeBinding(int index, ComponentBindingType vComplexTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vComplexTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setComplexTypeBinding

      public void setComplexTypeBinding(ComponentBindingType[] vComplexTypeBindingArray)
      Parameters:
      vComplexTypeBindingArray -
    • setComponentBinding

      public void setComponentBinding(int index, ComponentBindingType vComponentBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vComponentBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setComponentBinding

      public void setComponentBinding(ComponentBindingType[] vComponentBindingArray)
      Parameters:
      vComponentBindingArray -
    • setComponentBindingTypeChoice

      public void setComponentBindingTypeChoice(ComponentBindingTypeChoice componentBindingTypeChoice)
      Sets the value of field 'componentBindingTypeChoice'.
      Parameters:
      componentBindingTypeChoice - the value of field 'componentBindingTypeChoice'.
    • setElementBinding

      public void setElementBinding(int index, ComponentBindingType vElementBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vElementBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setElementBinding

      public void setElementBinding(ComponentBindingType[] vElementBindingArray)
      Parameters:
      vElementBindingArray -
    • setEnumBinding

      public void setEnumBinding(int index, ComponentBindingType vEnumBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vEnumBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setEnumBinding

      public void setEnumBinding(ComponentBindingType[] vEnumBindingArray)
      Parameters:
      vEnumBindingArray -
    • setGroupBinding

      public void setGroupBinding(int index, ComponentBindingType vGroupBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vGroupBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setGroupBinding

      public void setGroupBinding(ComponentBindingType[] vGroupBindingArray)
      Parameters:
      vGroupBindingArray -
    • setName

      public void setName(String name)
      Sets the value of field 'name'.
      Parameters:
      name - the value of field 'name'.
    • setSimpleTypeBinding

      public void setSimpleTypeBinding(int index, ComponentBindingType vSimpleTypeBinding) throws IndexOutOfBoundsException
      Parameters:
      index -
      vSimpleTypeBinding -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setSimpleTypeBinding

      public void setSimpleTypeBinding(ComponentBindingType[] vSimpleTypeBindingArray)
      Parameters:
      vSimpleTypeBindingArray -
    • unmarshalComponentBindingType

      public static ComponentBindingType unmarshalComponentBindingType(Reader reader) throws MarshalException, ValidationException
      Method unmarshalComponentBindingType.
      Parameters:
      reader -
      Returns:
      the unmarshaled org.exolab.castor.builder.binding.xml.ComponentBindingType
      Throws:
      MarshalException - if object is null or if any SAXException is thrown during marshaling
      ValidationException - if this object is an invalid instance according to the schema
    • validate

      public void validate() throws ValidationException
      Throws:
      ValidationException - if this object is an invalid instance according to the schema