net.sf.saxon.exslt

Class Date


public final class Date
extends java.lang.Object

This class implements extension functions in the http://exslt.org/dates-and-times namespace.

Method Summary

static String
date(String dateTime)
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 month
static double
dayInMonth(XPathContext context)
Return the day number of the current date within the month
static double
dayInWeek(String dateTime)
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
dayInYear(String dateTime)
Return the day number of a specified date within the year
static double
dayInYear(XPathContext context)
Return the day number of the current date within the year
static String
dayName(String dateTime)
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
hourInDay(String dateTime)
Return the hour of the day in the specified date or date/time
static double
hourInDay(XPathContext context)
Return the current hour of the day
static boolean
leapYear(String dateTime)
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 year
static double
minuteInHour(String dateTime)
Return the minute of the hour in the specified date or date/time
static double
minuteInHour(XPathContext context)
Return the current minute of the hour
static 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
monthName(String date)
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/time
static double
secondInMinute(XPathContext context)
Return the current second of the minute
static String
time(String dateTime)
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 month
static 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 date
static double
year(String dateTime)
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

date

public static String date(String dateTime)
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

public static String date(XPathContext context)
            throws XPathException
The date:date function returns the current date.
Parameters:
context - the XPath dynamic context
Returns:
the current date as a string

dateTime

public static String dateTime(XPathContext context)
            throws XPathException
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

dayAbbreviation

public 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'.
Parameters:
dateTime - must start with CCYY-MM-DD
Returns:
the English day abbreviation

dayAbbreviation

public static String dayAbbreviation(XPathContext context)
            throws XPathException
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

dayInMonth

public static double dayInMonth(String dateTime)
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

public static double dayInMonth(XPathContext context)
            throws XPathException
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

dayInWeek

public static double dayInWeek(String dateTime)
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

public static double dayInWeek(XPathContext context)
            throws XPathException
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

dayInYear

public static double dayInYear(String dateTime)
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

public static double dayInYear(XPathContext context)
            throws XPathException
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

dayName

public static String dayName(String dateTime)
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

public static String dayName(XPathContext context)
            throws XPathException
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

dayOfWeekInMonth

public 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).
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

public static double dayOfWeekInMonth(XPathContext context)
            throws XPathException
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).

hourInDay

public static double hourInDay(String dateTime)
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

public static double hourInDay(XPathContext context)
            throws XPathException
Return the current hour of the day
Parameters:
context - the XPath dynamic context
Returns:
the hour

leapYear

public static boolean leapYear(String dateTime)
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

public static boolean leapYear(XPathContext context)
            throws XPathException
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

minuteInHour

public static double minuteInHour(String dateTime)
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

public static double minuteInHour(XPathContext context)
            throws XPathException
Return the current minute of the hour
Parameters:
context - the XPath dynamic context
Returns:
the minute

monthAbbreviation

public static String monthAbbreviation(String date)
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

public static String monthAbbreviation(XPathContext context)
            throws XPathException
Return the month abbreviation from the current date.
Parameters:
context - the XPath dynamic context
Returns:
the English month abbreviation, for example "Jan", "Feb"

monthInYear

public static double monthInYear(String dateTime)
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

public static double monthInYear(XPathContext context)
            throws XPathException
Return the month number from the current date.
Parameters:
context - the XPath dynamic context
Returns:
the current month number

monthName

public static String monthName(String date)
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

public static String monthName(XPathContext context)
            throws XPathException
Return the month name from the current date.
Parameters:
context - the XPath dynamic context
Returns:
the English month name, for example "January", "February"

secondInMinute

public static double secondInMinute(String dateTime)
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

public static double secondInMinute(XPathContext context)
            throws XPathException
Return the current second of the minute
Parameters:
context - the XPath dynamic context
Returns:
the second

time

public static String time(String dateTime)
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

public static String time(XPathContext context)
            throws XPathException
The date:time function returns the current time.
Parameters:
context - the XPath dynamic context
Returns:
the current time as a string

weekInMonth

public static double weekInMonth(String dateTime)
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

public static double weekInMonth(XPathContext context)
            throws XPathException
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

weekInYear

public static 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)
Parameters:
dateTime - the current date starting CCYY-MM-DD
Returns:
the ISO week number

weekInYear

public static double weekInYear(XPathContext context)
            throws XPathException
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

year

public static double year(String dateTime)
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

public static double year(XPathContext context)
            throws XPathException
The date:year function returns the current year.
Parameters:
context - the XPath dynamic context
Returns:
the current year as a double