Package net.sf.saxon.expr.sort
Class RuleBasedSubstringMatcher
java.lang.Object
net.sf.saxon.expr.sort.RuleBasedSubstringMatcher
- All Implemented Interfaces:
Serializable
,StringCollator
,SubstringMatcher
This class wraps a RuleBasedCollator to provide a SubstringMatcher. This
users the facilities offered by the RuleBasedCollator to implement the XPath
functions contains(), starts-with(), ends-with(), substring-before(), and
substring-after().
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionRuleBasedSubstringMatcher
(RuleBasedCollator collator) Create a RuleBasedSubstringMatcher -
Method Summary
Modifier and TypeMethodDescriptionboolean
comparesEqual
(String s1, String s2) Test whether one string is equal to another, according to the rules of the XPath compare() function.int
compareStrings
(String o1, String o2) Compare two stringsboolean
Test whether one string contains another, according to the rules of the XPath contains() functionboolean
Test whether one string ends with another, according to the rules of the XPath ends-with() functionGet a collation key for two Strings.Get the underlying RuleBasedCollatorstatic void
Test program to output the sequence of collation element iterators for a given input stringboolean
startsWith
(String s1, String s2) Test whether one string starts with another, according to the rules of the XPath starts-with() functionsubstringAfter
(String s1, String s2) Return the part of a string after a given substring, according to the rules of the XPath substring-after() functionsubstringBefore
(String s1, String s2) Return the part of a string before a given substring, according to the rules of the XPath substring-before() function
-
Constructor Details
-
RuleBasedSubstringMatcher
Create a RuleBasedSubstringMatcher- Parameters:
collator
- the collation to be used
-
-
Method Details
-
getUnderlyingCollator
Get the underlying RuleBasedCollator- Returns:
- the RuleBasedCollator that does the work
-
comparesEqual
Test whether one string is equal to another, according to the rules of the XPath compare() function. The result is true if and only if the compare() method returns zero: but the implementation may be more efficient than calling compare and testing the result for zero- Specified by:
comparesEqual
in interfaceStringCollator
- Parameters:
s1
- the first strings2
- the second string- Returns:
- true iff s1 equals s2
-
contains
Test whether one string contains another, according to the rules of the XPath contains() function- Specified by:
contains
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 contains s2
-
endsWith
Test whether one string ends with another, according to the rules of the XPath ends-with() function- Specified by:
endsWith
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 ends with s2
-
startsWith
Test whether one string starts with another, according to the rules of the XPath starts-with() function- Specified by:
startsWith
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 starts with s2
-
substringAfter
Return the part of a string after a given substring, according to the rules of the XPath substring-after() function- Specified by:
substringAfter
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- the part of s1 that follows the first occurrence of s2
-
substringBefore
Return the part of a string before a given substring, according to the rules of the XPath substring-before() function- Specified by:
substringBefore
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- the part of s1 that precedes the first occurrence of s2
-
compareStrings
Compare two strings- Specified by:
compareStrings
in interfaceStringCollator
- Parameters:
o1
- the first stringo2
- the second string- Returns:
- 0 if the strings are considered equal, a negative integer if the first string is less than the second, a positive integer if the first string is greater than the second
-
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
-
main
Test program to output the sequence of collation element iterators for a given input string- Parameters:
args
- command line arguments (collationURI, test-string)- Throws:
Exception
-