Package com.aquima.interactions.expressions.functions.date

Class AbstractDatePartFunction

java.lang.Object
com.aquima.interactions.expressions.functions.date.AbstractDatePartFunction
All Implemented Interfaces:
IFunction, Serializable
Direct Known Subclasses:
Day, Hour, Minute, Month, Second, Year
public abstract class AbstractDatePartFunction extends Object implements IFunction
Abstract base class for functions that returns a part/unit of a date(time) value.
Since:
7.1
Author:
Jon van Leuven
See Also:

  • Constructor Details

    • AbstractDatePartFunction

      protected AbstractDatePartFunction(DataType type)

  • Method Details

    • getName

      public abstract String getName()
      Description copied from interface: IFunction
      This method returns the name of the function.
      Specified by:
      getName in interface IFunction
      Returns:
      the name of the function.

    • getPart

      protected abstract IntegerValue getPart(DateValue date)

    • evaluate

      public IValue evaluate(IArgumentList arguments)
      Description copied from interface: IFunction
      This method should execute the function using the supplied arguments.
      Specified by:
      evaluate in interface IFunction
      Parameters:
      arguments - The arguments for the function.
      Returns:
      The result of the function.

    • getArguments

      public IArgumentType[] getArguments()
      Description copied from interface: IFunction
      This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.
      Specified by:
      getArguments in interface IFunction
      Returns:
      Array containing the definitions of the parameters.

    • determineResultType

      public Type determineResultType(ISemanticNode... arguments)
      Description copied from interface: IFunction
      This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
      Specified by:
      determineResultType in interface IFunction
      Parameters:
      arguments - The type information of the parameters.
      Returns:
      The result type of the function.

    • isDeprecated

      public boolean isDeprecated()
      Description copied from interface: IFunction
      This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.
      Specified by:
      isDeprecated in interface IFunction
      Returns:
      A message indicating that the function is deprecated.