net.sf.molae.pipe.binop
Class ConstantSecondFactorTransformer<S,F,T>

java.lang.Object
  net.sf.molae.pipe.binop.ConstantSecondFactorTransformer<S,F,T>

All Implemented Interfaces:

TwoWayTransformer<S,T>

public final class ConstantSecondFactorTransformer<S,F,T>
extends Object
implements TwoWayTransformer<S,T>

A transformer based on a binary operation where the second operand is constant.

Constructor Summary

ConstantSecondFactorTransformer(BinaryFunction<S,F,T> operation, F factor)
Constructs a ConstantSecondFactorTransformer object.

Method Summary

boolean	isRetrievable(T input) Indicates if the origin of the specified object can be calculated.
S	retransform(T input) Calculates the transformation origin of the specified object (optional operation).
T	transform(S input) Transforms the input object (leaving it unchanged) into some output object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstantSecondFactorTransformer

public ConstantSecondFactorTransformer(BinaryFunction<S,F,T> operation,
                                       F factor)

Constructs a ConstantSecondFactorTransformer object.

Parameters:

operation - the underlying binary function

factor - the constant value of the second factor

Method Detail

transform

public T transform(S input)

Description copied from interface: TwoWayTransformer

Transforms the input object (leaving it unchanged) into some output object.

Specified by:

transform in interface TwoWayTransformer<S,T>

Parameters:

input - the object to be transformed, should be left unchanged

Returns:

a transformed object

retransform

public S retransform(T input)

Description copied from interface: TwoWayTransformer

Calculates the transformation origin of the specified object (optional operation). This is the inverse mapping of transform. If implemented, it must at least be ensured that

 transform(retransform(input)).equals(input)
 

for all objects, for that the retransformation is defined (that is retransform(input) does not throw an exception).
This implies that the retransformation is defined on a subset of the image of the transformation.

Specified by:

retransform in interface TwoWayTransformer<S,T>

Parameters:

input - the object for which the transformation origin is searched.

Returns:

the transformation origin of the specified object.

isRetrievable

public boolean isRetrievable(T input)

Description copied from interface: TwoWayTransformer

Indicates if the origin of the specified object can be calculated. This requires that:

1. retransform is implemented for this object and does not throw an exception.
2. The object x returned by retransform is unique, or more formally: transform(o1).equals(transform(o2)) &rArr o1.equals(o2)

This implies that

 retransform(transform(input)).equals(input)
 

for all objects where the retransformation is defined.

Specified by:

isRetrievable in interface TwoWayTransformer<S,T>

Parameters:

input - the object for which the transformation origin is searched.

Returns:

true if the origin of the specified object can be calculated.