MappingRoot (Castor 1.3.2 API)

java.lang.Object
- org.exolab.castor.mapping.xml.MappingRoot

All Implemented Interfaces:

Serializable
```
public class MappingRoot
extends Object
implements Serializable
```
Class MappingRoot.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

MappingRoot()

Constructors
Constructor and Description
`MappingRoot()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClassMapping(ClassMapping vClassMapping)`
`void`	`addClassMapping(int index, ClassMapping vClassMapping)`
`void`	`addFieldHandlerDef(FieldHandlerDef vFieldHandlerDef)`
`void`	`addFieldHandlerDef(int index, FieldHandlerDef vFieldHandlerDef)`
`void`	`addInclude(Include vInclude)`
`void`	`addInclude(int index, Include vInclude)`
`void`	`addKeyGeneratorDef(int index, KeyGeneratorDef vKeyGeneratorDef)`
`void`	`addKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)`
`Enumeration<? extends ClassMapping>`	`enumerateClassMapping()` Method enumerateClassMapping.
`Enumeration<? extends FieldHandlerDef>`	`enumerateFieldHandlerDef()` Method enumerateFieldHandlerDef.
`Enumeration<? extends Include>`	`enumerateInclude()` Method enumerateInclude.
`Enumeration<? extends KeyGeneratorDef>`	`enumerateKeyGeneratorDef()` Method enumerateKeyGeneratorDef.
`ClassMapping[]`	`getClassMapping()` Method getClassMapping.Returns the contents of the collection in an Array.
`ClassMapping`	`getClassMapping(int index)` Method getClassMapping.
`int`	`getClassMappingCount()` Method getClassMappingCount.
`String`	`getDescription()` Returns the value of field 'description'.
`FieldHandlerDef[]`	`getFieldHandlerDef()` Method getFieldHandlerDef.Returns the contents of the collection in an Array.
`FieldHandlerDef`	`getFieldHandlerDef(int index)` Method getFieldHandlerDef.
`int`	`getFieldHandlerDefCount()` Method getFieldHandlerDefCount.
`Include[]`	`getInclude()` Method getInclude.Returns the contents of the collection in an Array.
`Include`	`getInclude(int index)` Method getInclude.
`int`	`getIncludeCount()` Method getIncludeCount.
`KeyGeneratorDef[]`	`getKeyGeneratorDef()` Method getKeyGeneratorDef.Returns the contents of the collection in an Array.
`KeyGeneratorDef`	`getKeyGeneratorDef(int index)` Method getKeyGeneratorDef.
`int`	`getKeyGeneratorDefCount()` Method getKeyGeneratorDefCount.
`boolean`	`isValid()` Method isValid.
`Iterator<? extends ClassMapping>`	`iterateClassMapping()` Method iterateClassMapping.
`Iterator<? extends FieldHandlerDef>`	`iterateFieldHandlerDef()` Method iterateFieldHandlerDef.
`Iterator<? extends Include>`	`iterateInclude()` Method iterateInclude.
`Iterator<? extends KeyGeneratorDef>`	`iterateKeyGeneratorDef()` Method iterateKeyGeneratorDef.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllClassMapping()`
`void`	`removeAllFieldHandlerDef()`
`void`	`removeAllInclude()`
`void`	`removeAllKeyGeneratorDef()`
`boolean`	`removeClassMapping(ClassMapping vClassMapping)` Method removeClassMapping.
`ClassMapping`	`removeClassMappingAt(int index)` Method removeClassMappingAt.
`boolean`	`removeFieldHandlerDef(FieldHandlerDef vFieldHandlerDef)` Method removeFieldHandlerDef.
`FieldHandlerDef`	`removeFieldHandlerDefAt(int index)` Method removeFieldHandlerDefAt.
`boolean`	`removeInclude(Include vInclude)` Method removeInclude.
`Include`	`removeIncludeAt(int index)` Method removeIncludeAt.
`boolean`	`removeKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)` Method removeKeyGeneratorDef.
`KeyGeneratorDef`	`removeKeyGeneratorDefAt(int index)` Method removeKeyGeneratorDefAt.
`void`	`setClassMapping(ClassMapping[] vClassMappingArray)`
`void`	`setClassMapping(int index, ClassMapping vClassMapping)`
`void`	`setDescription(String description)` Sets the value of field 'description'.
`void`	`setFieldHandlerDef(FieldHandlerDef[] vFieldHandlerDefArray)`
`void`	`setFieldHandlerDef(int index, FieldHandlerDef vFieldHandlerDef)`
`void`	`setInclude(Include[] vIncludeArray)`
`void`	`setInclude(int index, Include vInclude)`
`void`	`setKeyGeneratorDef(int index, KeyGeneratorDef vKeyGeneratorDef)`
`void`	`setKeyGeneratorDef(KeyGeneratorDef[] vKeyGeneratorDefArray)`
`static MappingRoot`	`unmarshal(Reader reader)` Method unmarshal.
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MappingRoot
```
public MappingRoot()
```
- Method Detail
  - addClassMapping
```
public void addClassMapping(ClassMapping vClassMapping)
                     throws IndexOutOfBoundsException
