org.exolab.castor.mapping.xml
Class MappingRoot

java.lang.Object
  extended by org.exolab.castor.mapping.xml.MappingRoot
All Implemented Interfaces:
java.io.Serializable

public class MappingRoot
extends java.lang.Object
implements java.io.Serializable

Class MappingRoot.

Version:
$Revision: 6104 $ $Date: 2006-01-07 15:48:31 -0700 (Sat, 07 Jan 2006) $
See Also:
Serialized Form

Constructor Summary
MappingRoot()
           
 
Method Summary
 void addClassMapping(ClassMapping vClassMapping)
          Method addClassMapping
 void addClassMapping(int index, ClassMapping vClassMapping)
          Method addClassMapping
 void addInclude(Include vInclude)
          Method addInclude
 void addInclude(int index, Include vInclude)
          Method addInclude
 void addKeyGeneratorDef(int index, KeyGeneratorDef vKeyGeneratorDef)
          Method addKeyGeneratorDef
 void addKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
          Method addKeyGeneratorDef
 void clearClassMapping()
          Method clearClassMapping
 void clearInclude()
          Method clearInclude
 void clearKeyGeneratorDef()
          Method clearKeyGeneratorDef
 java.util.Enumeration enumerateClassMapping()
          Method enumerateClassMapping
 java.util.Enumeration enumerateInclude()
          Method enumerateInclude
 java.util.Enumeration enumerateKeyGeneratorDef()
          Method enumerateKeyGeneratorDef
 ClassMapping[] getClassMapping()
          Method getClassMapping
 ClassMapping getClassMapping(int index)
          Method getClassMapping
 int getClassMappingCount()
          Method getClassMappingCount
 java.lang.String getDescription()
          Returns the value of field 'description'.
 Include[] getInclude()
          Method getInclude
 Include getInclude(int index)
          Method getInclude
 int getIncludeCount()
          Method getIncludeCount
 KeyGeneratorDef[] getKeyGeneratorDef()
          Method getKeyGeneratorDef
 KeyGeneratorDef getKeyGeneratorDef(int index)
          Method getKeyGeneratorDef
 int getKeyGeneratorDefCount()
          Method getKeyGeneratorDefCount
 boolean isValid()
          Method isValid
 void marshal(org.xml.sax.ContentHandler handler)
          Method marshal
 void marshal(java.io.Writer out)
          Method marshal
 boolean removeClassMapping(ClassMapping vClassMapping)
          Method removeClassMapping
 boolean removeInclude(Include vInclude)
          Method removeInclude
 boolean removeKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
          Method removeKeyGeneratorDef
 void setClassMapping(ClassMapping[] classMappingArray)
          Method setClassMapping
 void setClassMapping(int index, ClassMapping vClassMapping)
          Method setClassMapping
 void setDescription(java.lang.String description)
          Sets the value of field 'description'.
 void setInclude(Include[] includeArray)
          Method setInclude
 void setInclude(int index, Include vInclude)
          Method setInclude
 void setKeyGeneratorDef(int index, KeyGeneratorDef vKeyGeneratorDef)
          Method setKeyGeneratorDef
 void setKeyGeneratorDef(KeyGeneratorDef[] keyGeneratorDefArray)
          Method setKeyGeneratorDef
static MappingRoot unmarshal(java.io.Reader reader)
          Method unmarshal
 void validate()
          Method 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 java.lang.IndexOutOfBoundsException
Method addClassMapping

Parameters:
vClassMapping -
Throws:
java.lang.IndexOutOfBoundsException

addClassMapping

public void addClassMapping(int index,
                            ClassMapping vClassMapping)
                     throws java.lang.IndexOutOfBoundsException
Method addClassMapping

Parameters:
index -
vClassMapping -
Throws:
java.lang.IndexOutOfBoundsException

addInclude

public void addInclude(Include vInclude)
                throws java.lang.IndexOutOfBoundsException
Method addInclude

Parameters:
vInclude -
Throws:
java.lang.IndexOutOfBoundsException

addInclude

public void addInclude(int index,
                       Include vInclude)
                throws java.lang.IndexOutOfBoundsException
Method addInclude

Parameters:
index -
vInclude -
Throws:
java.lang.IndexOutOfBoundsException

addKeyGeneratorDef

public void addKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
                        throws java.lang.IndexOutOfBoundsException
Method addKeyGeneratorDef

Parameters:
vKeyGeneratorDef -
Throws:
java.lang.IndexOutOfBoundsException

addKeyGeneratorDef

public void addKeyGeneratorDef(int index,
                               KeyGeneratorDef vKeyGeneratorDef)
                        throws java.lang.IndexOutOfBoundsException
Method addKeyGeneratorDef

Parameters:
index -
vKeyGeneratorDef -
Throws:
java.lang.IndexOutOfBoundsException

