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)
Method Summary
intcompare(Object o1, Object o2)
Compares its two arguments for order.
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
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)

Method Detail

compare

public int compare(Object o1, Object o2)
Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z.

It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Parameters: o1 the first object to be compared. o2 the second object to be compared.

Returns: a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Throws: ClassCastException if the arguments' types prevent them from being compared by this Comparator.

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

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