|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.modules.gui.base.date.SerialDate
org.pentaho.reporting.engine.classic.core.modules.gui.base.date.SpreadsheetDate
public class SpreadsheetDate
Represents a date using an integer, in a similar fashion to the implementation in Microsoft Excel. The range of dates supported is 1-Jan-1900 to 31-Dec-9999.
Be aware that there is a deliberate bug in Excel that recognises the year 1900 as a leap year when in fact it is not a leap year. You can find more information on the Microsoft website in article Q181370:
http://support.microsoft.com/support/kb/articles/Q181/3/70.asp
Excel uses the convention that 1-Jan-1900 = 1. This class uses the convention 1-Jan-1900 = 2. The result is that the day number in this class will be different to the Excel figure for January and February 1900...but then Excel adds in an extra day (29-Feb-1900 which does not actually exist!) and from that point forward the day numbers will match.
Field Summary |
---|
Fields inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.base.date.SerialDate |
---|
DATE_FORMAT_SYMBOLS, FIRST_WEEK_IN_MONTH, FOLLOWING, FOURTH_WEEK_IN_MONTH, FRIDAY, INCLUDE_BOTH, INCLUDE_FIRST, INCLUDE_NONE, INCLUDE_SECOND, LAST_WEEK_IN_MONTH, MAXIMUM_YEAR_SUPPORTED, MINIMUM_YEAR_SUPPORTED, MONDAY, NEAREST, PRECEDING, SATURDAY, SECOND_WEEK_IN_MONTH, SERIAL_LOWER_BOUND, SERIAL_UPPER_BOUND, SUNDAY, THIRD_WEEK_IN_MONTH, THURSDAY, TUESDAY, WEDNESDAY |
Constructor Summary | |
---|---|
SpreadsheetDate(int serial)
Deprecated. Standard constructor - creates a new date object representing the specified day number (which should be in the range 2 to 2958465. |
|
SpreadsheetDate(int day,
int month,
int year)
Deprecated. Creates a new date instance. |
Method Summary | |
---|---|
int |
compare(SerialDate other)
Deprecated. Returns the difference (in days) between this date and the specified 'other' date. |
int |
compareTo(Object other)
Deprecated. Implements the method required by the Comparable interface. |
boolean |
equals(Object object)
Deprecated. Tests the equality of this date with an arbitrary object. |
int |
getDayOfMonth()
Deprecated. Returns the day of the month. |
int |
getDayOfWeek()
Deprecated. Returns a code representing the day of the week. |
int |
getMonth()
Deprecated. Returns the month (January = 1, February = 2, March = 3). |
int |
getYYYY()
Deprecated. Returns the year (assume a valid range of 1900 to 9999). |
int |
hashCode()
Deprecated. Returns a hash code for this object instance. |
boolean |
isAfter(SerialDate other)
Deprecated. Returns true if this SerialDate represents the same date as the specified SerialDate. |
boolean |
isBefore(SerialDate other)
Deprecated. Returns true if this SerialDate represents an earlier date compared to the specified SerialDate. |
boolean |
isInRange(SerialDate d1,
SerialDate d2)
Deprecated. Returns true if this SerialDate is within the
specified range (INCLUSIVE). |
boolean |
isInRange(SerialDate d1,
SerialDate d2,
int include)
Deprecated. Returns true if this SerialDate is within the specified range (caller specifies whether or not the end-points are included). |
boolean |
isOn(SerialDate other)
Deprecated. Returns true if this SerialDate represents the same date as the specified SerialDate. |
boolean |
isOnOrAfter(SerialDate other)
Deprecated. Returns true if this SerialDate represents the same date as the specified SerialDate. |
boolean |
isOnOrBefore(SerialDate other)
Deprecated. Returns true if this SerialDate represents the same date as the specified SerialDate. |
Date |
toDate()
Deprecated. Returns a java.util.Date equivalent to this date. |
int |
toSerial()
Deprecated. Returns the serial number for the date, where 1 January 1900 = 2 (this corresponds, almost, to the numbering system used in Microsoft Excel for Windows and Lotus 1-2-3). |
Methods inherited from class org.pentaho.reporting.engine.classic.core.modules.gui.base.date.SerialDate |
---|
addDays, addMonths, addYears, createInstance, createInstance, createInstance, getDescription, getEndOfCurrentMonth, getFollowingDayOfWeek, getFollowingDayOfWeek, getMonths, getMonths, getNearestDayOfWeek, getNearestDayOfWeek, getPreviousDayOfWeek, getPreviousDayOfWeek, isLeapYear, isValidMonthCode, isValidWeekdayCode, isValidWeekInMonthCode, lastDayOfMonth, leapYearCount, monthCodeToQuarter, monthCodeToString, monthCodeToString, setDescription, stringToMonthCode, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SpreadsheetDate(int day, int month, int year)
day
- the day (in the range 1 to 28/29/30/31).month
- the month (in the range 1 to 12).year
- the year (in the range 1900 to 9999).public SpreadsheetDate(int serial)
serial
- the serial number for the day (range: 2 to 2958465).Method Detail |
---|
public int toSerial()
toSerial
in class SerialDate
public Date toDate()
java.util.Date
equivalent to this date.
toDate
in class SerialDate
public int getYYYY()
getYYYY
in class SerialDate
public int getMonth()
getMonth
in class SerialDate
public int getDayOfMonth()
getDayOfMonth
in class SerialDate
public int getDayOfWeek()
The codes are defined in the SerialDate
class as:
SUNDAY
, MONDAY
, TUESDAY
,
WEDNESDAY
, THURSDAY
, FRIDAY
, and
SATURDAY
.
getDayOfWeek
in class SerialDate
public boolean equals(Object object)
This method will return true ONLY if the object is an instance of the
SerialDate
base class, and it represents the same day as this
SpreadsheetDate
.
equals
in class Object
object
- the object to compare (null
permitted).
public int hashCode()
hashCode
in class Object
public int compare(SerialDate other)
compare
in class SerialDate
other
- the date being compared to.
public int compareTo(Object other)
other
- the other object (usually another SerialDate).
public boolean isOn(SerialDate other)
isOn
in class SerialDate
other
- the date being compared to.
true
if this SerialDate represents the same date as
the specified SerialDate.public boolean isBefore(SerialDate other)
isBefore
in class SerialDate
other
- the date being compared to.
true
if this SerialDate represents an earlier date
compared to the specified SerialDate.public boolean isOnOrBefore(SerialDate other)
isOnOrBefore
in class SerialDate
other
- the date being compared to.
true
if this SerialDate represents the same date
as the specified SerialDate.public boolean isAfter(SerialDate other)
isAfter
in class SerialDate
other
- the date being compared to.
true
if this SerialDate represents the same date
as the specified SerialDate.public boolean isOnOrAfter(SerialDate other)
isOnOrAfter
in class SerialDate
other
- the date being compared to.
true
if this SerialDate represents the same date as
the specified SerialDate.public boolean isInRange(SerialDate d1, SerialDate d2)
true
if this SerialDate
is within the
specified range (INCLUSIVE). The date order of d1 and d2 is not
important.
isInRange
in class SerialDate
d1
- a boundary date for the range.d2
- the other boundary date for the range.
public boolean isInRange(SerialDate d1, SerialDate d2, int include)
isInRange
in class SerialDate
d1
- one boundary date for the range.d2
- a second boundary date for the range.include
- a code that controls whether or not the start and end
dates are included in the range.
true
if this SerialDate is within the specified
range.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |