Mappable

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> jcorporate >> expresso >> core >> [ dataobjects overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.jcorporate.expresso.core.dataobjects.Mappable

SOURCE |

Download com.jcorporate.expresso.core.dataobjects.Mappable

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.jcorporate.expresso.core.dataobjects
Interface Mappable

public interface Mappable

Objects that implement this interface are claiming that there is a one-to-one relation between one field value and a key field value. A classic example of this in Expresso is the fact that a ExpUid maps one to one to the LoginName. This helps guarantee that lookup objects can map to a specific value.

Since:: Expresso 5.1

Method Summary

java.lang.String getKeyValue(java.lang.String mappedValue)
          Given a 'friendly name' get the key value for this object.

java.lang.String getMappedDescription()
          It returns if the field description for the mapped value as specified by the key value parameter.

java.lang.String getMappedValue(java.lang.String keyValue)
          Given a key value, return the mapped value.

Method Detail

getKeyValue

public java.lang.String getKeyValue(java.lang.String mappedValue)

Given a 'friendly name' get the key value for this object. Example, mappedValue = "Admin", then getKeyValue("Admin") will return "3"

getMappedValue

public java.lang.String getMappedValue(java.lang.String keyValue)

Given a key value, return the mapped value. So for example: getMappedValue("3") will return "Admin"

getMappedDescription

public java.lang.String getMappedDescription()

It returns if the field description for the mapped value as specified by the key value parameter.