src/core/net/sf/basedb/util/jep/convert/LogarithmConverter.java

Code
Comments
Other
Rev Date Author Line
3604 26 Jul 07 nicklas 1 /**
3604 26 Jul 07 nicklas 2   $Id$
3604 26 Jul 07 nicklas 3
3675 16 Aug 07 jari 4   Copyright (C) 2007 Nicklas Nordborg
3604 26 Jul 07 nicklas 5
3604 26 Jul 07 nicklas 6   This file is part of BASE - BioArray Software Environment.
3604 26 Jul 07 nicklas 7   Available at http://base.thep.lu.se/
3604 26 Jul 07 nicklas 8
3604 26 Jul 07 nicklas 9   BASE is free software; you can redistribute it and/or
3604 26 Jul 07 nicklas 10   modify it under the terms of the GNU General Public License
4479 05 Sep 08 jari 11   as published by the Free Software Foundation; either version 3
3604 26 Jul 07 nicklas 12   of the License, or (at your option) any later version.
3604 26 Jul 07 nicklas 13
3604 26 Jul 07 nicklas 14   BASE is distributed in the hope that it will be useful,
3604 26 Jul 07 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
3604 26 Jul 07 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3604 26 Jul 07 nicklas 17   GNU General Public License for more details.
3604 26 Jul 07 nicklas 18
3604 26 Jul 07 nicklas 19   You should have received a copy of the GNU General Public License
4515 11 Sep 08 jari 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3604 26 Jul 07 nicklas 21 */
3604 26 Jul 07 nicklas 22 package net.sf.basedb.util.jep.convert;
3604 26 Jul 07 nicklas 23
3604 26 Jul 07 nicklas 24 import org.nfunk.jep.Node;
3604 26 Jul 07 nicklas 25
3604 26 Jul 07 nicklas 26 import net.sf.basedb.core.query.Expression;
3604 26 Jul 07 nicklas 27 import net.sf.basedb.core.query.Expressions;
3604 26 Jul 07 nicklas 28 import net.sf.basedb.util.jep.Jep;
3604 26 Jul 07 nicklas 29
3604 26 Jul 07 nicklas 30 /**
3604 26 Jul 07 nicklas 31   Convert {@link org.nfunk.jep.function.Logarithm} function
3604 26 Jul 07 nicklas 32   to a Query API {@link Expression}.
3604 26 Jul 07 nicklas 33
3604 26 Jul 07 nicklas 34   @author nicklas
3604 26 Jul 07 nicklas 35   @version 2.4
3604 26 Jul 07 nicklas 36   @base.modified $Date$
3604 26 Jul 07 nicklas 37 */
3604 26 Jul 07 nicklas 38 public class LogarithmConverter
3604 26 Jul 07 nicklas 39   extends AbstractJepConversionFunction<Node>
3604 26 Jul 07 nicklas 40 {
3604 26 Jul 07 nicklas 41   public LogarithmConverter()
3604 26 Jul 07 nicklas 42   {}
3604 26 Jul 07 nicklas 43
3604 26 Jul 07 nicklas 44   /*
3604 26 Jul 07 nicklas 45     From the JepConversionFunction interface
3604 26 Jul 07 nicklas 46     -------------------------------------------
3604 26 Jul 07 nicklas 47   */
3604 26 Jul 07 nicklas 48   @Override
3604 26 Jul 07 nicklas 49   public boolean isFunction()
3604 26 Jul 07 nicklas 50   {
3604 26 Jul 07 nicklas 51     return true;
3604 26 Jul 07 nicklas 52   }
3604 26 Jul 07 nicklas 53   /**
3604 26 Jul 07 nicklas 54     @return The string 'log'
3604 26 Jul 07 nicklas 55   */
3604 26 Jul 07 nicklas 56   @Override
3604 26 Jul 07 nicklas 57   public String getName()
3604 26 Jul 07 nicklas 58   {
3604 26 Jul 07 nicklas 59     return "log";
3604 26 Jul 07 nicklas 60   }
3604 26 Jul 07 nicklas 61   @Override
3604 26 Jul 07 nicklas 62   public String getDescription()
3604 26 Jul 07 nicklas 63   {
3604 26 Jul 07 nicklas 64     return "10-based logarithm";
3604 26 Jul 07 nicklas 65   }
3604 26 Jul 07 nicklas 66   /**
3604 26 Jul 07 nicklas 67     Convert to expression by calling {@link Expressions#log10(Expression)}.
3604 26 Jul 07 nicklas 68   */
3604 26 Jul 07 nicklas 69   @Override
3604 26 Jul 07 nicklas 70   public Expression toExpression(Node node)
3604 26 Jul 07 nicklas 71   {
3604 26 Jul 07 nicklas 72     return Expressions.log10(
3604 26 Jul 07 nicklas 73       Jep.nodeToExpression(node.jjtGetChild(0))
3604 26 Jul 07 nicklas 74     );
3604 26 Jul 07 nicklas 75   }
3604 26 Jul 07 nicklas 76   // -------------------------------------------
3604 26 Jul 07 nicklas 77
3604 26 Jul 07 nicklas 78
3604 26 Jul 07 nicklas 79 }