- java.lang.Object
-
- javax.naming.ldap.SortKey
-
public class SortKey extends Object
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
-
-
Constructor Summary
Constructors Constructor and Description SortKey(String attrID)
Creates the default sort key for an attribute.SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)
Creates a sort key for an attribute.
-
Method Summary
Methods Modifier and Type Method and Description String
getAttributeID()
Retrieves the attribute ID of the sort key.String
getMatchingRuleID()
Retrieves the matching rule ID used to order the attribute values.boolean
isAscending()
Determines the sort order.
-
-
-
Constructor Detail
-
SortKey
public SortKey(String attrID)
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 sort key.
-
SortKey
public SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)
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 as a sort key.ascendingOrder
- If true then entries are arranged in ascending order. Otherwise there are arranged in descending order.matchingRuleID
- The possibly null ID of the matching rule to use to order the attribute values. If not specified then the ordering matching rule defined for the sort key attribute is used.
-
-
Method Detail
-
getAttributeID
public String getAttributeID()
Retrieves the attribute ID of the sort key.- Returns:
- The non-null Attribute ID of the sort key.
-
isAscending
public boolean isAscending()
Determines the sort order.- Returns:
- true if the sort order is ascending, false if descending.
-
getMatchingRuleID
public String getMatchingRuleID()
Retrieves the matching rule ID used to order the attribute values.- Returns:
- The possibly null matching rule ID. If null then the ordering matching rule defined for the sort key attribute is used.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
16/11/2024 18:07:17 Cette version de la page est en cache (à la date du 16/11/2024 18:07:17) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/naming/ldap/sortkey.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.