221 lines
9.0 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
compact3
</div>
<div class="subTitle">
javax.naming.ldap
</div>
<h2 class="title" title="Class SortKey">Class SortKey</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.naming.ldap.SortKey</li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr/> <br/> <pre>public class <span class="typeNameLabel">SortKey</span>
extends <a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">
<span>排序键及其相关的排序参数。</span>
<span>该类实现了一个排序键由LDAPv3控件用于按照<a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>中定义的搜索结果的服务器端排序。</span>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
1.5
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../javax/naming/ldap/SortControl.html" title="javax.naming.ldap中的类"><code>SortControl</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortKey.html#SortKey-java.lang.String-">SortKey</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> attrID)</code>
<div class="block">
创建属性的默认排序键。
</div> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortKey.html#SortKey-java.lang.String-boolean-java.lang.String-">SortKey</a></span>(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> attrID, boolean ascendingOrder, <a href="../../../java/lang/String.html" title="class in java.lang">String</a> matchingRuleID)</code>
<div class="block">
为属性创建排序键。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortKey.html#getAttributeID--">getAttributeID</a></span>()</code>
<div class="block">
检索排序键的属性ID。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortKey.html#getMatchingRuleID--">getMatchingRuleID</a></span>()</code>
<div class="block">
检索用于对属性值进行排序的匹配规则ID。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/naming/ldap/SortKey.html#isAscending--">isAscending</a></span>()</code>
<div class="block">
确定排序顺序。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../../java/lang/Object.html#clone--">clone</a>, <a href="../../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../../java/lang/Object.html#notify--">notify</a>, <a href="../../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../../java/lang/Object.html#toString--">toString</a>, <a href="../../../java/lang/Object.html#wait--">wait</a>, <a href="../../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="SortKey-java.lang.String-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>SortKey</h4> <pre>public SortKey(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> attrID)</pre>
<div class="block">
<span>创建属性的默认排序键。</span>
<span>使用定义与该属性一起使用的排序匹配规则,将根据指定的属性按升序排序条目。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>attrID</code> - 要用作排序键的属性的非空ID。
</dd>
</dl> </li>
</ul> <a name="SortKey-java.lang.String-boolean-java.lang.String-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>SortKey</h4> <pre>public SortKey(<a href="../../../java/lang/String.html" title="class in java.lang">String</a> attrID,
boolean ascendingOrder,
<a href="../../../java/lang/String.html" title="class in java.lang">String</a> matchingRuleID)</pre>
<div class="block">
<span>为属性创建排序键。</span>
<span>条目将根据指定的排序顺序中的指定属性进行排序,并使用指定的匹配规则(如果提供)。</span>
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>attrID</code> - 要用作排序键的属性的非空ID。
</dd>
<dd>
<span><code>ascendingOrder</code> - 如果为真,则条目按升序排列。</span>
<span>否则按降序排列。</span>
</dd>
<dd>
<span><code>matchingRuleID</code> - 用于排序属性值的匹配规则的可能的空ID。</span>
<span>如果未指定则使用为sort key属性定义的排序匹配规则。</span>
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getAttributeID--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getAttributeID</h4> <pre>public <a href="../../../java/lang/String.html" title="class in java.lang">String</a> getAttributeID()</pre>
<div class="block">
检索排序键的属性ID。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
排序键的非空属性ID。
</dd>
</dl> </li>
</ul> <a name="isAscending--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>isAscending</h4> <pre>public boolean isAscending()</pre>
<div class="block">
确定排序顺序。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
如果排序顺序为升序则为true如果降序为false。
</dd>
</dl> </li>
</ul> <a name="getMatchingRuleID--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>getMatchingRuleID</h4> <pre>public <a href="../../../java/lang/String.html" title="class in java.lang">String</a> getMatchingRuleID()</pre>
<div class="block">
检索用于对属性值进行排序的匹配规则ID。
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
<span>可能的空匹配规则ID。</span>
<span>如果为null则使用为sort key属性定义的排序匹配规则。</span>
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>