Package net.sf.saxon.value
Class GDateValue
java.lang.Object
net.sf.saxon.value.Value<AtomicValue>
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.CalendarValue
net.sf.saxon.value.GDateValue
- All Implemented Interfaces:
PullEvent
,GroundedValue<AtomicValue>
,Item<AtomicValue>
,ValueRepresentation<AtomicValue>
,ConversionResult
- Direct Known Subclasses:
DateValue
,GDayValue
,GMonthDayValue
,GMonthValue
,GYearMonthValue
,GYearValue
Abstract superclass for the primitive types containing date components: xs:date, xs:gYear,
xs:gYearMonth, xs:gMonth, xs:gMonthDay, xs:gDay
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte
protected static byte[]
Test whether a candidate date is actually a valid date in the proleptic Gregorian calendarprotected byte
protected static final short[]
protected boolean
protected int
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(CalendarValue other, XPathContext context) Compare this value to another value of the same type, using the supplied context object to get the implicit timezone if required.boolean
The equals() methods on atomic values is defined to follow the semantics of eq when applied to two atomic values.Get a Java Calendar object that represents this date/time value.getComparisonKey
(XPathContext context) Get a comparison key for this value.getComponent
(int component) Get a component of the value.byte
getDay()
Get the day component of the date (in local form)byte
getMonth()
Get the month component of the date (in local form)Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.int
getYear()
Get the year component of the date (in local form)int
hashCode()
static boolean
isLeapYear
(int year) Test whether a year is a leap yearstatic boolean
isValidDate
(int year, int month, int day) Determine whether a given date is validprotected static ConversionResult
setLexicalValue
(GDateValue d, CharSequence s, ConversionRules rules) Initialize the DateValue using a character string in the format yyyy-mm-dd and an optional time zone.Convert to DateTime.Methods inherited from class net.sf.saxon.value.CalendarValue
add, adjustTimezone, adjustTimezone, appendString, appendTimezone, appendTimezone, appendTwoDigits, getTimezoneInMinutes, getXPathComparable, hasTimezone, isIdentical, makeCalendarValue, removeTimezone, setTimezoneInMinutes, subtract
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, copyAsSubType, effectiveBooleanValue, getCardinality, getItemType, getLength, getPrimitiveStringValue, getPrimitiveType, 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, getCanonicalLexicalRepresentation, getIterator, getSequenceLength, reduce
-
Field Details
-
year
protected int year -
month
protected byte month -
day
protected byte day -
xsd10rules
protected boolean xsd10rules -
daysPerMonth
protected static byte[] daysPerMonthTest whether a candidate date is actually a valid date in the proleptic Gregorian calendar -
monthData
protected static final short[] monthData
-
-
Constructor Details
-
GDateValue
public GDateValue()
-
-
Method Details
-
getYear
public int getYear()Get the year component of the date (in local form)- Returns:
- the year component, as represented internally (allowing a year zero)
-
getMonth
public byte getMonth()Get the month component of the date (in local form)- Returns:
- the month component (1-12)
-
getDay
public byte getDay()Get the day component of the date (in local form)- Returns:
- the day component (1-31)
-
getCalendar
Description copied from class:CalendarValue
Get a Java Calendar object that represents this date/time value. The Calendar object will be newly created for the purpose- Specified by:
getCalendar
in classCalendarValue
- Returns:
- A Calendar object representing the date and time. Note that Java can only represent the time to millisecond precision, and that it does not support the full range of timezones required by XPath (-14:00 to +14:00)
-
setLexicalValue
protected static ConversionResult setLexicalValue(GDateValue d, CharSequence s, ConversionRules rules) Initialize the DateValue using a character string in the format yyyy-mm-dd and an optional time zone. Input must have format [-]yyyy-mm-dd[([+|-]hh:mm | Z)]- Parameters:
d
- the "raw" DateValue to be populateds
- the supplied string valuerules
-- Returns:
- either the supplied GDateValue, with its data initialized; or a ValidationFailure
-
isValidDate
public static boolean isValidDate(int year, int month, int day) Determine whether a given date is valid- Parameters:
year
- the year (permitting year zero)month
- the month (1-12)day
- the day (1-31)- Returns:
- true if this is a valid date
-
isLeapYear
public static boolean isLeapYear(int year) Test whether a year is a leap year- Parameters:
year
- the year (permitting year zero)- Returns:
- true if the supplied year is a leap year
-
equals
The equals() methods on atomic values is defined to follow the semantics of eq when applied to two atomic values. When the other operand is not an atomic value, the result is undefined (may be false, may be an exception). When the other operand is an atomic value that cannot be compared with this one, the method returns false.The hashCode() method is consistent with equals().
This implementation performs a context-free comparison: it fails with ClassCastException if one value has a timezone and the other does not.
- Specified by:
equals
in classAtomicValue
- Parameters:
o
- the other value- Returns:
- true if the other operand is an atomic value and the two values are equal as defined by the XPath eq operator
- Throws:
ClassCastException
- if the values are not comparable
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValue<AtomicValue>
-
compareTo
Compare this value to another value of the same type, using the supplied context object to get the implicit timezone if required. This method implements the XPath comparison semantics.- Specified by:
compareTo
in classCalendarValue
- Parameters:
other
- the value to be comparedcontext
- the XPath dynamic evaluation context (needed only to get the implicit timezone)- Returns:
- -1 if this value is less, 0 if equal, +1 if greater
- Throws:
NoDynamicContextException
- if the supplied context is an early evaluation context and the result depends on the implicit timezone, which is not available at compile time
-
toDateTime
Convert to DateTime.- Specified by:
toDateTime
in classCalendarValue
- Returns:
- the starting instant of the GDateValue (with the same timezone)
-
getSchemaComparable
Description copied from class:AtomicValue
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. An implementation must be provided for all atomic types.In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value
Value.INDETERMINATE_ORDERING
when there is no defined order relationship between two given values. This value is also returned when two values of different types are compared.- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-
getComponent
Get a component of the value. Returns null if the timezone component is requested and is not present.- Overrides:
getComponent
in classAtomicValue
- Parameters:
component
- identifies the required component, as a constant defined in classComponent
, for exampleComponent.HOURS
- Returns:
- the value of the requested component of this value
- Throws:
XPathException
- if a dynamic error occurs
-
getComparisonKey
Get a comparison key for this value. Two values are equal if and only if they their comparison keys are equal- Specified by:
getComparisonKey
in classCalendarValue
- Parameters:
context
- XPath dynamic evaluation context- Returns:
- a comparison key
- Throws:
NoDynamicContextException
- if the implicit timezone is required and is not available (because the method is being called at compile time)
-