edu.berkeley.guir.ptk.notification
Class Translate

java.lang.Object
  extended byedu.berkeley.guir.ptk.notification.Translate

public class Translate
extends java.lang.Object

Determines how to translate one Data type to another. Note that this class represents the default implementations of translation methods, which may need rewriting. Some translations are application specific and so must be defined by the application developer. Subclass this class in order to modify the translation methods.

The PTK only uses the methods converting from any data type to a number (used in NotificationSetter).

Author:
tmatthew Created: Mar 9, 2003

Constructor Summary
Translate()
           
 
Method Summary
 DataFile fileToFile(DataFile d)
          Returns null (redefine if needed).
 DataNumber fileToNumber(DataFile d)
          Returns null (redefine if needed).
 DataRange fileToRange(DataFile d, DataRange to)
          Returns null (redefine if needed).
 DataString fileToString(DataFile d)
          Returns null (redefine if needed).
 DataSwitch fileToSwitch(DataFile d)
          Returns null (redefine if needed).
 DataFile numberToFile(DataNumber d)
          Returns null (redefine if needed).
 DataNumber numberToNumber(DataNumber d)
          Returns null (redefine if needed).
 DataRange numberToRange(DataNumber d, DataRange to)
           
 DataString numberToString(DataNumber d)
          Returns null (redefine if needed).
 DataSwitch numberToSwitch(DataNumber d)
          Returns PTKConstants.TRUE_NUMBER if true, PTKConstants.FALSE_NUMBER if false.
 DataFile rangeToFile(DataRange d)
          Returns null (redefine if needed).
 DataNumber rangeToNumber(DataRange d)
          Returns null (redefine if needed).
 DataRange rangeToRange(DataRange d, DataRange to)
           
 DataString rangeToString(DataRange d)
          Returns null (redefine if needed).
 DataSwitch rangeToSwitch(DataRange d)
          Returns null (redefine if needed).
 DataFile stringToFile(DataString d)
          Returns null (redefine if needed).
 DataNumber stringToNumber(DataString d)
          Returns null (redefine if needed).
 DataRange stringToRange(DataString d, DataRange to)
          Returns null (redefine if needed).
 DataString stringToString(DataString d)
          Returns null (redefine if needed).
 DataSwitch stringToSwitch(DataString d)
          Returns null (redefine if needed).
 DataFile switchToFile(DataSwitch d)
          Returns null (redefine if needed).
 DataNumber switchToNumber(DataSwitch d)
          Returns null (redefine if needed).
 DataRange switchToRange(DataSwitch d, DataRange to)
           
 DataString switchToString(DataSwitch d)
          Returns null (redefine if needed).
 DataSwitch switchToSwitch(DataSwitch d)
          Translates a switch to a switch by returning the DataSwitch passed in.
 DataFile toFile(Data d)
          Translates from any PTK Data type to a DataFile.
 DataNumber toNumber(Data d)
          Translates from any PTK Data type to a DataNumber.
 DataRange toRange(Data d, DataRange to)
          Translates from any PTK Data type to a DataRange.
 DataString toString(Data d)
          Translates from any PTK Data type to a DataString.
 DataSwitch toSwitch(Data d)
          Translates from any PTK Data type to a DataSwitch.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Translate

public Translate()
Method Detail

toSwitch

public DataSwitch toSwitch(Data d)
Translates from any PTK Data type to a DataSwitch.

Returns:
DataSwitch

switchToSwitch

public DataSwitch switchToSwitch(DataSwitch d)
Translates a switch to a switch by returning the DataSwitch passed in.

Parameters:
d -
Returns:
DataSwitch

numberToSwitch

public DataSwitch numberToSwitch(DataNumber d)
Returns PTKConstants.TRUE_NUMBER if true, PTKConstants.FALSE_NUMBER if false.

Parameters:
d -
Returns:
DataSwitch

rangeToSwitch

public DataSwitch rangeToSwitch(DataRange d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataSwitch

stringToSwitch

public DataSwitch stringToSwitch(DataString d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataSwitch

fileToSwitch

public DataSwitch fileToSwitch(DataFile d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataSwitch

toNumber

public DataNumber toNumber(Data d)
Translates from any PTK Data type to a DataNumber.

Returns:
DataNumber

switchToNumber

public DataNumber switchToNumber(DataSwitch d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataNumber

numberToNumber

public DataNumber numberToNumber(DataNumber d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataNumber

rangeToNumber

public DataNumber rangeToNumber(DataRange d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataNumber

stringToNumber

public DataNumber stringToNumber(DataString d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataNumber

fileToNumber

public DataNumber fileToNumber(DataFile d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataNumber

toRange

public DataRange toRange(Data d,
                         DataRange to)
Translates from any PTK Data type to a DataRange.

Returns:
DataRange

switchToRange

public DataRange switchToRange(DataSwitch d,
                               DataRange to)
Parameters:
d -
Returns:
DataRange

numberToRange

public DataRange numberToRange(DataNumber d,
                               DataRange to)
Parameters:
d -
Returns:
DataRange

rangeToRange

public DataRange rangeToRange(DataRange d,
                              DataRange to)
Parameters:
d -
Returns:
DataRange

stringToRange

public DataRange stringToRange(DataString d,
                               DataRange to)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataRange

fileToRange

public DataRange fileToRange(DataFile d,
                             DataRange to)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataRange

toString

public DataString toString(Data d)
Translates from any PTK Data type to a DataString.

Returns:
DataString

switchToString

public DataString switchToString(DataSwitch d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataString

numberToString

public DataString numberToString(DataNumber d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataString

stringToString

public DataString stringToString(DataString d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataString

rangeToString

public DataString rangeToString(DataRange d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataString

fileToString

public DataString fileToString(DataFile d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataString

toFile

public DataFile toFile(Data d)
Translates from any PTK Data type to a DataFile.

Returns:
DataFile

switchToFile

public DataFile switchToFile(DataSwitch d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataFile

numberToFile

public DataFile numberToFile(DataNumber d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataFile

stringToFile

public DataFile stringToFile(DataString d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataFile

rangeToFile

public DataFile rangeToFile(DataRange d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataFile

fileToFile

public DataFile fileToFile(DataFile d)
Returns null (redefine if needed).

Parameters:
d -
Returns:
DataFile