net.sf.saxon.sort

Class RuleBasedSubstringMatcher

public class RuleBasedSubstringMatcher extends Object implements 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().
Constructor Summary
RuleBasedSubstringMatcher(RuleBasedCollator collator)
Create a RuleBasedSubstringMatcher
Method Summary
booleancomparesEqual(String s1, String s2)
Test whether one string is equal to another, according to the rules of the XPath compare() function.
intcompareStrings(String o1, String o2)
Compare two strings
booleancontains(String s1, String s2)
Test whether one string contains another, according to the rules of the XPath contains() function
booleanendsWith(String s1, String s2)
Test whether one string ends with another, according to the rules of the XPath ends-with() function
ObjectgetCollationKey(String s)
Get a collation key for two Strings.
static voidmain(String[] args)
Test program to output the sequence of collation element iterators for a given input string
booleanstartsWith(String s1, String s2)
Test whether one string starts with another, according to the rules of the XPath starts-with() function
StringsubstringAfter(String s1, String s2)
Return the part of a string after a given substring, according to the rules of the XPath substring-after() function
StringsubstringBefore(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 Detail

RuleBasedSubstringMatcher

public RuleBasedSubstringMatcher(RuleBasedCollator collator)
Create a RuleBasedSubstringMatcher

Parameters: collator the collation to be used

Method Detail

comparesEqual

public boolean comparesEqual(String s1, String s2)
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

Parameters: s1 the first string s2 the second string

Returns: true iff s1 equals s2

compareStrings

public int compareStrings(String o1, String o2)
Compare two strings

Parameters: o1 the first string o2 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

contains

public boolean contains(String s1, String s2)
Test whether one string contains another, according to the rules of the XPath contains() function

Parameters: s1 the containing string s2 the contained string

Returns: true iff s1 contains s2

endsWith

public boolean endsWith(String s1, String s2)
Test whether one string ends with another, according to the rules of the XPath ends-with() function

Parameters: s1 the containing string s2 the contained string

Returns: true iff s1 ends with s2

getCollationKey

public Object getCollationKey(String s)
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.

main

public static void main(String[] args)
Test program to output the sequence of collation element iterators for a given input string

Parameters: args command line arguments (collationURI, test-string)

startsWith

public boolean startsWith(String s1, String s2)
Test whether one string starts with another, according to the rules of the XPath starts-with() function

Parameters: s1 the containing string s2 the contained string

Returns: true iff s1 starts with s2

substringAfter

public String substringAfter(String s1, String s2)
Return the part of a string after a given substring, according to the rules of the XPath substring-after() function

Parameters: s1 the containing string s2 the contained string

Returns: the part of s1 that follows the first occurrence of s2

substringBefore

public String substringBefore(String s1, String s2)
Return the part of a string before a given substring, according to the rules of the XPath substring-before() function

Parameters: s1 the containing string s2 the contained string

Returns: the part of s1 that precedes the first occurrence of s2