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
|
/******************************************************************************
* The MIT License
* Copyright (c) 2003 Novell Inc. www.novell.com
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the Software), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*******************************************************************************/
//
// Novell.Directory.Ldap.Controls.LdapSortKey.cs
//
// Author:
// Sunil Kumar (Sunilk@novell.com)
//
// (C) 2003 Novell, Inc (http://www.novell.com)
//
using System;
namespace Novell.Directory.Ldap.Controls
{
/// <summary> Encapsulates parameters for sorting search results.
/// </summary>
public class LdapSortKey
{
/// <summary> Returns the attribute to used for sorting.
///
/// </summary>
/// <returns> The name of the attribute used for sorting.
/// </returns>
virtual public System.String Key
{
get
{
return key;
}
}
/// <summary> Returns the sorting order, ascending or descending.
///
/// </summary>
/// <returns> True if the sorting is done is descending order; false, if the
/// sorting is done is ascending order.
/// </returns>
virtual public bool Reverse
{
get
{
return reverse;
}
}
/// <summary> Returns the OID to be used as a matching rule.
///
/// </summary>
/// <returns> The OID to be used as matching rule, or null if none is to be
/// used.
/// </returns>
virtual public System.String MatchRule
{
get
{
return matchRule;
}
}
private System.String key;
private bool reverse;
private System.String matchRule;
// Constructors
/// <summary> Constructs a new LdapSortKey object using an attribute as the sort key.
///
/// </summary>
/// <param name="keyDescription">The single attribute to use for sorting. If the
/// name is preceded by a minus sign (-), the sorting
/// is done in reverse (descending) order.
/// An OID for a matching rule may be appended
/// following a ":".
///
/// Examples:
/// <ul>
/// <li> "cn" (sorts in ascending order by the cn attribute)</li>
/// <li> "-cn" (sorts in descending order by the cn attribute) </li>
/// <li> "cn:1.2.3.4.5" (sorts in ascending order by the cn attribute
/// using the matching rule 1.2.3.4.5) </li>
/// </ul>
/// </param>
public LdapSortKey(System.String keyDescription)
{
matchRule = null;
reverse = false;
System.String myKey = keyDescription;
if (myKey[0] == '-')
{
myKey = myKey.Substring(1);
this.reverse = true;
}
int pos = myKey.IndexOf(":");
if (pos != - 1)
{
this.key = myKey.Substring(0, (pos) - (0));
this.matchRule = myKey.Substring(pos + 1);
}
else
{
this.key = myKey;
}
return ;
}
/// <summary> Constructs a new LdapSortKey object with the specified attribute name
/// and sort order.
///
/// </summary>
/// <param name="key"> The single attribute to use for sorting.
///
/// </param>
/// <param name="reverse">If true, sorting is done in descending order. If false,
/// sorting is done in ascending order.
/// </param>
public LdapSortKey(System.String key, bool reverse):this(key, reverse, null)
{
return ;
}
/// <summary> Constructs a new LdapSortKey object with the specified attribute name,
/// sort order, and a matching rule.
///
/// </summary>
/// <param name="key"> The attribute name (for example, "cn") to use for sorting.
///
/// </param>
/// <param name="reverse"> If true, sorting is done in descending order. If false,
/// sorting is done in ascending order.
///
/// </param>
/// <param name="matchRule"> The object ID (OID) of a matching rule used for
/// collation. If the object will be used to request
/// server-side sorting of search results, it should
/// be the OID of a matching rule known to be
/// supported by that server.
/// </param>
public LdapSortKey(System.String key, bool reverse, System.String matchRule)
{
this.key = key;
this.reverse = reverse;
this.matchRule = matchRule;
return ;
}
}
}
|
