Vba (Pentaho Community Edition Project: mondrian 8.2.0.1-349 API)

java.lang.Object
- mondrian.olap.fun.vba.Vba

```
public class Vba
extends Object
```
Implementations of functions in the Visual Basic for Applications (VBA) specification.
The functions are defined in MSDN .

Since:

Dec 31, 2007

Author:

jhyde

Constructor Summary

Constructors
Constructor and Description

Vba()

Constructors
Constructor and Description
`Vba()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`abs(double number)`
`static int`	`asc(String string)`
`static int`	`ascB(String string)`
`static int`	`ascW(String string)`
`static double`	`atn(double number)`
`static boolean`	`cBool(Object expression)`
`static byte`	`cByte(Object expression)`
`static Date`	`cDate(Object expression)`
`static double`	`cDbl(Object expression)`
`static String`	`chr(int charCode)`
`static String`	`chrB(int charCode)`
`static String`	`chrW(int charCode)`
`static int`	`cInt(Object expression)`
`static double`	`cos(double number)`
`static Date`	`date()`
`static Date`	`dateAdd(String intervalName, double number, Date date)`
`static long`	`dateDiff(String interval, Date date1, Date date2)`
`static long`	`dateDiff(String interval, Date date1, Date date2, int firstDayOfWeek)`
`static long`	`dateDiff(String interval, Date date1, Date date2, int firstDayOfWeek, int firstWeekOfYear)`
`static int`	`datePart(String interval, Date date)`
`static int`	`datePart(String interval, Date date, int firstDayOfWeek)`
`static int`	`datePart(String interval, Date date, int firstDayOfWeek, int firstWeekOfYear)`
`static Date`	`dateSerial(int year, int month, int day)`
`static Date`	`dateValue(Date date)`
`static int`	`day(Date date)`
`static double`	`dDB(double cost, double salvage, double life, double period)`
`static double`	`dDB(double cost, double salvage, double life, double period, double factor)`
`static double`	`exp(double number)`
`static int`	`fix(Object number)`
`static String`	`formatCurrency(Object expression)`
`static String`	`formatCurrency(Object expression, int numDigitsAfterDecimal)`
`static String`	`formatCurrency(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit)`
`static String`	`formatCurrency(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers)`
`static String`	`formatCurrency(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers, int groupDigits)`
`static String`	`formatDateTime(Date date)`
`static String`	`formatDateTime(Date date, int namedFormat)`
`static String`	`formatNumber(Object expression)`
`static String`	`formatNumber(Object expression, int numDigitsAfterDecimal)`
`static String`	`formatNumber(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit)`
`static String`	`formatNumber(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers)`
`static String`	`formatNumber(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers, int groupDigits)`
`static String`	`formatPercent(Object expression)`
`static String`	`formatPercent(Object expression, int numDigitsAfterDecimal)`
`static String`	`formatPercent(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit)`
`static String`	`formatPercent(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers)`
`static String`	`formatPercent(Object expression, int numDigitsAfterDecimal, int includeLeadingDigit, int useParensForNegativeNumbers, int groupDigits)`
`static double`	`fV(double rate, double nPer, double pmt)`
`static double`	`fV(double rate, double nPer, double pmt, double pv)`
`static double`	`fV(double rate, double nPer, double pmt, double pv, boolean type)`
`static String`	`hex(Object number)`
`static int`	`hour(Date time)`
`static int`	`inStr(int start, String stringCheck, String stringMatch)`
`static int`	`inStr(int start, String stringCheck, String stringMatch, int compare)`
`static int`	`inStr(String stringCheck, String stringMatch)`
`static int`	`inStrRev(String stringCheck, String stringMatch)`
`static int`	`inStrRev(String stringCheck, String stringMatch, int start)`
`static int`	`inStrRev(String stringCheck, String stringMatch, int start, int compare)`
`static int`	`int_(Object number)`
`static double`	`iPmt(double rate, double per, double nPer, double PV)`
`static double`	`iPmt(double rate, double per, double nPer, double PV, double fv)`
`static double`	`iPmt(double rate, double per, double nPer, double PV, double fv, boolean due)`
`static double`	`IRR(double[] valueArray)`
`static double`	`IRR(double[] valueArray, double guess)`
`boolean`	`isArray(Object varName)`
`static boolean`	`isDate(Object expression)`
`boolean`	`isError(Object expression)`
`boolean`	`isMissing(Object argName)`
`boolean`	`isNull(Object expression)`
`boolean`	`isNumeric(Object expression)`
`boolean`	`isObject(Object expression)`
`static String`	`lCase(String string)`
`static String`	`left(String string, int length)`
`static double`	`log(double number)`
`static String`	`lTrim(String string)`
`static String`	`mid(String value, int beginIndex)`
`static String`	`mid(String value, int beginIndex, int length)`
`static int`	`minute(Date time)`
`static double`	`MIRR(double[] valueArray, double financeRate, double reinvestRate)`
`static int`	`month(Date date)`
`static String`	`monthName(int month, boolean abbreviate)`
`static Date`	`now()`
`static double`	`nPer(double rate, double pmt, double pv, double fv, boolean due)`
`static double`	`nPV(double r, double[] cfs)`
`static String`	`oct(Object number)`
`static double`	`pmt(double rate, double nPer, double pv, double fv, boolean due)`
`static double`	`pPmt(double rate, double per, double nPer, double PV)`
`static double`	`pPmt(double rate, double per, double nPer, double PV, double fv)`
`static double`	`pPmt(double rate, double per, double nPer, double PV, double fv, boolean due)`
`static double`	`pV(double rate, double nper, double pmt, double fv, boolean due)`
`static double`	`rate(double nPer, double pmt, double PV)`
`static double`	`rate(double nPer, double pmt, double PV, double fv)`
`static double`	`rate(double nPer, double pmt, double PV, double fv, boolean type)`
`static double`	`rate(double nPer, double pmt, double PV, double fv, boolean due, double guess)`
`static String`	`replace(String expression, String find, String replace)`
`static String`	`replace(String expression, String find, String replace, int start)`
`static String`	`replace(String expression, String find, String replace, int start, int count)`
`static String`	`replace(String expression, String find, String replace, int start, int count, int compare)`
`static String`	`right(String string, int length)`
`static double`	`round(double number)`
`static double`	`round(double number, int numDigitsAfterDecimal)`
`static String`	`rTrim(String string)`
`static int`	`second(Date time)`
`static int`	`sgn(double number)`
`static double`	`sin(double number)`
`static double`	`sLN(double cost, double salvage, double life)`
`static String`	`space(int number)`
`static double`	`sqr(double number)`
`static String`	`str(Object number)`
`static int`	`strComp(String string1, String string2)`
`static int`	`strComp(String string1, String string2, int compare)`
`static String`	`string(int number, char character)`
`static String`	`strReverse(String expression)`
`static double`	`sYD(double cost, double salvage, double life, double period)`
`static double`	`tan(double number)`
`static Date`	`time()`
`static float`	`timer()`
`static Date`	`timeSerial(int hour, int minute, int second)`
`static Date`	`timeValue(Date time)`
`static String`	`trim(String string)`
`static String`	`typeName(Object varName)`
`static double`	`val(String string)`
`static int`	`weekday(Date date)`
`static int`	`weekday(Date date, int firstDayOfWeek)`
`static String`	`weekdayName(int weekday, boolean abbreviate, int firstDayOfWeek)`
`static int`	`year(Date date)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Vba
```
public Vba()
```

