/libformula-1.1.3/source/org/pentaho/reporting/libraries/formula/function/logical/FalseFunctionDescription.java

 1/*
 2 * This program is free software; you can redistribute it and/or modify it under the
 3 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 4 * Foundation.
 5 *
 6 * You should have received a copy of the GNU Lesser General Public License along with this
 7 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 8 * or from the Free Software Foundation, Inc.,
 9 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 * See the GNU Lesser General Public License for more details.
14 *
15 * Copyright (c) 2006 - 2009 Pentaho Corporation and Contributors.  All rights reserved.
16 */
17
18package org.pentaho.reporting.libraries.formula.function.logical;
19
20import org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription;
21import org.pentaho.reporting.libraries.formula.function.FunctionCategory;
22import org.pentaho.reporting.libraries.formula.typing.Type;
23import org.pentaho.reporting.libraries.formula.typing.coretypes.LogicalType;
24
25/**
26 * Creation-Date: 04.11.2006, 18:28:55
27 *
28 * @author Thomas Morgner
29 */
30public class FalseFunctionDescription extends AbstractFunctionDescription
31{
32  private static final long serialVersionUID = -1846971196399484893L;
33
34  public FalseFunctionDescription()
35  {
36    super("FALSE", "org.pentaho.reporting.libraries.formula.function.logical.False-Function");
37  }
38
39  public int getParameterCount()
40  {
41    return 0;
42  }
43
44  public Type getParameterType(final int position)
45  {
46    return LogicalType.TYPE;
47  }
48
49  public Type getValueType()
50  {
51    return LogicalType.TYPE;
52  }
53
54  /**
55   * Defines, whether the parameter at the given position is mandatory. A
56   * mandatory parameter must be filled in, while optional parameters need not
57   * to be filled in.
58   *
59   * @return
60   */
61  public boolean isParameterMandatory(final int position)
62  {
63    return false;
64  }
65
66  public FunctionCategory getCategory()
67  {
68    return LogicalFunctionCategory.CATEGORY;
69  }
70
71}