Package net.sf.saxon.expr.sort
Class CaseFirstCollator
java.lang.Object
net.sf.saxon.expr.sort.CaseFirstCollator
- All Implemented Interfaces:
Serializable
,StringCollator
A StringCollator that sorts lowercase before uppercase, or vice versa.
Case is irrelevant, unless the strings are equal ignoring case, in which case lowercase comes first.
- Author:
- Michael H. Kay
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCaseFirstCollator
(StringCollator base, boolean upperFirst) Create a CaseFirstCollator -
Method Summary
Modifier and TypeMethodDescriptionboolean
comparesEqual
(String s1, String s2) Compare two strings for equality.int
compareStrings
(String a, String b) Compare two string objects: case is irrelevant, unless the strings are equal ignoring case, in which case lowercase comes first.Get a collation key for two Strings.
-
Constructor Details
-
CaseFirstCollator
Create a CaseFirstCollator- Parameters:
base
- the base collator, which determines how characters are sorted irrespective of caseupperFirst
- true if uppercase precedes lowercase, false otherwise
-
-
Method Details
-
compareStrings
Compare two string objects: case is irrelevant, unless the strings are equal ignoring case, in which case lowercase comes first.- Specified by:
compareStrings
in interfaceStringCollator
- Parameters:
a
- the first stringb
- the second string- Returns:
- invalid input: '<'0 if ainvalid input: '<'b, 0 if a=b, >0 if a>b
- Throws:
ClassCastException
- if the objects are of the wrong type for this Comparer
-
comparesEqual
Compare two strings for equality. This may be more efficient than using compareStrings and testing whether the result is zero, but it must give the same result- Specified by:
comparesEqual
in interfaceStringCollator
- Parameters:
s1
- the first strings2
- the second string- Returns:
- true if and only if the strings are considered equal,
-
getCollationKey
Get a collation key for two Strings. The essential property of collation keys is that if two values are equal under the collation, then the collation keys are compare correctly under the equals() method.- Specified by:
getCollationKey
in interfaceStringCollator
- Parameters:
s
- the string whose collation key is required- Returns:
- the collation key
-