|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.value.Value<AtomicValue> net.sf.saxon.value.AtomicValue net.sf.saxon.value.CalendarValue net.sf.saxon.value.GDateValue net.sf.saxon.value.DateValue
public class DateValue
A value of type Date. Note that a Date may include a TimeZone.
Field Summary |
---|
Fields inherited from class net.sf.saxon.value.GDateValue |
---|
day, daysPerMonth, month, monthData, xsd10rules, year |
Fields inherited from class net.sf.saxon.value.CalendarValue |
---|
NO_TIMEZONE |
Fields inherited from class net.sf.saxon.value.AtomicValue |
---|
typeLabel |
Fields inherited from class net.sf.saxon.value.Value |
---|
INDETERMINATE_ORDERING |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
---|
EMPTY_VALUE_ARRAY |
Constructor Summary | |
---|---|
DateValue(CharSequence s)
Constructor: create a date value from a supplied string, in ISO 8601 format |
|
DateValue(CharSequence s,
ConversionRules rules)
Constructor: create a date value from a supplied string, in ISO 8601 format |
|
DateValue(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,
boolean xsd10)
Constructor given a year, month, day and xsd10. |
|
DateValue(int year,
byte month,
byte day,
int tz,
AtomicType type)
Constructor given a year, month, and day, and timezone, and an AtomicType representing a subtype of xs:date. |
|
DateValue(int year,
byte month,
byte day,
int tz,
boolean xsd10)
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(Object v2)
Context-free comparison of two DateValue values. |
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Make a copy of this date value, but with a new type label |
static DateValue |
dateFromJulianDayNumber(int julianDayNumber)
Get the Gregorian date corresponding to a particular Julian day number. |
CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. |
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) |
int |
getJulianDayNumber()
Calculate the Julian day number at 00:00 on this date. |
static int |
getJulianDayNumber(int year,
int month,
int day)
Calculate the Julian day number at 00:00 on a given date. |
CharSequence |
getPrimitiveStringValue()
Convert to string |
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value. |
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. |
static ConversionResult |
makeDateValue(CharSequence in,
ConversionRules rules)
Static factory method: construct a DateValue from a string in the lexical form of a date, returning a ValidationFailure if the supplied string is invalid |
DayTimeDurationValue |
subtract(CalendarValue other,
XPathContext context)
Determine the difference between two points in time, as a duration |
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.GDateValue |
---|
compareTo, equals, getCalendar, getComparisonKey, getComponent, getDay, getMonth, getSchemaComparable, getYear, hashCode, isLeapYear, isValidDate, setLexicalValue, toDateTime |
Methods inherited from class net.sf.saxon.value.CalendarValue |
---|
adjustTimezone, appendTimezone, appendTimezone, getTimezoneInMinutes, getXPathComparable, hasTimezone, isIdentical, makeCalendarValue, removeTimezone, setTimezoneInMinutes |
Methods inherited from class net.sf.saxon.value.AtomicValue |
---|
asAtomic, checkPermittedContents, effectiveBooleanValue, getCardinality, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString |
Methods inherited from class net.sf.saxon.value.Value |
---|
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, getSequenceLength, reduce |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DateValue(int year, byte month, byte day)
year
- The year as held internally (note that the year before 1AD is supplied as 0,
but will be displayed on output as -0001)month
- The month, 1-12day
- The day, 1-31public DateValue(int year, byte month, byte day, boolean xsd10)
year
- The year as held internally (note that the year before 1AD is supplied as 0)month
- The month, 1-12day
- The day, 1-31xsd10
- Schema version flag. If set to true, the year before 1AD is displayed as -0001;
if false, it is displayed as 0000; but in both cases, it is held internally as zero. The flag
makes no difference to dates later than 1AD.public DateValue(int year, byte month, byte day, int tz, boolean xsd10)
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.xsd10
- Schema version flag. If set to true, the year before 1AD is displayed as -0001;
if false, it is displayed as 0000; but in both cases, it is held internally as zero. The flag
makes no difference to dates later than 1AD.public DateValue(int year, byte month, byte day, int tz, AtomicType type)
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.type
- the type. This must be a type derived from xs:date, and the value
must conform to this type. The method does not check these conditions.public DateValue(CharSequence s) throws ValidationException
s
- the lexical form of the date value. Currently this assumes XSD 1.0
conventions for BC years (that is, no year zero), but this may change at some time.
ValidationException
- if the supplied string is not a valid datepublic DateValue(CharSequence s, ConversionRules rules) throws ValidationException
s
- the lexical form of the date valuerules
- the conversion rules (determining whether year zero is allowed)
ValidationException
- if the supplied string is not a valid datepublic DateValue(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 timezoneMethod Detail |
---|
public static ConversionResult makeDateValue(CharSequence in, ConversionRules rules)
in
- the lexical form of the daterules
-
public BuiltInAtomicType getPrimitiveType()
getPrimitiveType
in class AtomicValue
public static DateValue tomorrow(int year, byte month, byte day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public static DateValue yesterday(int year, byte month, byte day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public CharSequence getPrimitiveStringValue()
getPrimitiveStringValue
in class AtomicValue
public CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
in class Value<AtomicValue>
public AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType
in class AtomicValue
typeLabel
- the new type label: must be a subtype of xs:date
public CalendarValue adjustTimezone(int timezone)
adjustTimezone
in class CalendarValue
timezone
- the new timezone offset, in minutes
public CalendarValue add(DurationValue duration) throws XPathException
add
in class CalendarValue
duration
- the duration to be added (may be negative)
XPathException
- if the duration is an xs:duration, as distinct from
a subclass thereofpublic DayTimeDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException
subtract
in class CalendarValue
other
- the other point in timecontext
- the XPath dynamic context. May be set to null
only if both values contain an explicit timezone, or if neither does so.
XPathException
- for example if one value is a date and the other is a timepublic int compareTo(Object v2)
compareTo
in interface Comparable
v2
- the other value
ClassCastException
- if the values are not comparable (which might be because
no timezone is available)public static int getJulianDayNumber(int year, int month, int day)
Note that this assumes dates in the proleptic Gregorian calendar
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public int getJulianDayNumber()
Note that this assumes dates in the proleptic Gregorian calendar
public static DateValue dateFromJulianDayNumber(int julianDayNumber)
julianDayNumber
- the Julian day number
public static int getDayWithinYear(int year, int month, int day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public static int getDayOfWeek(int year, int month, int day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public static int getWeekNumber(int year, int month, int day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
public static int getWeekNumberWithinMonth(int year, int month, int day)
year
- the yearmonth
- the month (1-12)day
- the day (1-31)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |