|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.CalendarValue
net.sf.saxon.value.DateValue
A value of type Date. Note that a Date may include a TimeZone.
| Field Summary | |
protected byte |
day
|
protected byte |
month
|
protected int |
year
|
| Fields inherited from class net.sf.saxon.value.CalendarValue |
NO_TIMEZONE |
| Fields inherited from class net.sf.saxon.value.Value |
EMPTY_CLASS_ARRAY |
| Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
EMPTY_VALUE_ARRAY |
| Fields inherited from interface net.sf.saxon.expr.Expression |
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD |
| Constructor Summary | |
protected |
DateValue()
Default constructor needed for subtyping |
|
DateValue(java.lang.CharSequence s)
Constructor: create a dateTime value from a supplied string, in ISO 8601 format |
|
DateValue(java.util.GregorianCalendar calendar,
int tz)
Create a DateValue |
|
DateValue(int year,
byte month,
byte day)
Constructor given a year, month, and day. |
|
DateValue(int year,
byte month,
byte day,
int tz)
Constructor given a year, month, and day, and timezone. |
| Method Summary | |
CalendarValue |
add(DurationValue duration)
Add a duration to a date |
CalendarValue |
adjustTimezone(int timezone)
Return a new date with the same normalized value, but in a different timezone. |
int |
compareTo(CalendarValue other,
Configuration config)
Compare this value to another value of the same type, using the supplied context object to get the implicit timezone if required. |
int |
compareTo(java.lang.Object other)
Compare the value to another date value. |
AtomicValue |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
Convert to target data type |
java.lang.Object |
convertToJava(java.lang.Class target,
XPathContext context)
Convert to Java object (for passing to external functions) |
CalendarValue |
copy()
Make a copy of this date, time, or dateTime value |
static DateValue |
dateFromJulianDayNumber(int julianDayNumber)
Get the Gregorian date corresponding to a particular Julian day number. |
boolean |
equals(java.lang.Object other)
Compare two (sequence) values for equality. |
java.util.GregorianCalendar |
getCalendar()
Get a Java Calendar object that represents this date/time value. |
ComparisonKey |
getComparisonKey(Configuration config)
Get a comparison key for this value. |
AtomicValue |
getComponent(int component)
Get a component of the value. |
byte |
getDay()
Get the day component of the date (in local form) |
static int |
getDayOfWeek(int year,
int month,
int day)
Get the day of the week. |
static int |
getDayWithinYear(int year,
int month,
int day)
Get the ordinal day number within the year (1 Jan = 1, 1 Feb = 32, etc) |
ItemType |
getItemType(TypeHierarchy th)
Determine the data type of the expression |
static int |
getJulianDayNumber(int year,
int month,
int day)
Calculate the Julian day number at 00:00 on a given date. |
byte |
getMonth()
Get the month component of the date (in local form) |
java.lang.CharSequence |
getStringValueCS()
Convert to string |
static int |
getWeekNumber(int year,
int month,
int day)
Get the ISO week number for a given date. |
static int |
getWeekNumberWithinMonth(int year,
int month,
int day)
Get the week number within a month. |
int |
getYear()
Get the year component of the date (in local form) |
int |
hashCode()
Return a hash code to support the equals() function |
static boolean |
isLeapYear(int year)
Test whether a year is a leap year |
static boolean |
isValidDate(int year,
int month,
int day)
|
static void |
main(java.lang.String[] args)
Temporary test rig |
void |
setLexicalValue(java.lang.CharSequence s)
Initialize the DateValue using a character string in the format yyyy-mm-dd and an optional time zone. |
SecondsDurationValue |
subtract(CalendarValue other,
XPathContext context)
Determine the difference between two points in time, as a duration |
DateTimeValue |
toDateTime()
Convert to DateTime |
static DateValue |
tomorrow(int year,
byte month,
byte day)
Get the date that immediately follows a given date |
static DateValue |
yesterday(int year,
byte month,
byte day)
Get the date that immediately precedes a given date |
| Methods inherited from class net.sf.saxon.value.CalendarValue |
appendTimezone, appendTimezone, getStringValue, getTimezoneInMinutes, hasTimezone, removeTimezone, setTimezoneInMinutes |
| Methods inherited from class net.sf.saxon.value.AtomicValue |
checkPermittedContents, convert, convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process, toString |
| Methods inherited from class net.sf.saxon.value.Value |
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
protected int year
protected byte month
protected byte day
| Constructor Detail |
protected DateValue()
public DateValue(int year,
byte month,
byte day)
year - The year as held internally (note that the year before 1AD is 0)month - The month, 1-12day - The day 1-31
public DateValue(int year,
byte month,
byte day,
int tz)
year - The year as held internally (note that the year before 1AD is 0)month - The month, 1-12day - The day 1-31tz - the timezone displacement in minutes from UTC. Supply the value
CalendarValue.NO_TIMEZONE if there is no timezone component.
public DateValue(java.lang.CharSequence s)
throws XPathException
public DateValue(java.util.GregorianCalendar calendar,
int tz)
calendar - the absolute date/time valuetz - The timezone offset from GMT in minutes, positive or negative; or the special
value NO_TIMEZONE indicating that the value is not in a timezone| Method Detail |
public void setLexicalValue(java.lang.CharSequence s)
throws XPathException
s - the supplied string value
XPathExceptionpublic int getYear()
public byte getMonth()
public byte getDay()
public static boolean isValidDate(int year,
int month,
int day)
public static boolean isLeapYear(int year)
public static DateValue tomorrow(int year,
byte month,
byte day)
public static DateValue yesterday(int year,
byte month,
byte day)
public AtomicValue convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
convertPrimitive in class AtomicValuerequiredType - an integer identifying the required atomic typecontext - validate - true if validation is required. If set to false, the caller guarantees that
the value is valid for the target data type, and that further validation is therefore not required.
Note that a validation failure may be reported even if validation was not requested.
public DateTimeValue toDateTime()
toDateTime in class CalendarValuepublic java.lang.CharSequence getStringValueCS()
getStringValueCS in interface ItemgetStringValueCS in class AtomicValuepublic java.util.GregorianCalendar getCalendar()
CalendarValue
getCalendar in class CalendarValuepublic ItemType getItemType(TypeHierarchy th)
getItemType in interface ExpressiongetItemType in class Valueth -
public CalendarValue copy()
copy in class CalendarValuepublic CalendarValue adjustTimezone(int timezone)
adjustTimezone in class CalendarValuetimezone - the new timezone offset, in minutes
public java.lang.Object convertToJava(java.lang.Class target,
XPathContext context)
throws XPathException
convertToJava in class ValueXPathException
public AtomicValue getComponent(int component)
throws XPathException
getComponent in class AtomicValueXPathExceptionpublic int compareTo(java.lang.Object other)
other - The other date value. Must be an object of class DateValue.
java.lang.ClassCastException - if the other value is not a DateValue (the parameter
is declared as Object to satisfy the Comparable interface)
public int compareTo(CalendarValue other,
Configuration config)
compareTo in class CalendarValuepublic ComparisonKey getComparisonKey(Configuration config)
getComparisonKey in class CalendarValuepublic boolean equals(java.lang.Object other)
Value
equals in class Valuepublic int hashCode()
Value
hashCode in class Value
public CalendarValue add(DurationValue duration)
throws XPathException
add in class CalendarValueduration - the duration to be added (may be negative)
XPathException - if the duration is an xs:duration, as distinct from
a subclass thereof
public SecondsDurationValue subtract(CalendarValue other,
XPathContext context)
throws XPathException
subtract in class CalendarValueother - the other point in timecontext -
XPathException - for example if one value is a date and the other is a time
public static int getJulianDayNumber(int year,
int month,
int day)
public static DateValue dateFromJulianDayNumber(int julianDayNumber)
public static final int getDayWithinYear(int year,
int month,
int day)
public static final int getDayOfWeek(int year,
int month,
int day)
public static final int getWeekNumber(int year,
int month,
int day)
public static final int getWeekNumberWithinMonth(int year,
int month,
int day)
public static void main(java.lang.String[] args)
throws java.lang.Exception
java.lang.Exception
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||