org.exolab.castor.mapping.xml

Class ClassMapping

Implemented Interfaces:
java.io.Serializable

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

Class ClassMapping.
Version:
$Revision: 7227 $ $Date$
See Also:
Serialized Form

Constructor Summary

ClassMapping()

Method Summary

void
addIdentity(int index, java.lang.String vIdentity)
void
addIdentity(java.lang.String vIdentity)
void
addNamedQuery(int index, NamedQuery vNamedQuery)
void
addNamedQuery(NamedQuery vNamedQuery)
void
deleteAutoComplete()
void
deleteVerifyConstructable()
java.util.Enumeration
enumerateIdentity()
Method enumerateIdentity.
java.util.Enumeration
enumerateNamedQuery()
Method enumerateNamedQuery.
ClassMappingAccessType
getAccess()
Returns the value of field 'access'.
boolean
getAutoComplete()
Returns the value of field 'autoComplete'.
CacheTypeMapping
getCacheTypeMapping()
Returns the value of field 'cacheTypeMapping'.
ClassChoice
getClassChoice()
Returns the value of field 'classChoice'.
java.lang.Object
getDepends()
Returns the value of field 'depends'.
java.lang.String
getDescription()
Returns the value of field 'description'.
java.lang.Object
getExtends()
Returns the value of field 'extends'.
java.lang.String[]
getIdentity()
Method getIdentity.Returns the contents of the collection in an Array.
java.lang.String
getIdentity(int index)
Method getIdentity.
int
getIdentityCount()
Method getIdentityCount.
java.lang.String
getKeyGenerator()
Returns the value of field 'keyGenerator'.
MapTo
getMapTo()
Returns the value of field 'mapTo'.
java.lang.String
getName()
Returns the value of field 'name'.
NamedQuery[]
getNamedQuery()
Method getNamedQuery.Returns the contents of the collection in an Array.
NamedQuery
getNamedQuery(int index)
Method getNamedQuery.
int
getNamedQueryCount()
Method getNamedQueryCount.
boolean
getVerifyConstructable()
Returns the value of field 'verifyConstructable'.
boolean
hasAutoComplete()
Method hasAutoComplete.
boolean
hasVerifyConstructable()
Method hasVerifyConstructable.
boolean
isAutoComplete()
Returns the value of field 'autoComplete'.
boolean
isValid()
Method isValid.
boolean
isVerifyConstructable()
Returns the value of field 'verifyConstructable'.
java.util.Iterator
iterateIdentity()
Method iterateIdentity.
java.util.Iterator
iterateNamedQuery()
Method iterateNamedQuery.
void
marshal(java.io.Writer out)
void
marshal(org.xml.sax.ContentHandler handler)
void
removeAllIdentity()
void
removeAllNamedQuery()
boolean
removeIdentity(java.lang.String vIdentity)
Method removeIdentity.
java.lang.String
removeIdentityAt(int index)
Method removeIdentityAt.
boolean
removeNamedQuery(NamedQuery vNamedQuery)
Method removeNamedQuery.
NamedQuery
removeNamedQueryAt(int index)
Method removeNamedQueryAt.
void
setAccess(ClassMappingAccessType access)
Sets the value of field 'access'.
void
setAutoComplete(boolean autoComplete)
Sets the value of field 'autoComplete'.
void
setCacheTypeMapping(CacheTypeMapping cacheTypeMapping)
Sets the value of field 'cacheTypeMapping'.
void
setClassChoice(ClassChoice classChoice)
Sets the value of field 'classChoice'.
void
setDepends(java.lang.Object depends)
Sets the value of field 'depends'.
void
setDescription(java.lang.String description)
Sets the value of field 'description'.
void
setExtends(java.lang.Object _extends)
Sets the value of field 'extends'.
void
setIdentity(int index, java.lang.String vIdentity)
void
setIdentity(java.lang.String[] vIdentityArray)
void
setKeyGenerator(java.lang.String keyGenerator)
Sets the value of field 'keyGenerator'.
void
setMapTo(MapTo mapTo)
Sets the value of field 'mapTo'.
void
setName(java.lang.String name)
Sets the value of field 'name'.
void
setNamedQuery(int index, NamedQuery vNamedQuery)
void
setNamedQuery(NamedQuery[] vNamedQueryArray)
void
setVerifyConstructable(boolean verifyConstructable)
Sets the value of field 'verifyConstructable'.
static ClassMapping
unmarshal(java.io.Reader reader)
Method unmarshal.
void
validate()

