org.apache.directory.api.ldap.model.message.controls

Class SortKey

java.lang.Object

org.apache.directory.api.ldap.model.message.controls.SortKey

public class SortKey
extends Object

Datastructure to store the Attribute name, matching rule ID of the attribute
and the sort order.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private String	attributeTypeDesc The name/OID of AttributeType we want to use as a key for the sort
private String	matchingRuleId The matching rule to use to order the result
private boolean	reverseOrder A flag to set to true to get the result in reverse order.

Constructor Summary

Constructors

Constructor and Description
SortKey(String attributeTypeDesc) Create a new instance of a SortKey for a give AttributeType
SortKey(String attributeTypeDesc, String matchingRuleId) Create a new instance of a SortKey for a give AttributeType
SortKey(String attributeTypeDesc, String matchingRuleId, boolean reverseOrder) Create a new instance of a SortKey for a give AttributeType

Method Summary

Modifier and Type	Method and Description
String	getAttributeTypeDesc()
String	getMatchingRuleId()
boolean	isReverseOrder()
void	setAttributeTypeDesc(String attributeTypeDesc)
void	setMatchingRuleId(String matchingRuleId)
void	setReverseOrder(boolean reverseOrder)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

attributeTypeDesc

private String attributeTypeDesc

The name/OID of AttributeType we want to use as a key for the sort

matchingRuleId

private String matchingRuleId

The matching rule to use to order the result

reverseOrder

private boolean reverseOrder

A flag to set to true to get the result in reverse order. Default to false

Constructor Detail

SortKey

public SortKey(String attributeTypeDesc)

Create a new instance of a SortKey for a give AttributeType

Parameters:

attributeTypeDesc - The AttributeType's name or OID to use

SortKey

public SortKey(String attributeTypeDesc,
               String matchingRuleId)

Create a new instance of a SortKey for a give AttributeType

Parameters:

attributeTypeDesc - The AttributeType's name or OID to use

matchingRuleId - The MatchingRule to use

SortKey

public SortKey(String attributeTypeDesc,
               String matchingRuleId,
               boolean reverseOrder)

Create a new instance of a SortKey for a give AttributeType

Parameters:

attributeTypeDesc - The AttributeType OID to use

matchingRuleId - The MatchingRule to use

reverseOrder - The reverseOrder flag

Method Detail

getAttributeTypeDesc

public String getAttributeTypeDesc()

Returns:

the attributeType name or OID

setAttributeTypeDesc

public void setAttributeTypeDesc(String attributeTypeDesc)

Parameters:

attributeTypeDesc - the attributeType to set

getMatchingRuleId

public String getMatchingRuleId()

Returns:

the matchingRuleId

setMatchingRuleId

public void setMatchingRuleId(String matchingRuleId)

Parameters:

matchingRuleId - the matchingRuleId to set

isReverseOrder

public boolean isReverseOrder()

Returns:

the reverseOrder

setReverseOrder

public void setReverseOrder(boolean reverseOrder)

Parameters:

reverseOrder - the reverseOrder to set

toString

public String toString()

Overrides:

toString in class Object

See Also:

String.toString()