Package net.sf.saxon.exslt
Class Date
java.lang.Object
net.sf.saxon.exslt.Date
This class implements extension functions in the
http://exslt.org/dates-and-times namespace.
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
The date:date function returns the date specified in the date/time string given as the argument.static String
date
(XPathContext context) The date:date function returns the current date.static String
dateTime
(XPathContext context) The date:date-time function returns the current date and time as a date/time string.static String
dayAbbreviation
(String dateTime) Return the day of the week given in a date as an English day abbreviation: one of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', or 'Sat'.static String
dayAbbreviation
(XPathContext context) Return the day of the week given in the current date as an English day abbreviation: one of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', or 'Sat'.static double
dayInMonth
(String dateTime) Return the day number of a specified date within the monthstatic double
dayInMonth
(XPathContext context) Return the day number of the current date within the monthstatic double
Return the day of the week given in a date as a number.static double
dayInWeek
(XPathContext context) Return the day of the week in the current date as a number.static double
Return the day number of a specified date within the yearstatic double
dayInYear
(XPathContext context) Return the day number of the current date within the yearstatic String
Return the day of the week given in a date as an English day name: one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday' or 'Friday'.static String
dayName
(XPathContext context) Return the day of the week given in the current date as an English day name: one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday' or 'Friday'.static double
dayOfWeekInMonth
(String dateTime) Return the day-of-the-week in a month of a date as a number (for example 3 for the 3rd Tuesday in May).static double
dayOfWeekInMonth
(XPathContext context) Return the day-of-the-week in a month of the current date as a number (for example 3 for the 3rd Tuesday in May).static double
Return the hour of the day in the specified date or date/timestatic double
hourInDay
(XPathContext context) Return the current hour of the daystatic boolean
Return true if the year specified in the date/time string given as the argument is a leap year.static boolean
leapYear
(XPathContext context) Returns true if the current year is a leap yearstatic double
minuteInHour
(String dateTime) Return the minute of the hour in the specified date or date/timestatic double
minuteInHour
(XPathContext context) Return the current minute of the hourstatic String
monthAbbreviation
(String date) Return the month abbreviation from a date.static String
monthAbbreviation
(XPathContext context) Return the month abbreviation from the current date.static double
monthInYear
(String dateTime) Return the month number from a date.static double
monthInYear
(XPathContext context) Return the month number from the current date.static String
Return the month name from a date.static String
monthName
(XPathContext context) Return the month name from the current date.static double
secondInMinute
(String dateTime) Return the second of the minute in the specified date or date/timestatic double
secondInMinute
(XPathContext context) Return the current second of the minutestatic String
The date:time function returns the time specified in the date/time string given as the argument.static String
time
(XPathContext context) The date:time function returns the current time.static double
weekInMonth
(String dateTime) Return the week number of a specified date within the month (Note, this function is underspecified in EXSLT)static double
weekInMonth
(XPathContext context) Return the ISO week number of the current date within the monthstatic double
weekInYear
(String dateTime) Return the ISO week number of a specified date within the year (Note, this returns the ISO week number: the result in EXSLT is underspecified)static double
weekInYear
(XPathContext context) Return the ISO week number of the current datestatic double
The date:year function returns the year specified in the date/time string given as the argument.static double
year
(XPathContext context) The date:year function returns the current year.
-
Method Details
-
dateTime
The date:date-time function returns the current date and time as a date/time string. The date/time string that's returned must be a string in the format defined as the lexical representation of xs:dateTime in [3.2.7 dateTime] of [XML Schema Part 2: Datatypes]. The date/time format is basically CCYY-MM-DDThh:mm:ss+hh:mm. The date/time string format must include a time zone, either a Z to indicate Coordinated Universal Time or a + or - followed by the difference between the difference from UTC represented as hh:mm.- Parameters:
context
- the XPath dynamic context- Returns:
- the current date and time as a date/time string
- Throws:
XPathException
-
date
The date:date function returns the date specified in the date/time string given as the argument.- Parameters:
dateTime
- must start with [+|-]CCYY-MM-DD- Returns:
- the date portion of the supplied dateTime
-
date
The date:date function returns the current date.- Parameters:
context
- the XPath dynamic context- Returns:
- the current date as a string
- Throws:
XPathException
-
time
The date:time function returns the time specified in the date/time string given as the argument.- Parameters:
dateTime
- must start with [+|-]CCYY-MM-DDThh:mm:ss- Returns:
- the time part of the string
-
time
The date:time function returns the current time.- Parameters:
context
- the XPath dynamic context- Returns:
- the current time as a string
- Throws:
XPathException
-
year
The date:year function returns the year specified in the date/time string given as the argument.- Parameters:
dateTime
- must begin with CCYY- Returns:
- the year part of the supplied date/time
-
year
The date:year function returns the current year.- Parameters:
context
- the XPath dynamic context- Returns:
- the current year as a double
- Throws:
XPathException
-
leapYear
Return true if the year specified in the date/time string given as the argument is a leap year.- Parameters:
dateTime
- a dateTime as a string- Returns:
- true if the year is a leap year
-
leapYear
Returns true if the current year is a leap year- Parameters:
context
- the XPath dynamic context- Returns:
- true if the current year is a leap year
- Throws:
XPathException
-
monthInYear
Return the month number from a date. The date must start with either "CCYY-MM" or "--MM"- Parameters:
dateTime
- a dateTime as a string- Returns:
- the month extracted from the dateTime
-
monthInYear
Return the month number from the current date.- Parameters:
context
- the XPath dynamic context- Returns:
- the current month number
- Throws:
XPathException
-
monthName
Return the month name from a date. The date must start with either "CCYY-MM" or "--MM"- Parameters:
date
- the date/time as a string- Returns:
- the English month name, for example "January", "February"
-
monthName
Return the month name from the current date.- Parameters:
context
- the XPath dynamic context- Returns:
- the English month name, for example "January", "February"
- Throws:
XPathException
-
monthAbbreviation
Return the month abbreviation from a date.- Parameters:
date
- The date must start with either "CCYY-MM" or "--MM"- Returns:
- the English month abbreviation, for example "Jan", "Feb"
-
monthAbbreviation
Return the month abbreviation from the current date.- Parameters:
context
- the XPath dynamic context- Returns:
- the English month abbreviation, for example "Jan", "Feb"
- Throws:
XPathException
-
weekInYear
Return the ISO week number of a specified date within the year (Note, this returns the ISO week number: the result in EXSLT is underspecified)- Parameters:
dateTime
- the current date starting CCYY-MM-DD- Returns:
- the ISO week number
-
weekInYear
Return the ISO week number of the current date- Parameters:
context
- the XPath dynamic context (Note, this returns the ISO week number: the result in EXSLT is underspecified)- Returns:
- the ISO week number
- Throws:
XPathException
-
weekInMonth
Return the week number of a specified date within the month (Note, this function is underspecified in EXSLT)- Parameters:
dateTime
- the date starting CCYY-MM-DD- Returns:
- the week number within the month
-
weekInMonth
Return the ISO week number of the current date within the month- Parameters:
context
- the XPath dynamic context- Returns:
- the week number within the month
- Throws:
XPathException
-
dayInYear
Return the day number of a specified date within the year- Parameters:
dateTime
- the date starting with CCYY-MM-DD- Returns:
- the day number within the year, as a double
-
dayInYear
Return the day number of the current date within the year- Parameters:
context
- the XPath dynamic context- Returns:
- the day number within the year, as a double
- Throws:
XPathException
-
dayInMonth
Return the day number of a specified date within the month- Parameters:
dateTime
- must start with CCYY-MM-DD, or --MM-DD, or ---DD- Returns:
- the day number within the month, as a double
-
dayInMonth
Return the day number of the current date within the month- Parameters:
context
- the XPath dynamic context- Returns:
- the current day number, as a double
- Throws:
XPathException
-
dayOfWeekInMonth
Return the day-of-the-week in a month of a date as a number (for example 3 for the 3rd Tuesday in May).- Parameters:
dateTime
- must start with CCYY-MM-DD- Returns:
- the the day-of-the-week in a month of a date as a number (for example 3 for the 3rd Tuesday in May).
-
dayOfWeekInMonth
Return the day-of-the-week in a month of the current date as a number (for example 3 for the 3rd Tuesday in May).- Parameters:
context
- the XPath dynamic context- Returns:
- the the day-of-the-week in a month of the current date as a number (for example 3 for the 3rd Tuesday in May).
- Throws:
XPathException
-
dayInWeek
Return the day of the week given in a date as a number. The numbering of days of the week starts at 1 for Sunday, 2 for Monday and so on up to 7 for Saturday.- Parameters:
dateTime
- must start with CCYY-MM-DD- Returns:
- the day of the week as a number
-
dayInWeek
Return the day of the week in the current date as a number. The numbering of days of the week starts at 1 for Sunday, 2 for Monday and so on up to 7 for Saturday.- Parameters:
context
- the XPath dynamic context- Returns:
- the day of the week as a number
- Throws:
XPathException
-
dayName
Return the day of the week given in a date as an English day name: one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday' or 'Friday'.- Parameters:
dateTime
- must start with CCYY-MM-DD- Returns:
- the English name of the day of the week
-
dayName
Return the day of the week given in the current date as an English day name: one of 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday' or 'Friday'.- Parameters:
context
- the XPath dynamic context- Returns:
- the English name of the day of the week
- Throws:
XPathException
-
dayAbbreviation
Return the day of the week given in a date as an English day abbreviation: one of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', or 'Sat'.- Parameters:
dateTime
- must start with CCYY-MM-DD- Returns:
- the English day abbreviation
-
dayAbbreviation
Return the day of the week given in the current date as an English day abbreviation: one of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', or 'Sat'.- Parameters:
context
- the XPath dynamic context- Returns:
- the English day abbreviation
- Throws:
XPathException
-
hourInDay
Return the hour of the day in the specified date or date/time- Parameters:
dateTime
- must start with CCYY-MM-DDThh:mm:ss or hh:mm:ss- Returns:
- the hour
-
hourInDay
Return the current hour of the day- Parameters:
context
- the XPath dynamic context- Returns:
- the hour
- Throws:
XPathException
-
minuteInHour
Return the minute of the hour in the specified date or date/time- Parameters:
dateTime
- must start with CCYY-MM-DDThh:mm:ss or hh:mm:ss- Returns:
- the minute
-
minuteInHour
Return the current minute of the hour- Parameters:
context
- the XPath dynamic context- Returns:
- the minute
- Throws:
XPathException
-
secondInMinute
Return the second of the minute in the specified date or date/time- Parameters:
dateTime
- must start with CCYY-MM-DDThh:mm:ss or hh:mm:ss- Returns:
- the second
-
secondInMinute
Return the current second of the minute- Parameters:
context
- the XPath dynamic context- Returns:
- the second
- Throws:
XPathException
-