Package org.apache.poi.ss.formula.functions

Class UtilFns

  • public class UtilFns
extends java.lang.Object
    Author:
    ashish

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.Calendar CAL_GMT  
      static java.util.TimeZone TZ_GMT  
      static java.lang.Double ZERO_DOUBLE
      The zero double.

    • Constructor Summary

      Constructors 
      Constructor Description
      UtilFns()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static double basisToDouble​(int basis, java.util.Date settle, java.util.Date maturi, int dsm)  
      static ComplexEx cToComplex​(org.apache.commons.math3.complex.Complex c, java.lang.String suffix)
      Convert the complex to complex.
      static java.lang.Long dateToDays​(java.util.Date date)
      Returns number of days since 1900-1-0; i.e. 1900-1-0 returns 0 and 1900-1-1 returns 1.
      static java.util.Date daysToDate​(int arg)
      Returns a Date of a given number of days since 1900-1-1 (inclusive); i.e. returns Date at 1900-1-1 given 1
      static int dsm​(java.util.Date settle, java.util.Date maturi, int basis)  
      static java.lang.String format​(ComplexEx c)
      format Complex number to match Excel format
      static org.apache.commons.math3.stat.regression.SimpleRegression getRegre​(double[] xs, double[] ys)
      Return a commons math Regression class
      static org.apache.commons.math3.stat.descriptive.DescriptiveStatistics getStats​(double[] d)
      Return a commons math DescriptiveStatistics class which is contructed from double array d
      static java.lang.String padZero​(java.lang.String num, int places)  
      static java.lang.String replaceiToi1​(java.lang.String complex, java.lang.String suffix)
      Replace the String i to i1.
      static boolean stringToBoolean​(ValueEval arg)  
      static java.util.Date stringToDate​(ValueEval arg)
      Convert a String to Date
      static java.lang.Double stringToDouble​(java.lang.String str, boolean nullable)
      Convert a string to double
      static double toDouble15​(double dbl, int roundingMode)  
      static double[] toDoubleArray​(java.lang.Object[] objs)
      Convert an object array to a double array
      static double[] toDoubleArray​(java.util.List ls)
      Convert a list to a double array
      static double[][] toDoubleMatrix​(ValueEval arg, int srcRowIndex, int srcColumnIndex)  
      static int[] toIntArray​(java.lang.Object[] objs)
      Convert an object array to an int array
      static java.util.List toList​(ValueEval[] args, int srcRowIndex, int srcColumnIndex)  
      static ComplexEx validateComplex​(java.lang.String complex)
      Validate given String value, return associated complex.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • ZERO_DOUBLE

        public static final java.lang.Double ZERO_DOUBLE
        The zero double.

      • TZ_GMT

        public static final java.util.TimeZone TZ_GMT

      • CAL_GMT

        public static final java.util.Calendar CAL_GMT

    • Constructor Detail

      • UtilFns

        public UtilFns()

    • Method Detail

      • dateToDays

        public static java.lang.Long dateToDays​(java.util.Date date)
        Returns number of days since 1900-1-0; i.e. 1900-1-0 returns 0 and 1900-1-1 returns 1.
        Parameters:
        date - the date to be calculated.
        Returns:
        number of days since 1900-1-0; i.e. 1900-1-0 returns 0 and 1900-1-1 returns 1.

      • basisToDouble

        public static double basisToDouble​(int basis,
                                   java.util.Date settle,
                                   java.util.Date maturi,
                                   int dsm)

      • replaceiToi1

        public static java.lang.String replaceiToi1​(java.lang.String complex,
                                            java.lang.String suffix)
        Replace the String i to i1.
        Parameters:
        complex - String of complex.
        Returns:
        String of a complex.

      • validateComplex

        public static ComplexEx validateComplex​(java.lang.String complex)
                                 throws EvaluationException
        Validate given String value, return associated complex. return ErrorEval.NUM_ERROR if complex is not a format of complex.
        Parameters:
        complex - String value to be validated.
        Returns:
        complex value.
        Throws:
        EvaluationException

      • cToComplex

        public static ComplexEx cToComplex​(org.apache.commons.math3.complex.Complex c,
                                   java.lang.String suffix)
        Convert the complex to complex.
        Parameters:
        c - the complex.
        suffix - the suffix.
        Returns:
        the complex.

      • format

        public static java.lang.String format​(ComplexEx c)
        format Complex number to match Excel format
        Parameters:
        c - the complex number
        Returns:
        the formated Complex number that match Excel format

      • toIntArray

        public static int[] toIntArray​(java.lang.Object[] objs)
                        throws EvaluationException
        Convert an object array to an int array
        Parameters:
        objs - an object array
        Returns:
        int array
        Throws:
        EvaluationException

      • toDouble15

        public static double toDouble15​(double dbl,
                                int roundingMode)

      • stringToDouble

        public static java.lang.Double stringToDouble​(java.lang.String str,
                                              boolean nullable)
                                       throws EvaluationException
        Convert a string to double
        Parameters:
        str - - input value
        nullable - - flag to indicate the return could be null or not
        Returns:
        double value
        Throws:
        EvaluationException

      • toDoubleArray

        public static double[] toDoubleArray​(java.util.List ls)
                              throws EvaluationException
        Convert a list to a double array
        Parameters:
        ls - a list
        Returns:
        a double array
        Throws:
        EvaluationException

      • toDoubleArray

        public static double[] toDoubleArray​(java.lang.Object[] objs)
                              throws EvaluationException
        Convert an object array to a double array
        Parameters:
        objs - an object array
        Returns:
        double array
        Throws:
        EvaluationException

      • getStats

        public static org.apache.commons.math3.stat.descriptive.DescriptiveStatistics getStats​(double[] d)
        Return a commons math DescriptiveStatistics class which is contructed from double array d
        Parameters:
        d - samples
        Returns:
        a DescriptiveStatistics class which is contructed from double array d

      • getRegre

        public static org.apache.commons.math3.stat.regression.SimpleRegression getRegre​(double[] xs,
                                                                                 double[] ys)
                                                                          throws EvaluationException
        Return a commons math Regression class
        Parameters:
        xs - x-coordinates
        ys - y-coordinates
        Returns:
        a commons math Regression class
        Throws:
        EvaluationException

      • daysToDate

        public static java.util.Date daysToDate​(int arg)
        Returns a Date of a given number of days since 1900-1-1 (inclusive); i.e. returns Date at 1900-1-1 given 1
        Parameters:
        arg - number of days since 1900-1-1.
        Returns:
        Date per the given number of days since 1900-1-1.