```
    Parameters:
    vClassMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addClassMapping
```
public void addClassMapping(int index,
                   ClassMapping vClassMapping)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vClassMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addFieldHandlerDef
```
public void addFieldHandlerDef(FieldHandlerDef vFieldHandlerDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    vFieldHandlerDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addFieldHandlerDef
```
public void addFieldHandlerDef(int index,
                      FieldHandlerDef vFieldHandlerDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vFieldHandlerDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addInclude
```
public void addInclude(Include vInclude)
                throws IndexOutOfBoundsException
```
    Parameters:
    vInclude -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addInclude
```
public void addInclude(int index,
              Include vInclude)
                throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vInclude -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addKeyGeneratorDef
```
public void addKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    vKeyGeneratorDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addKeyGeneratorDef
```
public void addKeyGeneratorDef(int index,
                      KeyGeneratorDef vKeyGeneratorDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vKeyGeneratorDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - enumerateClassMapping
```
public Enumeration<? extends ClassMapping> enumerateClassMapping()
```
    Method enumerateClassMapping.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateFieldHandlerDef
```
public Enumeration<? extends FieldHandlerDef> enumerateFieldHandlerDef()
```
    Method enumerateFieldHandlerDef.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateInclude
```
public Enumeration<? extends Include> enumerateInclude()
```
    Method enumerateInclude.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateKeyGeneratorDef
```
public Enumeration<? extends KeyGeneratorDef> enumerateKeyGeneratorDef()
```
    Method enumerateKeyGeneratorDef.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - getClassMapping
```
public ClassMapping getClassMapping(int index)
                             throws IndexOutOfBoundsException
```
    Method getClassMapping.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.exolab.castor.mapping.xml.ClassMapping at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getClassMapping
```
public ClassMapping[] getClassMapping()
```
    Method getClassMapping.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
  - getClassMappingCount
```
public int getClassMappingCount()
```
    Method getClassMappingCount.
    
    Returns:
    the size of this collection
  - getDescription
```
public String getDescription()
```
    Returns the value of field 'description'.
    
    Returns:
    the value of field 'Description'.
  - getFieldHandlerDef
```
public FieldHandlerDef getFieldHandlerDef(int index)
                                   throws IndexOutOfBoundsException
```
    Method getFieldHandlerDef.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.exolab.castor.mapping.xml.FieldHandlerDef at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getFieldHandlerDef
```
public FieldHandlerDef[] getFieldHandlerDef()
```
    Method getFieldHandlerDef.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
  - getFieldHandlerDefCount
```
public int getFieldHandlerDefCount()
```
    Method getFieldHandlerDefCount.
    
    Returns:
    the size of this collection
  - getInclude
```
public Include getInclude(int index)
                   throws IndexOutOfBoundsException
```
    Method getInclude.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.exolab.castor.mapping.xml.Include at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getInclude
```
public Include[] getInclude()
```
    Method getInclude.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
  - getIncludeCount
```
public int getIncludeCount()
```
    Method getIncludeCount.
    
    Returns:
    the size of this collection
  - getKeyGeneratorDef
```
public KeyGeneratorDef getKeyGeneratorDef(int index)
                                   throws IndexOutOfBoundsException
```
    Method getKeyGeneratorDef.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.exolab.castor.mapping.xml.KeyGeneratorDef at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getKeyGeneratorDef
```
public KeyGeneratorDef[] getKeyGeneratorDef()
```
    Method getKeyGeneratorDef.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
  - getKeyGeneratorDefCount
```
public int getKeyGeneratorDefCount()
```
    Method getKeyGeneratorDefCount.
    
    Returns:
    the size of this collection
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    true if this object is valid according to the schema
  - iterateClassMapping
```
public Iterator<? extends ClassMapping> iterateClassMapping()
```
    Method iterateClassMapping.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateFieldHandlerDef
```
public Iterator<? extends FieldHandlerDef> iterateFieldHandlerDef()
```
    Method iterateFieldHandlerDef.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateInclude
```
public Iterator<? extends Include> iterateInclude()
```
    Method iterateInclude.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateKeyGeneratorDef
```
public Iterator<? extends KeyGeneratorDef> iterateKeyGeneratorDef()
```
    Method iterateKeyGeneratorDef.
    
    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
  - removeAllClassMapping
```
public void removeAllClassMapping()
```
  - removeAllFieldHandlerDef
```
public void removeAllFieldHandlerDef()
```
  - removeAllInclude
```
public void removeAllInclude()
```
  - removeAllKeyGeneratorDef
```
public void removeAllKeyGeneratorDef()
```
  - removeClassMapping
```
public boolean removeClassMapping(ClassMapping vClassMapping)
```
    Method removeClassMapping.
    
    Parameters:
    vClassMapping -
    
    Returns:
    true if the object was removed from the collection.
  - removeClassMappingAt
```
public ClassMapping removeClassMappingAt(int index)
```
    Method removeClassMappingAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeFieldHandlerDef
```
public boolean removeFieldHandlerDef(FieldHandlerDef vFieldHandlerDef)
```
    Method removeFieldHandlerDef.
    
    Parameters:
    vFieldHandlerDef -
    
    Returns:
    true if the object was removed from the collection.
  - removeFieldHandlerDefAt
```
public FieldHandlerDef removeFieldHandlerDefAt(int index)
```
    Method removeFieldHandlerDefAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeInclude
```
public boolean removeInclude(Include vInclude)
```
    Method removeInclude.
    
    Parameters:
    vInclude -
    
    Returns:
    true if the object was removed from the collection.
  - removeIncludeAt
```
public Include removeIncludeAt(int index)
```
    Method removeIncludeAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeKeyGeneratorDef
```
public boolean removeKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
```
    Method removeKeyGeneratorDef.
    
    Parameters:
    vKeyGeneratorDef -
    
    Returns:
    true if the object was removed from the collection.
  - removeKeyGeneratorDefAt
```
public KeyGeneratorDef removeKeyGeneratorDefAt(int index)
```
    Method removeKeyGeneratorDefAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - setClassMapping
```
public void setClassMapping(int index,
                   ClassMapping vClassMapping)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vClassMapping -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setClassMapping
```
public void setClassMapping(ClassMapping[] vClassMappingArray)
```
    Parameters:
    vClassMappingArray -
  - setDescription
```
public void setDescription(String description)
```
    Sets the value of field 'description'.
    
    Parameters:
    description - the value of field 'description'.
  - setFieldHandlerDef
```
public void setFieldHandlerDef(int index,
                      FieldHandlerDef vFieldHandlerDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vFieldHandlerDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setFieldHandlerDef
```
public void setFieldHandlerDef(FieldHandlerDef[] vFieldHandlerDefArray)
```
    Parameters:
    vFieldHandlerDefArray -
  - setInclude
```
public void setInclude(int index,
              Include vInclude)
                throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vInclude -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setInclude
```
public void setInclude(Include[] vIncludeArray)
```
    Parameters:
    vIncludeArray -
  - setKeyGeneratorDef
```
public void setKeyGeneratorDef(int index,
                      KeyGeneratorDef vKeyGeneratorDef)
                        throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vKeyGeneratorDef -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setKeyGeneratorDef
```
public void setKeyGeneratorDef(KeyGeneratorDef[] vKeyGeneratorDefArray)
```
    Parameters:
    vKeyGeneratorDefArray -
  - unmarshal
```
public static MappingRoot unmarshal(Reader reader)
                             throws MarshalException,
                                    ValidationException
```
    Method unmarshal.
    
    Parameters:
    reader -
    
    Returns:
    the unmarshaled org.exolab.castor.mapping.xml.MappingRoot
    
    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

Class MappingRoot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappingRoot

Method Detail

addClassMapping

addClassMapping

addFieldHandlerDef

addFieldHandlerDef

addInclude

addInclude

addKeyGeneratorDef

addKeyGeneratorDef

enumerateClassMapping

enumerateFieldHandlerDef

enumerateInclude

enumerateKeyGeneratorDef

getClassMapping

getClassMapping

getClassMappingCount

getDescription

getFieldHandlerDef

getFieldHandlerDef

getFieldHandlerDefCount

getInclude

getInclude

getIncludeCount

getKeyGeneratorDef

getKeyGeneratorDef

getKeyGeneratorDefCount

isValid

iterateClassMapping

iterateFieldHandlerDef

iterateInclude

iterateKeyGeneratorDef

marshal

marshal

removeAllClassMapping

removeAllFieldHandlerDef

removeAllInclude

removeAllKeyGeneratorDef

removeClassMapping

removeClassMappingAt

removeFieldHandlerDef

removeFieldHandlerDefAt

removeInclude

removeIncludeAt

removeKeyGeneratorDef

removeKeyGeneratorDefAt

setClassMapping

setClassMapping

setDescription

setFieldHandlerDef

setFieldHandlerDef

setInclude

setInclude

setKeyGeneratorDef

setKeyGeneratorDef

unmarshal

validate