001 /*
002 * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.naming.ldap;
027
028 /**
029 * A sort key and its associated sort parameters.
030 * This class implements a sort key which is used by the LDAPv3
031 * Control for server-side sorting of search results as defined in
032 * <a href="http://www.ietf.org/rfc/rfc2891.txt">RFC 2891</a>.
033 *
034 * @since 1.5
035 * @see SortControl
036 * @author Vincent Ryan
037 */
038 public class SortKey {
039
040 /*
041 * The ID of the attribute to sort by.
042 */
043 private String attrID;
044
045 /*
046 * The sort order. Ascending order, by default.
047 */
048 private boolean reverseOrder = false;
049
050 /*
051 * The ID of the matching rule to use for ordering attribute values.
052 */
053 private String matchingRuleID = null;
054
055 /**
056 * Creates the default sort key for an attribute. Entries will be sorted
057 * according to the specified attribute in ascending order using the
058 * ordering matching rule defined for use with that attribute.
059 *
060 * @param attrID The non-null ID of the attribute to be used as a sort
061 * key.
062 */
063 public SortKey(String attrID) {
064 this .attrID = attrID;
065 }
066
067 /**
068 * Creates a sort key for an attribute. Entries will be sorted according to
069 * the specified attribute in the specified sort order and using the
070 * specified matching rule, if supplied.
071 *
072 * @param attrID The non-null ID of the attribute to be used as
073 * a sort key.
074 * @param ascendingOrder If true then entries are arranged in ascending
075 * order. Otherwise there are arranged in
076 * descending order.
077 * @param matchingRuleID The possibly null ID of the matching rule to
078 * use to order the attribute values. If not
079 * specified then the ordering matching rule
080 * defined for the sort key attribute is used.
081 */
082 public SortKey(String attrID, boolean ascendingOrder,
083 String matchingRuleID) {
084
085 this .attrID = attrID;
086 reverseOrder = (!ascendingOrder);
087 this .matchingRuleID = matchingRuleID;
088 }
089
090 /**
091 * Retrieves the attribute ID of the sort key.
092 *
093 * @return The non-null Attribute ID of the sort key.
094 */
095 public String getAttributeID() {
096 return attrID;
097 }
098
099 /**
100 * Determines the sort order.
101 *
102 * @return true if the sort order is ascending, false if descending.
103 */
104 public boolean isAscending() {
105 return (!reverseOrder);
106 }
107
108 /**
109 * Retrieves the matching rule ID used to order the attribute values.
110 *
111 * @return The possibly null matching rule ID. If null then the
112 * ordering matching rule defined for the sort key attribute
113 * is used.
114 */
115 public String getMatchingRuleID() {
116 return matchingRuleID;
117 }
118 }
|