1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.ietf.ldap;
/**
* Represents sorting instructions for a particular attribute.
*
* @version 1.0
*/
public class LDAPSortKey implements java.io.Serializable {
static final long serialVersionUID = -7044232342344864405L;
public final static int REVERSE = 0x81;
/**
* Constructs a new <CODE>LDAPSortKey</CODE> object that will
* sort based on the specified instructions.
* @param keyDescription a single attribute specification by which to sort
* If preceded by a hyphen ("-"), the attribute is sorted in reverse order.
* You can also specify the object ID (OID) of a matching rule after
* a colon (":"). For example:
* <P>
* <UL>
* <LI><CODE>"cn"</CODE> (sort by the <CODE>cn</CODE> attribute) <P>
* <LI><CODE>"-cn"</CODE> (sort by the <CODE>cn</CODE> attribute in
* reverse order) <P>
* <LI><CODE>"-cn:1.2.3.4"</CODE> (sort by the <CODE>cn</CODE>
* attribute in reverse order and use the matching rule identified
* by the OID 1.2.3.4) <P>
*</UL>
* @see org.ietf.ldap.controls.LDAPSortControl
* @see org.ietf.ldap.controls.LDAPVirtualListControl
*/
public LDAPSortKey( String keyDescription ) {
if ( (keyDescription != null) && (keyDescription.length() > 0) ) {
if ( keyDescription.charAt( 0 ) == '-' ) {
m_reverse = true;
m_key = keyDescription.substring( 1 );
} else {
m_reverse = false;
m_key = keyDescription;
}
int colonIndex = m_key.indexOf( ':' );
if ( colonIndex == 0 )
m_key = null;
else if ( colonIndex > 0 ) {
m_matchRule = m_key.substring( colonIndex+1 );
m_key = m_key.substring( 0, colonIndex );
}
}
}
/**
* Constructs a new <CODE>LDAPSortKey</CODE> object that will
* sort based on the specified attribute and sort order.
* @param key a single attribute by which to sort. For example:
* <P>
* <UL>
* <LI><CODE>"cn"</CODE> (sort by the <CODE>cn</CODE> attribute)
* <LI><CODE>"givenname"</CODE> (sort by the <CODE>givenname</CODE>
* attribute)
* </UL>
* @param reverse if <CODE>true</CODE>, the sorting is done in
* descending order
* @see org.ietf.ldap.controls.LDAPSortControl
* @see org.ietf.ldap.controls.LDAPVirtualListControl
*/
public LDAPSortKey( String key,
boolean reverse) {
m_key = key;
m_reverse = reverse;
m_matchRule = null;
}
/**
* Constructs a new <CODE>LDAPSortKey</CODE> object that will
* sort based on the specified attribute, sort order, and matching
* rule.
* @param key a single attribute by which to sort. For example:
* <P>
* <UL>
* <LI><CODE>"cn"</CODE> (sort by the <CODE>cn</CODE> attribute)
* <LI><CODE>"givenname"</CODE> (sort by the <CODE>givenname</CODE>
* attribute)
* </UL>
* @param reverse if <CODE>true</CODE>, the sorting is done in
* descending order
* @param matchRule object ID (OID) of the matching rule for
* the attribute (for example, <CODE>1.2.3.4</CODE>)
* @see org.ietf.ldap.controls.LDAPSortControl
* @see org.ietf.ldap.controls.LDAPVirtualListControl
*/
public LDAPSortKey( String key,
boolean reverse,
String matchRule) {
m_key = key;
m_reverse = reverse;
m_matchRule = matchRule;
}
/**
* Returns the attribute by which to sort.
* @return a single attribute by which to sort.
*/
public String getKey() {
return m_key;
}
/**
* Returns <CODE>true</CODE> if sorting is to be done in descending order.
* @return <CODE>true</CODE> if sorting is to be done in descending order.
*/
public boolean getReverse() {
return m_reverse;
}
/**
* Returns the object ID (OID) of the matching rule used for sorting.
* If no matching rule is specified, <CODE>null</CODE> is returned.
* @return the object ID (OID) of the matching rule, or <CODE>null</CODE>
* if the sorting instructions specify no matching rule.
*/
public String getMatchRule() {
return m_matchRule;
}
public String toString() {
StringBuffer sb = new StringBuffer("{SortKey:");
sb.append(" key=");
sb.append(m_key);
sb.append(" reverse=");
sb.append(m_reverse);
if (m_matchRule != null) {
sb.append(" matchRule=");
sb.append(m_matchRule);
}
sb.append("}");
return sb.toString();
}
private String m_key;
private boolean m_reverse;
private String m_matchRule;
}
|
