DateTimeCalculator (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.DateTimeCalculator

```
public class DateTimeCalculator
extends Object
```
DateTimeCalculator is a collection of static methods that operate as the Microsoft Excel function calls do. All methods are called with an array of ptg's, which are then acted upon. A Ptg of the type that makes sense (ie boolean, number) is returned after each method.

Constructor Summary

Constructors
Constructor and Description

DateTimeCalculator()

Constructors
Constructor and Description
`DateTimeCalculator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Ptg`	`calcDate(Ptg[] operands)` DATE
`protected static Ptg`	`calcDateValue(Ptg[] operands)` DATEVALUE Returns the serial number of the date represented by date_text.
`protected static Ptg`	`calcDay(Ptg[] operands)` DAY Return the day of the month
`protected static Ptg`	`calcDays360(Ptg[] operands)` DAYS360 Calculate the difference between 2 dates based on a 360 day year, 12 mos, 30days each.
`protected static Ptg`	`calcEdate(Ptg[] operands)` EDATE Returns the serial number that represents the date that is the indicated number of months before or after a specified date (the start_date).
`protected static Ptg`	`calcEOMonth(Ptg[] operands)` EOMONTH Returns the serial number for the last day of the month that is the indicated number of months before or after start_date.
`protected static Ptg`	`calcHour(Ptg[] operands)` HOUR Converts a serial number to an hour
`protected static Ptg`	`calcMinute(Ptg[] operands)` MINUTE Converts a serial number to a minute
`protected static Ptg`	`calcMonth(Ptg[] operands)` MONTH Converts a serial number to a month
`protected static Ptg`	`calcNetWorkdays(Ptg[] operands)` NETWORKDAYS Returns the number of whole working days between start_date and end_date.
`protected static Ptg`	`calcNow(Ptg[] operands)` NOW Returns the serial number of the current date and time
`protected static Ptg`	`calcSecond(Ptg[] operands)` SECOND Converts a serial number to a second
`protected static Ptg`	`calcTime(Ptg[] operands)` TIME Returns the serial number of a particular time takes 3 arguments, hour, minute, second;
`protected static Ptg`	`calcTimevalue(Ptg[] operands)` TIMEVALUE Converts a time in the form of text to a serial number Returns the decimal number of the time represented by a text string.
`protected static Ptg`	`calcToday(Ptg[] operands)` TODAY Returns the serial number of today's date
`protected static Ptg`	`calcWeekday(Ptg[] operands)` WEEKDAY Converts a serial number to a day of the week
`protected static Ptg`	`calcWeeknum(Ptg[] operands)` WEEKNUM Returns a number that indicates where the week falls numerically within a year.
`protected static Ptg`	`calcWorkday(Ptg[] operands)` WORKDAY Returns a number that represents a date that is the indicated number of working days before or after a date (the starting date).
`protected static Ptg`	`calcYear(Ptg[] operands)` YEAR Converts a serial number to a year
`protected static Ptg`	`calcYearFrac(Ptg[] operands)` YEARFRAC function Calculates the fraction of the year represented by the number of whole days between two dates (the start_date and the end_date).

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

- Constructor Detail
  - DateTimeCalculator
```
public DateTimeCalculator()
```
- Method Detail
  - calcDate
```
protected static Ptg calcDate(Ptg[] operands)
```
    DATE
    
    Parameters:
    
    operands -
    
    Returns:
  - calcDateValue
```
protected static Ptg calcDateValue(Ptg[] operands)
```
    DATEVALUE Returns the serial number of the date represented by date_text. Use DATEVALUE to convert a date represented by text to a serial number. Syntax DATEVALUE(date_text) Date_text is text that represents a date in a Microsoft Excel date format. For example, "1/30/2008" or "30-Jan-2008" are text strings within quotation marks that represent dates. Using the default date system in Excel for Windows, date_text must represent a date from January 1, 1900, to December 31, 9999. Using the default date system in Excel for the Macintosh, date_text must represent a date from January 1, 1904, to December 31, 9999. DATEVALUE returns the #VALUE! error value if date_text is out of this range. If the year portion of date_text is omitted, DATEVALUE uses the current year from your computer's built-in clock. Time information in date_text is ignored. Remarks Excel stores dates as sequential serial numbers so they can be used in calculations. By default, January 1, 1900 is serial number 1, and January 1, 2008 is serial number 39448 because it is 39,448 days after January 1, 1900. Excel for the Macintosh uses a different date system as its default. Most functions automatically convert date values to serial numbers.
    
    Parameters:
    
    operands - Ptg[]
    
    Returns:
    
    Ptg
  - calcDay
```
protected static Ptg calcDay(Ptg[] operands)
```
    DAY Return the day of the month
  - calcDays360
```
protected static Ptg calcDays360(Ptg[] operands)
```
    DAYS360 Calculate the difference between 2 dates based on a 360 day year, 12 mos, 30days each. first date is lower than second, otherwise a negative number is returned Seems pretty dumb to me, but what do I know?
  - calcEdate
```
protected static Ptg calcEdate(Ptg[] operands)
```
    EDATE Returns the serial number that represents the date that is the indicated number of months before or after a specified date (the start_date). Use EDATE to calculate maturity dates or due dates that fall on the same day of the month as the date of issue. EDATE(start_date,months) Start_date is a date that represents the start date. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Months is the number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date. If start_date is not a valid date, EDATE returns the #VALUE! error value. If months is not an integer, it is truncated.
  - calcEOMonth
```
protected static Ptg calcEOMonth(Ptg[] operands)
```
    EOMONTH Returns the serial number for the last day of the month that is the indicated number of months before or after start_date. Use EOMONTH to calculate maturity dates or due dates that fall on the last day of the month. EOMONTH(start_date,months) Start_date is a date that represents the starting date. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Months is the number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date. If months is not an integer, it is truncated. If start_date is not a valid date, EOMONTH returns the #NUM! error value. If start_date plus months yields an invalid date, EOMONTH returns the #NUM! error value.
  - calcHour
```
protected static Ptg calcHour(Ptg[] operands)
```
    HOUR Converts a serial number to an hour
  - calcMinute
```
protected static Ptg calcMinute(Ptg[] operands)
```
    MINUTE Converts a serial number to a minute
  - calcMonth
```
protected static Ptg calcMonth(Ptg[] operands)
```
    MONTH Converts a serial number to a month
  - calcNetWorkdays
```
protected static Ptg calcNetWorkdays(Ptg[] operands)
```
    NETWORKDAYS Returns the number of whole working days between start_date and end_date. Working days exclude weekends and any dates identified in holidays. Use NETWORKDAYS to calculate employee benefits that accrue based on the number of days worked during a specific term. NETWORKDAYS(start_date,end_date,holidays) Start_date is a date that represents the start date. End_date is a date that represents the end date. Holidays is an optional range of one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays. The list can be either a range of cells that contains the dates or an array constant of the serial numbers that represent the dates. Remarks If any argument is not a valid date, NETWORKDAYS returns the #VALUE! error value.
  - calcNow
```
protected static Ptg calcNow(Ptg[] operands)
```
    NOW Returns the serial number of the current date and time
  - calcSecond
```
protected static Ptg calcSecond(Ptg[] operands)
```
    SECOND Converts a serial number to a second
  - calcTime
```
protected static Ptg calcTime(Ptg[] operands)
```
    TIME Returns the serial number of a particular time takes 3 arguments, hour, minute, second;
  - calcTimevalue
```
protected static Ptg calcTimevalue(Ptg[] operands)
```
    TIMEVALUE Converts a time in the form of text to a serial number Returns the decimal number of the time represented by a text string. The decimal number is a value ranging from 0 (zero) to 0.99999999, representing the times from 0:00:00 (12:00:00 AM) to 23:59:59 (11:59:59 P.M.). TIMEVALUE(time_text) Time_text is a text string that represents a time in any one of the Microsoft Excel time formats; for example, "6:45 PM" and "18:45" text strings within quotation marks that represent time.
  - calcToday
```
protected static Ptg calcToday(Ptg[] operands)
```
    TODAY Returns the serial number of today's date
  - calcWeekday
```
protected static Ptg calcWeekday(Ptg[] operands)
```
    WEEKDAY Converts a serial number to a day of the week
  - calcWeeknum
```
protected static Ptg calcWeeknum(Ptg[] operands)
```
    WEEKNUM Returns a number that indicates where the week falls numerically within a year. WEEKNUM(serial_num,return_type) Serial_num is a date within the week. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Return_type is a number that determines on which day the week begins. The default is 1.
    
    Parameters:
    
    operands -
    
    Returns:
  - calcWorkday
```
protected static Ptg calcWorkday(Ptg[] operands)
```
    WORKDAY Returns a number that represents a date that is the indicated number of working days before or after a date (the starting date). Working days exclude weekends and any dates identified as holidays. Use WORKDAY to exclude weekends or holidays when you calculate invoice due dates, expected delivery times, or the number of days of work performed. WORKDAY(start_date,days,holidays) Important Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Start_date is a date that represents the start date. Days is the number of nonweekend and nonholiday days before or after start_date. A positive value for days yields a future date; a negative value yields a past date. Holidays is an optional list of one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays. The list can be either a range of cells that contain the dates or an array constant of the serial numbers that represent the dates. Remarks If any argument is not a valid date, WORKDAY returns the #VALUE! error value. If start_date plus days yields an invalid date, WORKDAY returns the #NUM! error value. If days is not an integer, it is truncated.
    
    Parameters:
    
    operands -
    
    Returns:
  - calcYear
```
protected static Ptg calcYear(Ptg[] operands)
```
    YEAR Converts a serial number to a year
  - calcYearFrac
```
protected static Ptg calcYearFrac(Ptg[] operands)
```
    YEARFRAC function Calculates the fraction of the year represented by the number of whole days between two dates (the start_date and the end_date). Use the YEARFRAC worksheet function to identify the proportion of a whole year's benefits or obligations to assign to a specific term. YEARFRAC(start_date,end_date,basis) Important Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. Start_date is a date that represents the start date. End_date is a date that represents the end date. Basis is the type of day count basis to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360

Class DateTimeCalculator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DateTimeCalculator

Method Detail

calcDate

calcDateValue

calcDay

calcDays360

calcEdate

calcEOMonth

calcHour

calcMinute

calcMonth

calcNetWorkdays

calcNow

calcSecond

calcTime

calcTimevalue

calcToday

calcWeekday

calcWeeknum

calcWorkday

calcYear

calcYearFrac