/libformula-1.1.3/source/org/pentaho/reporting/libraries/formula/function/information/CountBlankFunctionDescription.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.information;
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.NumberType;
24import org.pentaho.reporting.libraries.formula.typing.coretypes.AnyType;
25
26/**
27 * Describes the CountBlankFunction function.
28 *
29 * @author Cedric Pronzato
30 * @see org.pentaho.reporting.libraries.formula.function.information.CountBlankFunction
31 */
32public class CountBlankFunctionDescription extends AbstractFunctionDescription
33{
34  public CountBlankFunctionDescription()
35  {
36    super("COUNTBLANK", "org.pentaho.reporting.libraries.formula.function.information.CountBlank-Function");
37  }
38
39  public Type getValueType()
40  {
41    return NumberType.GENERIC_NUMBER;
42  }
43
44  public FunctionCategory getCategory()
45  {
46    return InformationFunctionCategory.CATEGORY;
47  }
48
49  public int getParameterCount()
50  {
51    return 1;
52  }
53
54  /**
55   * Returns the parameter type at the given position using the function metadata. The first parameter is at the
56   * position 0;
57   *
58   * @param position The parameter index.
59   * @return The parameter type.
60   */
61  public Type getParameterType(final int position)
62  {
63    return AnyType.ANY_SEQUENCE;
64  }
65
66  /**
67   * Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while
68   * optional parameters need not to be filled in.
69   *
70   * @return
71   */
72  public boolean isParameterMandatory(final int position)
73  {
74    return true;
75  }
76}