Method Detail

cBool

public static boolean cBool(Object expression)

cByte

public static byte cByte(Object expression)

cDate

public static Date cDate(Object expression)

cDbl

public static double cDbl(Object expression)

cInt

public static int cInt(Object expression)

fix
```
public static int fix(Object number)
```

hex

public static String hex(Object number)

int_

public static int int_(Object number)

oct

public static String oct(Object number)

str

public static String str(Object number)

val

public static double val(String string)

dateAdd

public static Date dateAdd(String intervalName,
                           double number,
                           Date date)

dateDiff

public static long dateDiff(String interval,
                            Date date1,
                            Date date2)

dateDiff

public static long dateDiff(String interval,
                            Date date1,
                            Date date2,
                            int firstDayOfWeek)

dateDiff

public static long dateDiff(String interval,
                            Date date1,
                            Date date2,
                            int firstDayOfWeek,
                            int firstWeekOfYear)

datePart

public static int datePart(String interval,
                           Date date)

datePart

public static int datePart(String interval,
                           Date date,
                           int firstDayOfWeek)

datePart

public static int datePart(String interval,
                           Date date,
                           int firstDayOfWeek,
                           int firstWeekOfYear)

date
```
public static Date date()
```

dateSerial

public static Date dateSerial(int year,
                              int month,
                              int day)