Constructor Details

ClassMapping

public ClassMapping()

Method Details

addIdentity

public void addIdentity(int index,
                        java.lang.String vIdentity)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vIdentity -

addIdentity

public void addIdentity(java.lang.String vIdentity)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vIdentity -

addNamedQuery

public void addNamedQuery(int index,
                          NamedQuery vNamedQuery)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vNamedQuery -

addNamedQuery

public void addNamedQuery(NamedQuery vNamedQuery)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vNamedQuery -

deleteAutoComplete

public void deleteAutoComplete()

deleteVerifyConstructable

public void deleteVerifyConstructable()

enumerateIdentity

public java.util.Enumeration enumerateIdentity()
Method enumerateIdentity.
Returns:
an Enumeration over all possible elements of this collection

enumerateNamedQuery

public java.util.Enumeration enumerateNamedQuery()
Method enumerateNamedQuery.
Returns:
an Enumeration over all possible elements of this collection

getAccess

public ClassMappingAccessType getAccess()
Returns the value of field 'access'.
Returns:
the value of field 'Access'.

getAutoComplete

public boolean getAutoComplete()
Returns the value of field 'autoComplete'.
Returns:
the value of field 'AutoComplete'.

getCacheTypeMapping

public CacheTypeMapping getCacheTypeMapping()
Returns the value of field 'cacheTypeMapping'.
Returns:
the value of field 'CacheTypeMapping'.

getClassChoice

public ClassChoice getClassChoice()
Returns the value of field 'classChoice'.
Returns:
the value of field 'ClassChoice'.

getDepends

public java.lang.Object getDepends()
Returns the value of field 'depends'.
Returns:
the value of field 'Depends'.

getDescription

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

getExtends

public java.lang.Object getExtends()
Returns the value of field 'extends'.
Returns:
the value of field 'Extends'.

getIdentity

public java.lang.String[] getIdentity()
Method getIdentity.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

getIdentity

public java.lang.String getIdentity(int index)
            throws java.lang.IndexOutOfBoundsException
Method getIdentity.
Parameters:
index -
Returns:
the value of the java.lang.String at the given index

getIdentityCount

public int getIdentityCount()
Method getIdentityCount.
Returns:
the size of this collection

getKeyGenerator

public java.lang.String getKeyGenerator()
Returns the value of field 'keyGenerator'.
Returns:
the value of field 'KeyGenerator'.

getMapTo

public MapTo getMapTo()
Returns the value of field 'mapTo'.
Returns:
the value of field 'MapTo'.

getName

public java.lang.String getName()
Returns the value of field 'name'.
Returns:
the value of field 'Name'.

getNamedQuery

public NamedQuery[] getNamedQuery()
Method getNamedQuery.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

getNamedQuery

public NamedQuery getNamedQuery(int index)
            throws java.lang.IndexOutOfBoundsException
Method getNamedQuery.
Parameters:
index -
Returns:
the value of the org.exolab.castor.mapping.xml.NamedQuery at the given index

getNamedQueryCount

public int getNamedQueryCount()
Method getNamedQueryCount.
Returns:
the size of this collection

getVerifyConstructable

public boolean getVerifyConstructable()
Returns the value of field 'verifyConstructable'.
Returns:
the value of field 'VerifyConstructable'.

hasAutoComplete

public boolean hasAutoComplete()
Method hasAutoComplete.
Returns:
true if at least one AutoComplete has been added

hasVerifyConstructable

