/libformula-1.1.3/source/org/pentaho/reporting/libraries/formula/function/datetime/TimeValueFunctionDescription.java
Java | 71 lines | 34 code | 9 blank | 28 comment | 0 complexity | aa7c9742b4dc6a4532b4b649733463ab MD5 | raw file
Possible License(s): LGPL-2.1
- /*
- * This program is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
- * Foundation.
- *
- * You should have received a copy of the GNU Lesser General Public License along with this
- * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
- * or from the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
- * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- * See the GNU Lesser General Public License for more details.
- *
- * Copyright (c) 2006 - 2009 Pentaho Corporation and Contributors. All rights reserved.
- */
- package org.pentaho.reporting.libraries.formula.function.datetime;
- import org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription;
- import org.pentaho.reporting.libraries.formula.function.FunctionCategory;
- import org.pentaho.reporting.libraries.formula.typing.Type;
- import org.pentaho.reporting.libraries.formula.typing.coretypes.DateTimeType;
- import org.pentaho.reporting.libraries.formula.typing.coretypes.TextType;
- /**
- * Describes the TimeFunction function
- *
- * @author Cedric Pronzato
- * @see TimeFunction
- */
- public class TimeValueFunctionDescription extends AbstractFunctionDescription
- {
- private static final long serialVersionUID = 5414013076902907910L;
- public TimeValueFunctionDescription()
- {
- super("TIMEVALUE", "org.pentaho.reporting.libraries.formula.function.datetime.TimeValue-Function");
- }
- public Type getValueType()
- {
- return DateTimeType.TIME_TYPE;
- }
- public int getParameterCount()
- {
- return 1;
- }
- public Type getParameterType(final int position)
- {
- return TextType.TYPE;
- }
- /**
- * Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while
- * optional parameters need not to be filled in.
- *
- * @return
- */
- public boolean isParameterMandatory(final int position)
- {
- return true;
- }
- public FunctionCategory getCategory()
- {
- return DateTimeFunctionCategory.CATEGORY;
- }
- }