com.ibm.dse.services.ldap
Class Mapping

java.lang.Object
  |
  +--com.ibm.dse.services.ldap.Mapping
Direct Known Subclasses:
ModMapping

public class Mapping
extends java.lang.Object

This class represents a mapping between a source and a target. This mapping will specify the source name and the target name as well as a default value to use for the mapping if a value cannot be obtained from the source.


Constructor Summary
Mapping()
          Mapping constructor.
Mapping(java.lang.String targetName, java.lang.String sourceName)
          Mapping constructor.
Mapping(java.lang.String targetName, java.lang.String sourceName, java.lang.Object defaultValue)
          Mapping constructor.
 
Method Summary
 boolean equals(java.lang.Object o)
          This method defines equality between 2 Mapping objects.
 java.lang.Object getDefaultValue()
          Return the default value attribute of this mapping.
 FormatElement getFormat()
          Return the format for this mapping.
 java.lang.String getName()
          Return the name attribute of this mapping.
 java.lang.String getSourceName()
          Return the source name attribute of this mapping.
 java.lang.String getTargetName()
          Return the target name attribute of this mapping.
 int hashCode()
          Returns a hashcode for this object.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes the state of this mapping from externalized data.
 void setDefaultValue(java.lang.Object newDefaultValue)
          Sets the default value attribute of this mapping.
 void setName(java.lang.String newName)
          Sets the name attribute of this mapping.
 void setSourceName(java.lang.String newSourceName)
          Sets the source name attribute of this mapping.
 void setTargetName(java.lang.String newTargetName)
          Sets the target name attribute of this mapping.
 java.lang.String toString()
          Returns the string representation of this object.
 Vector toStrings()
          Returns a vector containing the string representation of the SGML tags used to externalize this object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Mapping

public Mapping()
Mapping constructor.

Mapping

public Mapping(java.lang.String targetName,
               java.lang.String sourceName)
Mapping constructor.

Mapping

public Mapping(java.lang.String targetName,
               java.lang.String sourceName,
               java.lang.Object defaultValue)
Mapping constructor.
Method Detail

equals

public boolean equals(java.lang.Object o)
This method defines equality between 2 Mapping objects.
Overrides:
equals in class java.lang.Object
Parameters:
o - java.lang.Object
Returns:
boolean

getDefaultValue

public java.lang.Object getDefaultValue()
Return the default value attribute of this mapping.
Returns:
java.lang.Object

getFormat

public FormatElement getFormat()
Return the format for this mapping.
Returns:
com.ibm.dse.base.FormatElement

getName

public java.lang.String getName()
Return the name attribute of this mapping.
Returns:
java.lang.String

getSourceName

public java.lang.String getSourceName()
Return the source name attribute of this mapping.
Returns:
java.lang.String

getTargetName

public java.lang.String getTargetName()
Return the target name attribute of this mapping.
Returns:
java.lang.String

hashCode

public int hashCode()
Returns a hashcode for this object. Caveat: if this object instance is reused, and the targetName, sourceName, and defaultValue properties are identical, then hashCode uniqueness cannot be assured.
Overrides:
hashCode in class java.lang.Object
Returns:
int

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Initializes the state of this mapping from externalized data.
Parameters:
aTag - com.ibm.dse.base.Tag
Returns:
java.lang.Object
Throws:
java.io.IOException -  
DSEException -  

setDefaultValue

public void setDefaultValue(java.lang.Object newDefaultValue)
Sets the default value attribute of this mapping.
Parameters:
newDefaultValue - java.lang.Object

setName

public void setName(java.lang.String newName)
Sets the name attribute of this mapping.
Parameters:
newName - java.lang.String

setSourceName

public void setSourceName(java.lang.String newSourceName)
Sets the source name attribute of this mapping.
Parameters:
newSourceName - java.lang.String

setTargetName

public void setTargetName(java.lang.String newTargetName)
Sets the target name attribute of this mapping.
Parameters:
newTargetName - java.lang.String

toString

public java.lang.String toString()
Returns the string representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
java.lang.String

toStrings

public Vector toStrings()
Returns a vector containing the string representation of the SGML tags used to externalize this object.
Returns:
com.ibm.dse.base.Vector