public boolean hasVerifyConstructable()
Method hasVerifyConstructable.
Returns:
true if at least one VerifyConstructable has been added

isAutoComplete

public boolean isAutoComplete()
Returns the value of field 'autoComplete'.
Returns:
the value of field 'AutoComplete'.

isValid

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

isVerifyConstructable

public boolean isVerifyConstructable()
Returns the value of field 'verifyConstructable'.
Returns:
the value of field 'VerifyConstructable'.

iterateIdentity

public java.util.Iterator iterateIdentity()
Method iterateIdentity.
Returns:
an Iterator over all possible elements in this collection

iterateNamedQuery

public java.util.Iterator iterateNamedQuery()
Method iterateNamedQuery.
Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
            throws java.io.IOException,
                   MarshalException,
                   ValidationException
Parameters:
handler -
Throws:
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

removeAllIdentity

public void removeAllIdentity()

removeAllNamedQuery

public void removeAllNamedQuery()

removeIdentity

public boolean removeIdentity(java.lang.String vIdentity)
Method removeIdentity.
Parameters:
vIdentity -
Returns:
true if the object was removed from the collection.

removeIdentityAt

public java.lang.String removeIdentityAt(int index)
Method removeIdentityAt.
Parameters:
index -
Returns:
the element removed from the collection

removeNamedQuery

public boolean removeNamedQuery(NamedQuery vNamedQuery)
Method removeNamedQuery.
Parameters:
vNamedQuery -
Returns:
true if the object was removed from the collection.

removeNamedQueryAt

public NamedQuery removeNamedQueryAt(int index)
Method removeNamedQueryAt.
Parameters:
index -
Returns:
the element removed from the collection

setAccess

public void setAccess(ClassMappingAccessType access)
Sets the value of field 'access'.
Parameters:
access - the value of field 'access'.

setAutoComplete

public void setAutoComplete(boolean autoComplete)
Sets the value of field 'autoComplete'.
Parameters:
autoComplete - the value of field 'autoComplete'.

setCacheTypeMapping

public void setCacheTypeMapping(CacheTypeMapping cacheTypeMapping)
Sets the value of field 'cacheTypeMapping'.
Parameters:
cacheTypeMapping - the value of field 'cacheTypeMapping'

setClassChoice

public void setClassChoice(ClassChoice classChoice)
Sets the value of field 'classChoice'.
Parameters:
classChoice - the value of field 'classChoice'.

setDepends

public void setDepends(java.lang.Object depends)
Sets the value of field 'depends'.
Parameters:
depends - the value of field 'depends'.

setDescription

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

setExtends

public void setExtends(java.lang.Object _extends)
Sets the value of field 'extends'.
Parameters:
_extends -

setIdentity

public void setIdentity(int index,
                        java.lang.String vIdentity)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vIdentity -

setIdentity

public void setIdentity(java.lang.String[] vIdentityArray)
Parameters:
vIdentityArray -

setKeyGenerator

public void setKeyGenerator(java.lang.String keyGenerator)
Sets the value of field 'keyGenerator'.
Parameters:
keyGenerator - the value of field 'keyGenerator'.

setMapTo

public void setMapTo(MapTo mapTo)
Sets the value of field 'mapTo'.
Parameters:
mapTo - the value of field 'mapTo'.

setName

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

setNamedQuery

public void setNamedQuery(int index,
                          NamedQuery vNamedQuery)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vNamedQuery -

setNamedQuery

public void setNamedQuery(NamedQuery[] vNamedQueryArray)
Parameters:
vNamedQueryArray -

setVerifyConstructable

public void setVerifyConstructable(boolean verifyConstructable)
Sets the value of field 'verifyConstructable'.
Parameters:
verifyConstructable - the value of field 'verifyConstructable'.

unmarshal

public static ClassMapping unmarshal(java.io.Reader reader)
            throws MarshalException,
                   ValidationException
Method unmarshal.
Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.mapping.xml.ClassMapping
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

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