Class MapTo

  • All Implemented Interfaces:
    java.io.Serializable

    public class MapTo
    extends java.lang.Object
    implements java.io.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 Description
      MapTo()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deleteElementDefinition()  
      boolean getElementDefinition()
      Returns the value of field 'elementDefinition'.
      java.lang.String getLdapDn()
      Returns the value of field 'ldapDn'.
      java.lang.String getLdapOc()
      Returns the value of field 'ldapOc'.
      java.lang.String getNsPrefix()
      Returns the value of field 'nsPrefix'.
      java.lang.String getNsUri()
      Returns the value of field 'nsUri'.
      java.lang.String getTable()
      Returns the value of field 'table'.
      java.lang.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​(java.io.Writer out)  
      void marshal​(org.xml.sax.ContentHandler handler)  
      void setElementDefinition​(boolean elementDefinition)
      Sets the value of field 'elementDefinition'.
      void setLdapDn​(java.lang.String ldapDn)
      Sets the value of field 'ldapDn'.
      void setLdapOc​(java.lang.String ldapOc)
      Sets the value of field 'ldapOc'.
      void setNsPrefix​(java.lang.String nsPrefix)
      Sets the value of field 'nsPrefix'.
      void setNsUri​(java.lang.String nsUri)
      Sets the value of field 'nsUri'.
      void setTable​(java.lang.String table)
      Sets the value of field 'table'.
      void setXml​(java.lang.String xml)
      Sets the value of field 'xml'.
      static MapTo unmarshal​(java.io.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 java.lang.String getLdapDn()
        Returns the value of field 'ldapDn'.
        Returns:
        the value of field 'LdapDn'.
      • getLdapOc

        public java.lang.String getLdapOc()
        Returns the value of field 'ldapOc'.
        Returns:
        the value of field 'LdapOc'.
      • getNsPrefix

        public java.lang.String getNsPrefix()
        Returns the value of field 'nsPrefix'.
        Returns:
        the value of field 'NsPrefix'.
      • getNsUri

        public java.lang.String getNsUri()
        Returns the value of field 'nsUri'.
        Returns:
        the value of field 'NsUri'.
      • getTable

        public java.lang.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 java.lang.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​(org.xml.sax.ContentHandler handler)
                     throws java.io.IOException,
                            MarshalException,
                            ValidationException
        Parameters:
        handler -
        Throws:
        java.io.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​(java.lang.String ldapDn)
        Sets the value of field 'ldapDn'.
        Parameters:
        ldapDn - the value of field 'ldapDn'.
      • setLdapOc

        public void setLdapOc​(java.lang.String ldapOc)
        Sets the value of field 'ldapOc'.
        Parameters:
        ldapOc - the value of field 'ldapOc'.
      • setNsPrefix

        public void setNsPrefix​(java.lang.String nsPrefix)
        Sets the value of field 'nsPrefix'.
        Parameters:
        nsPrefix - the value of field 'nsPrefix'.
      • setNsUri

        public void setNsUri​(java.lang.String nsUri)
        Sets the value of field 'nsUri'.
        Parameters:
        nsUri - the value of field 'nsUri'.
      • setTable

        public void setTable​(java.lang.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​(java.lang.String xml)
        Sets the value of field 'xml'.
        Parameters:
        xml - the value of field 'xml'.
      • unmarshal

        public static MapTo unmarshal​(java.io.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