diff options
Diffstat (limited to 'xpath/docs/org.eclipse.wst.xml.xpath2.processor.sdk.doc/doc/html/org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime.html')
| -rw-r--r-- | xpath/docs/org.eclipse.wst.xml.xpath2.processor.sdk.doc/doc/html/org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime.html | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/xpath/docs/org.eclipse.wst.xml.xpath2.processor.sdk.doc/doc/html/org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime.html b/xpath/docs/org.eclipse.wst.xml.xpath2.processor.sdk.doc/doc/html/org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime.html new file mode 100644 index 0000000000..f5433a2a46 --- /dev/null +++ b/xpath/docs/org.eclipse.wst.xml.xpath2.processor.sdk.doc/doc/html/org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime.html @@ -0,0 +1,109 @@ +<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font><br> + Class XSDateTime</h2><br><hr><pre>public class <strong>XSDateTime</strong> +extends org.eclipse.wst.xml.xpath2.processor.internal.types.CalendarType</pre>A representation of a date and time (and optional timezone)<hr><table width="100%" border="1"><tr bgcolor="#CCCCFF"><td width="100%"><h2>Constructor Summary</h2></td></tr><tr><td><code><strong><a href="#con_XSDateTime">XSDateTime</a></strong>(java.util.Calendar cal + , + org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration tz)</code></td></tr><tr><td><code><strong><a href="#con_XSDateTime">XSDateTime</a></strong>()</code></td></tr></table><br><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Calendar</code></td><td width="" align="left"><code><a href="#method_calendar">calendar</a>()</code><br> + + Retrieves the Calendar representation of the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.Object</code></td><td width="" align="left"><code><a href="#method_clone">clone</a>()</code><br> + + Creates a copy of this date and time representation</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_constructor">constructor</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br> + + Creates a new result sequence consisting of the retrievable date and time + value in the supplied result sequence</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_day">day</a>()</code><br> + + Retrieve the day from the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_eq">eq</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)</code><br> + + Equality comparison on this and the supplied dates and times (taking + timezones into account)</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getStringValue">getStringValue</a>()</code><br> + + Retrieves a String representation of the date and time stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></td><td width="" align="left"><code><a href="#method_getTypeDefinition">getTypeDefinition</a>()</code><br> + + </td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_gt">gt</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code><br> + + Comparison on this and the supplied dates and times (taking timezones + into account)</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_hour">hour</a>()</code><br> + + Retrieve the hour from the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public static boolean</code></td><td width="" align="left"><code><a href="#method_is_digit">is_digit</a>(char x)</code><br> + + Check to see if a character is numeric</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_lt">lt</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code><br> + + Comparison on this and the supplied dates and times (taking timezones + into account)</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_minus">minus</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br> + + Mathematical minus operator between this XSDateTime and a supplied result + sequence (XSDateTime, XDTYearMonthDuration and XDTDayTimeDuration are + only valid ones).</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_minute">minute</a>()</code><br> + + Retrieve the minute from the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_month">month</a>()</code><br> + + Retrieve the month from the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public static java.lang.String</code></td><td width="" align="left"><code><a href="#method_pad_int">pad_int</a>(int num + , + int len)</code><br> + + Pads the supplied number to the supplied number of digits by adding 0's + in front of it</td></tr><tr valign="top"><td width="20%" align="right"><code>public static int[]</code></td><td width="" align="left"><code><a href="#method_parse_date">parse_date</a>(java.lang.String str)</code><br> + + Parses a String representation of a date and time and retrieves the year, + month and day from it</td></tr><tr valign="top"><td width="20%" align="right"><code>public static double[]</code></td><td width="" align="left"><code><a href="#method_parse_time">parse_time</a>(java.lang.String str)</code><br> + + Parses a String representation of a date and time and retrieves the hour, + minute and seconds from it</td></tr><tr valign="top"><td width="20%" align="right"><code>public static int[]</code></td><td width="" align="left"><code><a href="#method_parse_timezone">parse_timezone</a>(java.lang.String str)</code><br> + + Parses a String representation of a date and time and retrieves the + timezone from it</td></tr><tr valign="top"><td width="20%" align="right"><code>public static org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime</code></td><td width="" align="left"><code><a href="#method_parseDateTime">parseDateTime</a>(java.lang.String str)</code><br> + + Parses a String representation of a date and time and constructs a new + XSDateTime object using that information</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_plus">plus</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br> + + Mathematical addition operator between this XSDateTime and a supplied + result sequence (XDTYearMonthDuration and XDTDayTimeDuration are only + valid ones).</td></tr><tr valign="top"><td width="20%" align="right"><code>public double</code></td><td width="" align="left"><code><a href="#method_second">second</a>()</code><br> + + Retrieve the seconds from the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_string_type">string_type</a>()</code><br> + + Retrive the datatype full pathname</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_timezoned">timezoned</a>()</code><br> + + </td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_type_name">type_name</a>()</code><br> + + Retrieves the datatype name</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration</code></td><td width="" align="left"><code><a href="#method_tz">tz</a>()</code><br> + + Retrieves the timezone associated with the date stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public double</code></td><td width="" align="left"><code><a href="#method_value">value</a>()</code><br> + + Currently unsupported method. Retrieves the date in milliseconds since + the begining of epoch</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_year">year</a>()</code><br> + + Retrieve the year from the date stored</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2> + Constructor Detail + </h2></td></tr></table><h2><a name="con_XSDateTime">XSDateTime</a></h2><p><code>public <strong>XSDateTime</strong>(java.util.Calendar cal + , + org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration tz)</code></p><p>Initiates a new representation of a supplied date and time</p><hr><h2><a name="con_XSDateTime">XSDateTime</a></h2><p><code>public <strong>XSDateTime</strong>()</code></p><p>Inititates a new representation of the current date and time</p><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2> + Methods Detail + </h2></td></tr></table><h2><a name="method_calendar">calendar</a></h2><p><code>public java.util.Calendar <strong>calendar</strong>()</code></p><p>Retrieves the Calendar representation of the date stored</p><h3>Returns</h3><p><code>java.util.Calendar</code> - Calendar representation of the date stored</p><hr><h2><a name="method_clone">clone</a></h2><p><code>public java.lang.Object <strong>clone</strong>()</code></p><p>Creates a copy of this date and time representation</p><h3>Returns</h3><p><code>java.lang.Object</code> - A copy of this date and time representation</p><h3>Throws:</h3><p><code>java.lang.CloneNotSupportedException</code></p><hr><h2><a name="method_constructor">constructor</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>constructor</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Creates a new result sequence consisting of the retrievable date and time + value in the supplied result sequence</p><h3>Parameters</h3><p><code>arg</code> - The result sequence from which to extract the date and time value.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - A new result sequence consisting of the date and time value supplied.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_day">day</a></h2><p><code>public int <strong>day</strong>()</code></p><p>Retrieve the day from the date stored</p><h3>Returns</h3><p><code>int</code> - the day value of the date stored</p><hr><h2><a name="method_eq">eq</a></h2><p><code>public boolean <strong>eq</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)</code></p><p>Equality comparison on this and the supplied dates and times (taking + timezones into account)</p><h3>Parameters</h3><p><code>arg</code> - XSDateTime representation of the date to compare to</p><p><code>dynamicContext</code></p><h3>Returns</h3><p><code>boolean</code> - True if the two dates and times are represent the same exact point in time. False otherwise.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_getStringValue">getStringValue</a></h2><p><code>public java.lang.String <strong>getStringValue</strong>()</code></p><p>Retrieves a String representation of the date and time stored</p><h3>Returns</h3><p><code>java.lang.String</code> - String representation of the date and time stored</p><hr><h2><a name="method_getTypeDefinition">getTypeDefinition</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition <strong>getTypeDefinition</strong>()</code></p><p></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></p><hr><h2><a name="method_gt">gt</a></h2><p><code>public boolean <strong>gt</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code></p><p>Comparison on this and the supplied dates and times (taking timezones + into account)</p><h3>Parameters</h3><p><code>arg</code> - XSDateTime representation of the date to compare to</p><p><code>context</code></p><h3>Returns</h3><p><code>boolean</code> - True if in time, this date and time lies after the date and time supplied. False otherwise.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_hour">hour</a></h2><p><code>public int <strong>hour</strong>()</code></p><p>Retrieve the hour from the date stored</p><h3>Returns</h3><p><code>int</code> - the hour value of the date stored</p><hr><h2><a name="method_is_digit">is_digit</a></h2><p><code>public boolean <strong>is_digit</strong>(char x)</code></p><p>Check to see if a character is numeric</p><h3>Parameters</h3><p><code>x</code> - Character to be tested</p><h3>Returns</h3><p><code>boolean</code> - True if the character is numeric. False otherwise.</p><hr><h2><a name="method_lt">lt</a></h2><p><code>public boolean <strong>lt</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg + , + org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code></p><p>Comparison on this and the supplied dates and times (taking timezones + into account)</p><h3>Parameters</h3><p><code>arg</code> - XSDateTime representation of the date to compare to</p><p><code>context</code></p><h3>Returns</h3><p><code>boolean</code> - True if in time, this date and time lies before the date and time supplied. False otherwise.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_minus">minus</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>minus</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical minus operator between this XSDateTime and a supplied result + sequence (XSDateTime, XDTYearMonthDuration and XDTDayTimeDuration are + only valid ones).</p><h3>Parameters</h3><p><code>arg</code> - The supplied ResultSequence that is on the right of the minus operator. If this is an XSDateTime, the result will be a XDTDayTimeDuration of the duration of time between these two dates. If arg is an XDTYearMonthDuration or an XDTDayTimeDuration the result will be a XSDateTime of the result of the current date minus the duration of time supplied.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New ResultSequence consisting of the result of the mathematical minus operation.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_minute">minute</a></h2><p><code>public int <strong>minute</strong>()</code></p><p>Retrieve the minute from the date stored</p><h3>Returns</h3><p><code>int</code> - the minute value of the date stored</p><hr><h2><a name="method_month">month</a></h2><p><code>public int <strong>month</strong>()</code></p><p>Retrieve the month from the date stored</p><h3>Returns</h3><p><code>int</code> - the month value of the date stored</p><hr><h2><a name="method_pad_int">pad_int</a></h2><p><code>public java.lang.String <strong>pad_int</strong>(int num + , + int len)</code></p><p>Pads the supplied number to the supplied number of digits by adding 0's + in front of it</p><h3>Parameters</h3><p><code>num</code> - Number that si to be padded (if neccessay)</p><p><code>len</code> - Desired length after padding</p><h3>Returns</h3><p><code>java.lang.String</code> - String representation of the padded integer</p><hr><h2><a name="method_parse_date">parse_date</a></h2><p><code>public int[] <strong>parse_date</strong>(java.lang.String str)</code></p><p>Parses a String representation of a date and time and retrieves the year, + month and day from it</p><h3>Parameters</h3><p><code>str</code> - The String representation of the date (and optional timezone)</p><h3>Returns</h3><p><code>int[]</code> - Integer array of size 3. Element 1 is the year, element 2 is the month and element 3 is the day</p><hr><h2><a name="method_parse_time">parse_time</a></h2><p><code>public double[] <strong>parse_time</strong>(java.lang.String str)</code></p><p>Parses a String representation of a date and time and retrieves the hour, + minute and seconds from it</p><h3>Parameters</h3><p><code>str</code> - The String representation of the date (and optional timezone)</p><h3>Returns</h3><p><code>double[]</code> - Integer array of size 3. Element 1 is the hour, element 2 is the minute and element 3 is the seconds</p><hr><h2><a name="method_parse_timezone">parse_timezone</a></h2><p><code>public int[] <strong>parse_timezone</strong>(java.lang.String str)</code></p><p>Parses a String representation of a date and time and retrieves the + timezone from it</p><h3>Parameters</h3><p><code>str</code> - The String representation of the date (and optional timezone)</p><h3>Returns</h3><p><code>int[]</code> - Integer array of size 3. Element 1 represents whether the timezone is ahead or behind GMT, element 2 is the hour displacement and element 3 is the minute displacement.</p><hr><h2><a name="method_parseDateTime">parseDateTime</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime <strong>parseDateTime</strong>(java.lang.String str)</code></p><p>Parses a String representation of a date and time and constructs a new + XSDateTime object using that information</p><h3>Parameters</h3><p><code>str</code> - The String representation of the date (and optional timezone)</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.processor.internal.types.XSDateTime</code> - The XSDateTime representation of the date and time (and optional timezone)</p><hr><h2><a name="method_plus">plus</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>plus</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical addition operator between this XSDateTime and a supplied + result sequence (XDTYearMonthDuration and XDTDayTimeDuration are only + valid ones).</p><h3>Parameters</h3><p><code>arg</code> - The supplied ResultSequence that is on the right of the minus operator. If arg is an XDTYearMonthDuration or an XDTDayTimeDuration the result will be a XSDateTime of the result of the current date minus the duration of time supplied.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New ResultSequence consisting of the result of the mathematical minus operation.</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_second">second</a></h2><p><code>public double <strong>second</strong>()</code></p><p>Retrieve the seconds from the date stored</p><h3>Returns</h3><p><code>double</code> - the seconds value of the date stored</p><hr><h2><a name="method_string_type">string_type</a></h2><p><code>public java.lang.String <strong>string_type</strong>()</code></p><p>Retrive the datatype full pathname</p><h3>Returns</h3><p><code>java.lang.String</code> - "xs:dateTime" which is the datatype full pathname</p><hr><h2><a name="method_timezoned">timezoned</a></h2><p><code>public boolean <strong>timezoned</strong>()</code></p><p></p><h3>Returns</h3><p><code>boolean</code></p><hr><h2><a name="method_type_name">type_name</a></h2><p><code>public java.lang.String <strong>type_name</strong>()</code></p><p>Retrieves the datatype name</p><h3>Returns</h3><p><code>java.lang.String</code> - "dateTime" which is the dataype name</p><hr><h2><a name="method_tz">tz</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration <strong>tz</strong>()</code></p><p>Retrieves the timezone associated with the date stored</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration</code> - the timezone associated with the date stored</p><hr><h2><a name="method_value">value</a></h2><p><code>public double <strong>value</strong>()</code></p><p>Currently unsupported method. Retrieves the date in milliseconds since + the begining of epoch</p><h3>Returns</h3><p><code>double</code> - Number of milliseconds since the begining of the epoch</p><hr><h2><a name="method_year">year</a></h2><p><code>public int <strong>year</strong>()</code></p><p>Retrieve the year from the date stored</p><h3>Returns</h3><p><code>int</code> - the year value of the date stored</p><hr></body></html>
\ No newline at end of file |