blob: b9e09e1d9dffbd2f8978d3e867dc71ded83016d1 [file] [log] [blame]
jmoller3a919172011-05-18 23:01:47 +00001<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.api</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.api</strong></font><br>
2 Class CollationProvider</h2><br><hr><pre>public class <strong>CollationProvider</strong>
3extends </pre>Service provider interface for looking up collations from within the
4 dynamic context.
5
6 Definition from the XPath2 specification: A collation is a specification of
7 the manner in which strings and URIs are compared and, by extension,
8 ordered. For a more complete definition of collation, see [XQuery 1.0 and
9 XPath 2.0 Functions and Operators (Second Edition)].<p></p><hr><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Field Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public static java.lang.String</code></td><td width="80%" align="left"><code><a href="#field_CODEPOINT_COLLATION">CODEPOINT_COLLATION</a></code><br>
10 &nbsp;&nbsp;&nbsp;&nbsp;
11 The default collation which is guaranteed to always be implemented</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.Comparator</code></td><td width="" align="left"><code><a href="#method_getCollation">getCollation</a>(java.lang.String name)</code><br>
12 &nbsp;&nbsp;&nbsp;&nbsp;
13 Gets the named collator. W3C does not define collation names (yet?) so
14 we are constrained to using an implementation-defined naming scheme.</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_getDefaultCollation">getDefaultCollation</a>()</code><br>
15 &nbsp;&nbsp;&nbsp;&nbsp;
16 </td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
17 Field Detail
18 </h2></td></tr></table><h2><a name="field_CODEPOINT_COLLATION">CODEPOINT_COLLATION</a></h2><p><code>public static java.lang.String <strong>CODEPOINT_COLLATION</strong></code></p><table><tr><td>The default collation which is guaranteed to always be implemented</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
19 Methods Detail
20 </h2></td></tr></table><h2><a name="method_getCollation">getCollation</a></h2><p><code>public java.util.Comparator <strong>getCollation</strong>(java.lang.String name)</code></p><p>Gets the named collator. W3C does not define collation names (yet?) so
21 we are constrained to using an implementation-defined naming scheme.</p><h3>Parameters</h3><p><code>name</code> - A URI designating the collation to use</p><h3>Returns</h3><p><code>java.util.Comparator</code> - The collation to use, or null if no such collation exists by this provider</p><hr><h2><a name="method_getDefaultCollation">getDefaultCollation</a></h2><p><code>public java.lang.String <strong>getDefaultCollation</strong>()</code></p><p></p><h3>Returns</h3><p><code>java.lang.String</code></p><hr></body></html>