clearClassMapping

public void clearClassMapping()
Method clearClassMapping


clearInclude

public void clearInclude()
Method clearInclude


clearKeyGeneratorDef

public void clearKeyGeneratorDef()
Method clearKeyGeneratorDef


enumerateClassMapping

public java.util.Enumeration enumerateClassMapping()
Method enumerateClassMapping

Returns:
Enumeration

enumerateInclude

public java.util.Enumeration enumerateInclude()
Method enumerateInclude

Returns:
Enumeration

enumerateKeyGeneratorDef

public java.util.Enumeration enumerateKeyGeneratorDef()
Method enumerateKeyGeneratorDef

Returns:
Enumeration

getClassMapping

public ClassMapping getClassMapping(int index)
                             throws java.lang.IndexOutOfBoundsException
Method getClassMapping

Parameters:
index -
Returns:
ClassMapping
Throws:
java.lang.IndexOutOfBoundsException

getClassMapping

public ClassMapping[] getClassMapping()
Method getClassMapping

Returns:
ClassMapping

getClassMappingCount

public int getClassMappingCount()
Method getClassMappingCount

Returns:
int

getDescription

public java.lang.String getDescription()
Returns the value of field 'description'.

Returns:
String

getInclude

public Include getInclude(int index)
                   throws java.lang.IndexOutOfBoundsException
Method getInclude

Parameters:
index -
Returns:
Include
Throws:
java.lang.IndexOutOfBoundsException

getInclude

public Include[] getInclude()
Method getInclude

Returns:
Include

getIncludeCount

public int getIncludeCount()
Method getIncludeCount

Returns:
int

getKeyGeneratorDef

public KeyGeneratorDef getKeyGeneratorDef(int index)
                                   throws java.lang.IndexOutOfBoundsException
Method getKeyGeneratorDef

Parameters:
index -
Returns:
KeyGeneratorDef
Throws:
java.lang.IndexOutOfBoundsException

getKeyGeneratorDef

public KeyGeneratorDef[] getKeyGeneratorDef()
Method getKeyGeneratorDef

Returns:
KeyGeneratorDef

getKeyGeneratorDefCount

public int getKeyGeneratorDefCount()
Method getKeyGeneratorDefCount

Returns:
int

isValid

public boolean isValid()
Method isValid

Returns:
boolean

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException
Method marshal

Parameters:
out -
Throws:
MarshalException
ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException
Method marshal

Parameters:
handler -
Throws:
java.io.IOException
MarshalException
ValidationException

removeClassMapping

public boolean removeClassMapping(ClassMapping vClassMapping)
Method removeClassMapping

Parameters:
vClassMapping -
Returns:
boolean

removeInclude

public boolean removeInclude(Include vInclude)
Method removeInclude

Parameters:
vInclude -
Returns:
boolean

removeKeyGeneratorDef

public boolean removeKeyGeneratorDef(KeyGeneratorDef vKeyGeneratorDef)
Method removeKeyGeneratorDef

Parameters:
vKeyGeneratorDef -
Returns:
boolean

setClassMapping

public void setClassMapping(int index,
                            ClassMapping vClassMapping)
                     throws java.lang.IndexOutOfBoundsException
Method setClassMapping

Parameters:
index -
vClassMapping -
Throws:
java.lang.IndexOutOfBoundsException

setClassMapping

public void setClassMapping(ClassMapping[] classMappingArray)
Method setClassMapping

Parameters:
classMappingArray -

setDescription

public void setDescription(java.lang.String description)
Sets the value of field 'description'.

Parameters:
description - the value of field 'description'.

setInclude

public void setInclude(int index,
                       Include vInclude)
                throws java.lang.IndexOutOfBoundsException
Method setInclude

Parameters:
index -
vInclude -
Throws:
java.lang.IndexOutOfBoundsException

setInclude

public void setInclude(Include[] includeArray)
Method setInclude

Parameters:
includeArray -

setKeyGeneratorDef

public void setKeyGeneratorDef(int index,
                               KeyGeneratorDef vKeyGeneratorDef)
                        throws java.lang.IndexOutOfBoundsException
Method setKeyGeneratorDef

Parameters:
index -
vKeyGeneratorDef -
Throws:
java.lang.IndexOutOfBoundsException

setKeyGeneratorDef

public void setKeyGeneratorDef(KeyGeneratorDef[] keyGeneratorDefArray)
Method setKeyGeneratorDef

Parameters:
keyGeneratorDefArray -

unmarshal

public static MappingRoot unmarshal(java.io.Reader reader)
                             throws MarshalException,
                                    ValidationException
Method unmarshal

Parameters:
reader -
Returns:
MappingRoot
Throws:
MarshalException
ValidationException

validate

public void validate()
              throws ValidationException
Method validate

Throws:
ValidationException


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