org.exolab.castor.mapping.xml

Class MapTo

java.lang.Object

org.exolab.castor.mapping.xml.MapTo

All Implemented Interfaces:

Serializable

public class MapTo
extends Object
implements Serializable

The 'map-to' element is used for specifying the name of the item that should be associated with the given Java object.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapTo()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteElementDefinition()
boolean	getElementDefinition() Returns the value of field 'elementDefinition'.
String	getLdapDn() Returns the value of field 'ldapDn'.
String	getLdapOc() Returns the value of field 'ldapOc'.
String	getNsPrefix() Returns the value of field 'nsPrefix'.
String	getNsUri() Returns the value of field 'nsUri'.
String	getTable() Returns the value of field 'table'.
String	getXml() Returns the value of field 'xml'.
boolean	hasElementDefinition() Method hasElementDefinition.
boolean	isElementDefinition() Returns the value of field 'elementDefinition'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setElementDefinition(boolean elementDefinition) Sets the value of field 'elementDefinition'.
void	setLdapDn(String ldapDn) Sets the value of field 'ldapDn'.
void	setLdapOc(String ldapOc) Sets the value of field 'ldapOc'.
void	setNsPrefix(String nsPrefix) Sets the value of field 'nsPrefix'.
void	setNsUri(String nsUri) Sets the value of field 'nsUri'.
void	setTable(String table) Sets the value of field 'table'.
void	setXml(String xml) Sets the value of field 'xml'.
static MapTo	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

MapTo

public MapTo()

Method Detail

deleteElementDefinition

public void deleteElementDefinition()

getElementDefinition

public boolean getElementDefinition()

Returns the value of field 'elementDefinition'.

Returns:

the value of field 'ElementDefinition'.

getLdapDn

public String getLdapDn()

Returns the value of field 'ldapDn'.

Returns:

the value of field 'LdapDn'.

getLdapOc

public String getLdapOc()

Returns the value of field 'ldapOc'.

Returns:

the value of field 'LdapOc'.

getNsPrefix

public String getNsPrefix()

Returns the value of field 'nsPrefix'.

Returns:

the value of field 'NsPrefix'.

getNsUri

public String getNsUri()

Returns the value of field 'nsUri'.

Returns:

the value of field 'NsUri'.

getTable

public String getTable()

Returns the value of field 'table'. The field 'table' has the following description: An optional attribute used to specify the name of the table to which the given Java object is associated.

Returns:

the value of field 'Table'.

getXml

public String getXml()

Returns the value of field 'xml'.

Returns:

the value of field 'Xml'.

hasElementDefinition

public boolean hasElementDefinition()

Method hasElementDefinition.

Returns:

true if at least one ElementDefinition has been added

isElementDefinition

public boolean isElementDefinition()

Returns the value of field 'elementDefinition'.

Returns:

the value of field 'ElementDefinition'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

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

setElementDefinition

public void setElementDefinition(boolean elementDefinition)

Sets the value of field 'elementDefinition'.

Parameters:

elementDefinition - the value of field 'elementDefinition'.

setLdapDn

public void setLdapDn(String ldapDn)

Sets the value of field 'ldapDn'.

Parameters:

ldapDn - the value of field 'ldapDn'.

setLdapOc

public void setLdapOc(String ldapOc)

Sets the value of field 'ldapOc'.

Parameters:

ldapOc - the value of field 'ldapOc'.

setNsPrefix

public void setNsPrefix(String nsPrefix)

Sets the value of field 'nsPrefix'.

Parameters:

nsPrefix - the value of field 'nsPrefix'.

setNsUri

public void setNsUri(String nsUri)

Sets the value of field 'nsUri'.

Parameters:

nsUri - the value of field 'nsUri'.

setTable

public void setTable(String table)

Sets the value of field 'table'. The field 'table' has the following description: An optional attribute used to specify the name of the table to which the given Java object is associated.

Parameters:

table - the value of field 'table'.

setXml

public void setXml(String xml)

Sets the value of field 'xml'.

Parameters:

xml - the value of field 'xml'.

unmarshal

public static MapTo unmarshal(Reader reader)
                       throws MarshalException,
                              ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.exolab.castor.mapping.xml.MapTo

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