dateValue

public static Date dateValue(Date date)

day
```
public static int day(Date date)
```

hour
```
public static int hour(Date time)
```

minute
```
public static int minute(Date time)
```

month
```
public static int month(Date date)
```

now
```
public static Date now()
```

second
```
public static int second(Date time)
```

time
```
public static Date time()
```

timeSerial

public static Date timeSerial(int hour,
                              int minute,
                              int second)

timeValue

public static Date timeValue(Date time)

timer
```
public static float timer()
```

weekday
```
public static int weekday(Date date)
```

weekday

public static int weekday(Date date,
                          int firstDayOfWeek)

year
```
public static int year(Date date)
```

dDB

public static double dDB(double cost,
                         double salvage,
                         double life,
                         double period)

dDB

public static double dDB(double cost,
                         double salvage,
                         double life,
                         double period,
                         double factor)

fV

public static double fV(double rate,
                        double nPer,
                        double pmt)

fV

public static double fV(double rate,
                        double nPer,
                        double pmt,
                        double pv)

fV

public static double fV(double rate,
                        double nPer,
                        double pmt,
                        double pv,
                        boolean type)

iPmt

public static double iPmt(double rate,
                          double per,
                          double nPer,
                          double PV)

iPmt

public static double iPmt(double rate,
                          double per,
                          double nPer,
                          double PV,
                          double fv)

iPmt

public static double iPmt(double rate,
                          double per,
                          double nPer,
                          double PV,
                          double fv,
                          boolean due)

IRR

public static double IRR(double[] valueArray)

IRR

public static double IRR(double[] valueArray,
                         double guess)

MIRR

public static double MIRR(double[] valueArray,
                          double financeRate,
                          double reinvestRate)

nPer

public static double nPer(double rate,
                          double pmt,
                          double pv,
                          double fv,
                          boolean due)

nPV

public static double nPV(double r,
                         double[] cfs)

pPmt

public static double pPmt(double rate,
                          double per,
                          double nPer,
                          double PV)

pPmt

public static double pPmt(double rate,
                          double per,
                          double nPer,
                          double PV,
                          double fv)

pPmt

public static double pPmt(double rate,
                          double per,
                          double nPer,
                          double PV,
                          double fv,
                          boolean due)

pmt

public static double pmt(double rate,
                         double nPer,
                         double pv,
                         double fv,
                         boolean due)

pV

public static double pV(double rate,
                        double nper,
                        double pmt,
                        double fv,
                        boolean due)

rate

public static double rate(double nPer,
                          double pmt,
                          double PV)

rate

public static double rate(double nPer,
                          double pmt,
                          double PV,
                          double fv)

rate

public static double rate(double nPer,
                          double pmt,
                          double PV,
                          double fv,
                          boolean type)

rate

public static double rate(double nPer,
                          double pmt,
                          double PV,
                          double fv,
                          boolean due,
                          double guess)

sLN

public static double sLN(double cost,
                         double salvage,
                         double life)

sYD

public static double sYD(double cost,
                         double salvage,
                         double life,
                         double period)

isArray

public boolean isArray(Object varName)

isDate

public static boolean isDate(Object expression)

isError

public boolean isError(Object expression)

isMissing

public boolean isMissing(Object argName)

isNull

public boolean isNull(Object expression)

isNumeric

public boolean isNumeric(Object expression)

isObject

public boolean isObject(Object expression)

typeName

public static String typeName(Object varName)

abs

public static double abs(double number)

atn

public static double atn(double number)

cos

public static double cos(double number)

exp

public static double exp(double number)

log

public static double log(double number)

round

public static double round(double number)

round

public static double round(double number,
                           int numDigitsAfterDecimal)

sgn
```
public static int sgn(double number)
```

sin

public static double sin(double number)

sqr

public static double sqr(double number)

tan

public static double tan(double number)

asc
```
public static int asc(String string)
```

ascB

public static int ascB(String string)

ascW

public static int ascW(String string)

chr

public static String chr(int charCode)

chrB

public static String chrB(int charCode)

chrW

public static String chrW(int charCode)

formatCurrency

public static String formatCurrency(Object expression)

formatCurrency

public static String formatCurrency(Object expression,
                                    int numDigitsAfterDecimal)

formatCurrency

public static String formatCurrency(Object expression,
                                    int numDigitsAfterDecimal,
                                    int includeLeadingDigit)

