org.proteios.util.jep
Class MeanFunction

java.lang.Object
  org.proteios.util.jep.MeanFunction

All Implemented Interfaces:

org.nfunk.jep.function.PostfixMathCommandI, JepFunction

public class MeanFunction
extends Object
implements JepFunction

A JEP function class that adds a mean(string) function to a JEP expression parser. The function will calculate the mean value of the raw data property with the given name. For example: mean('ch1BgMean')

To be able to use this function it must be registered with the JEP parser and, before the expression is evaluated, a rawbioassay object must be set. For example we can evaluate an expression for every raw data object in a raw bioassay:

DbControl dc = ...
RawBioAssay assay = ...
String expression = "raw('ch1FgMean') - mean('ch1BgMean')";
RawFunction raw = new RawFunction(assay.getRawDataType());
MeanFunction mean = new MeanFunction(assay);
JEP jep = JepUtil.newJep(expression, raw, mean);
DataResultIterator<RawData> result = 
   assay.getRawData().iterate(dc);
while (result.hasNext())
{
   raw.setRawData(result.next());
   double value = jep.getValue();
   // Do something with the value
}
result.close();

Version:

2.0

Author:

Nicklas

See Also:

Jep

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Constructor Summary

MeanFunction(DbControl dc)
Create a new instance of this function working with raw data of the specified raw bio assay.

Method Summary

String	getFunctionName() Get the name of this function.
int	getNumberOfParameters()
Object	mean(String propertyName) Get the value of the specified property of the current raw data object.
void	run(Stack stack)
void	setCurNumberOfParameters(int n)

Methods inherited from class java.lang.Object

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

Constructor Detail

MeanFunction

public MeanFunction(DbControl dc)

Create a new instance of this function working with raw data of the specified raw bio assay.

Parameters:

dc - DbControl used in this function

Method Detail

getFunctionName

public String getFunctionName()

Description copied from interface: JepFunction

Get the name of this function. It is used when registering the function with a JEP parser.

Specified by:

getFunctionName in interface JepFunction

Returns:

The string "mean"

See Also:

JEP.addFunction(String, PostfixMathCommandI)

getNumberOfParameters

public int getNumberOfParameters()

Specified by:

getNumberOfParameters in interface org.nfunk.jep.function.PostfixMathCommandI

Returns:

Always 1

setCurNumberOfParameters

public void setCurNumberOfParameters(int n)

Specified by:

setCurNumberOfParameters in interface org.nfunk.jep.function.PostfixMathCommandI

run

public void run(Stack stack)
         throws ParseException

Specified by:

run in interface org.nfunk.jep.function.PostfixMathCommandI

Throws:

ParseException

mean

public Object mean(String propertyName)
            throws ParseException

Get the value of the specified property of the current raw data object. This method uses Hibernate metadata to find the value.

Parameters:

propertyName - The name of the raw data property

Throws:

ParseException