com.metamatrix.common.types
Interface Transform

All Known Implementing Classes:

AbstractTransform, AnyToObjectTransform, AnyToStringTransform, BigDecimalToBigIntegerTransform, BigDecimalToBooleanTransform, BigDecimalToByteTransform, BigDecimalToDoubleTransform, BigDecimalToFloatTransform, BigDecimalToIntegerTransform, BigDecimalToLongTransform, BigDecimalToShortTransform, BigDecimalToStringTransform, BigIntegerToBigDecimalTransform, BigIntegerToBooleanTransform, BigIntegerToByteTransform, BigIntegerToDoubleTransform, BigIntegerToFloatTransform, BigIntegerToIntegerTransform, BigIntegerToLongTransform, BigIntegerToShortTransform, BigIntegerToStringTransform, BooleanToBigDecimalTransform, BooleanToBigIntegerTransform, BooleanToByteTransform, BooleanToDoubleTransform, BooleanToFloatTransform, BooleanToIntegerTransform, BooleanToLongTransform, BooleanToShortTransform, BooleanToStringTransform, ByteToBigDecimalTransform, ByteToBigIntegerTransform, ByteToBooleanTransform, ByteToDoubleTransform, ByteToFloatTransform, ByteToIntegerTransform, ByteToLongTransform, ByteToShortTransform, ByteToStringTransform, CharacterToStringTransform, ClobToStringTransform, DateToStringTransform, DateToTimestampTransform, DoubleToBigDecimalTransform, DoubleToBigIntegerTransform, DoubleToBooleanTransform, DoubleToByteTransform, DoubleToFloatTransform, DoubleToIntegerTransform, DoubleToLongTransform, DoubleToShortTransform, DoubleToStringTransform, FloatToBigDecimalTransform, FloatToBigIntegerTransform, FloatToBooleanTransform, FloatToByteTransform, FloatToDoubleTransform, FloatToIntegerTransform, FloatToLongTransform, FloatToShortTransform, FloatToStringTransform, IntegerToBigDecimalTransform, IntegerToBigIntegerTransform, IntegerToBooleanTransform, IntegerToByteTransform, IntegerToDoubleTransform, IntegerToFloatTransform, IntegerToLongTransform, IntegerToShortTransform, IntegerToStringTransform, LongToBigDecimalTransform, LongToBigIntegerTransform, LongToBooleanTransform, LongToByteTransform, LongToDoubleTransform, LongToFloatTransform, LongToIntegerTransform, LongToShortTransform, LongToStringTransform, NullToAnyTransform, ObjectToAnyTransform, ShortToBigDecimalTransform, ShortToBigIntegerTransform, ShortToBooleanTransform, ShortToByteTransform, ShortToDoubleTransform, ShortToFloatTransform, ShortToIntegerTransform, ShortToLongTransform, ShortToStringTransform, SQLXMLToStringTransform, StringToBigDecimalTransform, StringToBigIntegerTransform, StringToBooleanTransform, StringToByteTransform, StringToCharacterTransform, StringToClobTransform, StringToDateTransform, StringToDoubleTransform, StringToFloatTransform, StringToIntegerTransform, StringToLongTransform, StringToShortTransform, StringToSQLXMLTransform, StringToTimestampTransform, StringToTimeTransform, TimestampToDateTransform, TimestampToStringTransform, TimestampToTimeTransform, TimeToStringTransform, TimeToTimestampTransform

public interface Transform

This interface represents the transformation from one data type to another. For instance, from java.lang.String to java.lang.Integer where java.lang.String is the the source type, "java.lang.String" is the source name, etc.

Method Summary

java.lang.String	getDescription() Get description.
java.lang.String	getDisplayName() Get nice display name for GUIs.
java.lang.Class	getSourceType() Type of the incoming value.
java.lang.String	getSourceTypeName() Name of the source type.
java.lang.Class	getTargetType() Type of the outgoing value.
java.lang.String	getTargetTypeName() Name of the target type.
boolean	isNarrowing() Flag if the transformation from source to target is a narrowing transformation that may lose information.
java.lang.Object	transform(java.lang.Object value) This method transforms a value of the source type into a value of the target type.

Method Detail

transform

java.lang.Object transform(java.lang.Object value)
                           throws TransformationException

This method transforms a value of the source type into a value of the target type.

Parameters:

value - Incoming value of source type

Returns:

Outgoing value of target type

Throws:

TransformationException - if value is an incorrect input type or the transformation fails

getSourceType

java.lang.Class getSourceType()

Type of the incoming value.

Returns:

Source type

getSourceTypeName

java.lang.String getSourceTypeName()

Name of the source type.

Returns:

Name of source type

getTargetType

java.lang.Class getTargetType()

Type of the outgoing value.

Returns:

Target type

getTargetTypeName

java.lang.String getTargetTypeName()

Name of the target type.

Returns:

Name of target type

getDisplayName

java.lang.String getDisplayName()

Get nice display name for GUIs.

Returns:

Display name

getDescription

java.lang.String getDescription()

Get description.

Returns:

Description of transform

isNarrowing

boolean isNarrowing()

Flag if the transformation from source to target is a narrowing transformation that may lose information.

Returns:

True if transformation is narrowing