formatCurrency

public static String formatCurrency(Object expression,
                                    int numDigitsAfterDecimal,
                                    int includeLeadingDigit,
                                    int useParensForNegativeNumbers)

formatCurrency

public static String formatCurrency(Object expression,
                                    int numDigitsAfterDecimal,
                                    int includeLeadingDigit,
                                    int useParensForNegativeNumbers,
                                    int groupDigits)

formatDateTime

public static String formatDateTime(Date date)

formatDateTime

public static String formatDateTime(Date date,
                                    int namedFormat)

formatNumber

public static String formatNumber(Object expression)

formatNumber

public static String formatNumber(Object expression,
                                  int numDigitsAfterDecimal)

formatNumber

public static String formatNumber(Object expression,
                                  int numDigitsAfterDecimal,
                                  int includeLeadingDigit)

formatNumber

public static String formatNumber(Object expression,
                                  int numDigitsAfterDecimal,
                                  int includeLeadingDigit,
                                  int useParensForNegativeNumbers)

formatNumber

public static String formatNumber(Object expression,
                                  int numDigitsAfterDecimal,
                                  int includeLeadingDigit,
                                  int useParensForNegativeNumbers,
                                  int groupDigits)

formatPercent

public static String formatPercent(Object expression)

formatPercent

public static String formatPercent(Object expression,
                                   int numDigitsAfterDecimal)

formatPercent

public static String formatPercent(Object expression,
                                   int numDigitsAfterDecimal,
                                   int includeLeadingDigit)

formatPercent

public static String formatPercent(Object expression,
                                   int numDigitsAfterDecimal,
                                   int includeLeadingDigit,
                                   int useParensForNegativeNumbers)

formatPercent

public static String formatPercent(Object expression,
                                   int numDigitsAfterDecimal,
                                   int includeLeadingDigit,
                                   int useParensForNegativeNumbers,
                                   int groupDigits)

inStr

public static int inStr(String stringCheck,
                        String stringMatch)

inStr

public static int inStr(int start,
                        String stringCheck,
                        String stringMatch)

inStr

public static int inStr(int start,
                        String stringCheck,
                        String stringMatch,
                        int compare)

inStrRev

public static int inStrRev(String stringCheck,
                           String stringMatch)

inStrRev

public static int inStrRev(String stringCheck,
                           String stringMatch,
                           int start)

inStrRev

public static int inStrRev(String stringCheck,
                           String stringMatch,
                           int start,
                           int compare)

lCase

public static String lCase(String string)

lTrim

public static String lTrim(String string)

left

public static String left(String string,
                          int length)

mid

public static String mid(String value,
                         int beginIndex)

mid

public static String mid(String value,
                         int beginIndex,
                         int length)

monthName

public static String monthName(int month,
                               boolean abbreviate)

rTrim

public static String rTrim(String string)

replace

public static String replace(String expression,
                             String find,
                             String replace,
                             int start,
                             int count,
                             int compare)

replace

public static String replace(String expression,
                             String find,
                             String replace,
                             int start,
                             int count)

replace

public static String replace(String expression,
                             String find,
                             String replace,
                             int start)

replace

public static String replace(String expression,
                             String find,
                             String replace)

right

public static String right(String string,
                           int length)

space

public static String space(int number)

strComp

public static int strComp(String string1,
                          String string2)

strComp

public static int strComp(String string1,
                          String string2,
                          int compare)

strReverse

public static String strReverse(String expression)

string

public static String string(int number,
                            char character)

trim

public static String trim(String string)

weekdayName

public static String weekdayName(int weekday,
                                 boolean abbreviate,
                                 int firstDayOfWeek)

Class Vba

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Vba

Method Detail

cBool

cByte

cDate

cDbl

cInt

fix

hex

int_

oct

str

val

dateAdd

dateDiff

dateDiff

dateDiff

datePart

datePart

datePart

date

dateSerial

dateValue

day

hour

minute

month

now

second

time

timeSerial

timeValue

timer

weekday

weekday

year

dDB

dDB

fV

fV

fV

iPmt

iPmt

iPmt

IRR

IRR

MIRR

nPer

nPV

pPmt

pPmt

pPmt

pmt

pV

rate

rate

rate

rate

sLN

sYD

isArray

isDate

isError

isMissing

isNull

isNumeric

isObject

typeName

abs

atn

cos

exp

log

round

round