Java Doc for SortKey.java in  » 6.0-JDK-Core » naming » javax » naming » ldap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » naming » javax.naming.ldap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.naming.ldap.SortKey

SortKey
public class SortKey (Code)
A sort key and its associated sort parameters. This class implements a sort key which is used by the LDAPv3 Control for server-side sorting of search results as defined in RFC 2891.
since:
   1.5
See Also:   SortControl
author:
   Vincent Ryan



Constructor Summary
public  SortKey(String attrID)
     Creates the default sort key for an attribute.
public  SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)
     Creates a sort key for an attribute.

Method Summary
public  StringgetAttributeID()
     Retrieves the attribute ID of the sort key.
public  StringgetMatchingRuleID()
     Retrieves the matching rule ID used to order the attribute values. The possibly null matching rule ID.
public  booleanisAscending()
     Determines the sort order.


Constructor Detail
SortKey
public SortKey(String attrID)(Code)
Creates the default sort key for an attribute. Entries will be sorted according to the specified attribute in ascending order using the ordering matching rule defined for use with that attribute.
Parameters:
  attrID - The non-null ID of the attribute to be used as a sortkey.



SortKey
public SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)(Code)
Creates a sort key for an attribute. Entries will be sorted according to the specified attribute in the specified sort order and using the specified matching rule, if supplied.
Parameters:
  attrID - The non-null ID of the attribute to be used asa sort key.
Parameters:
  ascendingOrder - If true then entries are arranged in ascendingorder. Otherwise there are arranged indescending order.
Parameters:
  matchingRuleID - The possibly null ID of the matching rule touse to order the attribute values. If notspecified then the ordering matching ruledefined for the sort key attribute is used.




Method Detail
getAttributeID
public String getAttributeID()(Code)
Retrieves the attribute ID of the sort key. The non-null Attribute ID of the sort key.



getMatchingRuleID
public String getMatchingRuleID()(Code)
Retrieves the matching rule ID used to order the attribute values. The possibly null matching rule ID. If null then theordering matching rule defined for the sort key attributeis used.



isAscending
public boolean isAscending()(Code)
Determines the sort order. true if the sort order is ascending, false if descending.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.