Class MappingRoot
- All Implemented Interfaces:
Serializable
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addClassMapping
(int index, ClassMapping vClassMapping) void
addClassMapping
(ClassMapping vClassMapping) void
addFieldHandlerDef
(int index, FieldHandlerDef vFieldHandlerDef) void
addFieldHandlerDef
(FieldHandlerDef vFieldHandlerDef) void
addInclude
(int index, Include vInclude) void
addInclude
(Include vInclude) void
addKeyGeneratorDef
(int index, KeyGeneratorDef vKeyGeneratorDef) void
addKeyGeneratorDef
(KeyGeneratorDef vKeyGeneratorDef) Enumeration<? extends ClassMapping>
Method enumerateClassMapping.Enumeration<? extends FieldHandlerDef>
Method enumerateFieldHandlerDef.Enumeration<? extends Include>
Method enumerateInclude.Enumeration<? extends KeyGeneratorDef>
Method enumerateKeyGeneratorDef.Method getClassMapping.Returns the contents of the collection in an Array.getClassMapping
(int index) Method getClassMapping.int
Method getClassMappingCount.Returns the value of field 'description'.Method getFieldHandlerDef.Returns the contents of the collection in an Array.getFieldHandlerDef
(int index) Method getFieldHandlerDef.int
Method getFieldHandlerDefCount.Include[]
Method getInclude.Returns the contents of the collection in an Array.getInclude
(int index) Method getInclude.int
Method getIncludeCount.Method getKeyGeneratorDef.Returns the contents of the collection in an Array.getKeyGeneratorDef
(int index) Method getKeyGeneratorDef.int
Method getKeyGeneratorDefCount.boolean
isValid()
Method isValid.Iterator<? extends ClassMapping>
Method iterateClassMapping.Iterator<? extends FieldHandlerDef>
Method iterateFieldHandlerDef.Method iterateInclude.Iterator<? extends KeyGeneratorDef>
Method iterateKeyGeneratorDef.void
void
marshal
(ContentHandler handler) void
void
void
void
boolean
removeClassMapping
(ClassMapping vClassMapping) Method removeClassMapping.removeClassMappingAt
(int index) Method removeClassMappingAt.boolean
removeFieldHandlerDef
(FieldHandlerDef vFieldHandlerDef) Method removeFieldHandlerDef.removeFieldHandlerDefAt
(int index) Method removeFieldHandlerDefAt.boolean
removeInclude
(Include vInclude) Method removeInclude.removeIncludeAt
(int index) Method removeIncludeAt.boolean
removeKeyGeneratorDef
(KeyGeneratorDef vKeyGeneratorDef) Method removeKeyGeneratorDef.removeKeyGeneratorDefAt
(int index) Method removeKeyGeneratorDefAt.void
setClassMapping
(int index, ClassMapping vClassMapping) void
setClassMapping
(ClassMapping[] vClassMappingArray) void
setDescription
(String description) Sets the value of field 'description'.void
setFieldHandlerDef
(int index, FieldHandlerDef vFieldHandlerDef) void
setFieldHandlerDef
(FieldHandlerDef[] vFieldHandlerDefArray) void
setInclude
(int index, Include vInclude) void
setInclude
(Include[] vIncludeArray) void
setKeyGeneratorDef
(int index, KeyGeneratorDef vKeyGeneratorDef) void
setKeyGeneratorDef
(KeyGeneratorDef[] vKeyGeneratorDefArray) static MappingRoot
Method unmarshal.void
validate()
-
Constructor Details
-
MappingRoot
public MappingRoot()
-
-
Method Details
-
addClassMapping
- Parameters:
vClassMapping
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addClassMapping
- Parameters:
index
-vClassMapping
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addFieldHandlerDef
- 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
- Parameters:
vInclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addInclude
- Parameters:
index
-vInclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addKeyGeneratorDef
- 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
Method enumerateClassMapping.- Returns:
- an Enumeration over all possible elements of this collection
-
enumerateFieldHandlerDef
Method enumerateFieldHandlerDef.- Returns:
- an Enumeration over all possible elements of this collection
-
enumerateInclude
Method enumerateInclude.- Returns:
- an Enumeration over all possible elements of this collection
-
enumerateKeyGeneratorDef
Method enumerateKeyGeneratorDef.- Returns:
- an Enumeration over all possible elements of this collection
-
getClassMapping
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
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
Returns the value of field 'description'.- Returns:
- the value of field 'Description'.
-
getFieldHandlerDef
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
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
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
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
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
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
Method iterateClassMapping.- Returns:
- an Iterator over all possible elements in this collection
-
iterateFieldHandlerDef
Method iterateFieldHandlerDef.- Returns:
- an Iterator over all possible elements in this collection
-
iterateInclude
Method iterateInclude.- Returns:
- an Iterator over all possible elements in this collection
-
iterateKeyGeneratorDef
Method iterateKeyGeneratorDef.- Returns:
- an Iterator over all possible elements in this collection
-
marshal
- Parameters:
out
-- Throws:
MarshalException
- if object is null or if any SAXException is thrown during marshalingValidationException
- 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 marshalingValidationException
- if this object is an invalid instance according to the schemaMarshalException
- 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
Method removeClassMapping.- Parameters:
vClassMapping
-- Returns:
- true if the object was removed from the collection.
-
removeClassMappingAt
Method removeClassMappingAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
removeFieldHandlerDef
Method removeFieldHandlerDef.- Parameters:
vFieldHandlerDef
-- Returns:
- true if the object was removed from the collection.
-
removeFieldHandlerDefAt
Method removeFieldHandlerDefAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
removeInclude
Method removeInclude.- Parameters:
vInclude
-- Returns:
- true if the object was removed from the collection.
-
removeIncludeAt
Method removeIncludeAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
removeKeyGeneratorDef
Method removeKeyGeneratorDef.- Parameters:
vKeyGeneratorDef
-- Returns:
- true if the object was removed from the collection.
-
removeKeyGeneratorDefAt
Method removeKeyGeneratorDefAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
setClassMapping
- Parameters:
index
-vClassMapping
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setClassMapping
- Parameters:
vClassMappingArray
-
-
setDescription
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
- Parameters:
vFieldHandlerDefArray
-
-
setInclude
- Parameters:
index
-vInclude
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setInclude
- 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
- Parameters:
vKeyGeneratorDefArray
-
-
unmarshal
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 marshalingValidationException
- if this object is an invalid instance according to the schema
-
validate
- Throws:
ValidationException
- if this object is an invalid instance according to the schema
-