- * The algorithm implemented is a modified form of the Boyer Moore's search. - * For more information see - * - * "Efficient Text Searching in Java", published in Java Report - * in February, 1999, for further information on the algorithm. *
* There are 2 match options for selection:
* This search has APIs similar to that of other text iteration mechanisms
* such as the break iterators in BreakIterator. Using these
- * APIs, it is easy to scan through text looking for all occurances of
+ * APIs, it is easy to scan through text looking for all occurrences of
* a given pattern. This search iterator allows changing of direction by
- * calling a reset followed by a next or previous.
- * Though a direction change can occur without calling reset first,
+ * calling a reset followed by a next or previous.
+ * Though a direction change can occur without calling reset first,
* this operation comes with some speed penalty.
- * Match results in the forward direction will match the result matches in
+ * Match results in the forward direction will match the result matches in
* the backwards direction in the reverse order
*
- * SearchIterator provides APIs to specify the starting position
+ * SearchIterator provides APIs to specify the starting position
* within the text string to be searched, e.g. setOffset,
- * preceding and following. Since the
- * starting position will be set as it is specified, please take note that
- * there are some danger points which the search may render incorrect
+ * preceding and following. Since the
+ * starting position will be set as it is specified, please take note that
+ * there are some danger points which the search may render incorrect
* results:
*
- * A breakiterator can be used if only matches at logical breaks are desired.
- * Using a breakiterator will only give you results that exactly matches the
+ * A BreakIterator can be used if only matches at logical breaks are desired.
+ * Using a BreakIterator will only give you results that exactly matches the
* boundaries given by the breakiterator. For instance the pattern "e" will
* not be found in the string "\u00e9" if a character break iterator is used.
*
- * Options are provided to handle overlapping matches.
- * E.g. In English, overlapping matches produces the result 0 and 2
- * for the pattern "abab" in the text "ababab", where else mutually
+ * Options are provided to handle overlapping matches.
+ * E.g. In English, overlapping matches produces the result 0 and 2
+ * for the pattern "abab" in the text "ababab", where else mutually
* exclusive matches only produce the result of 0.
*
- * Though collator attributes will be taken into consideration while
- * performing matches, there are no APIs here for setting and getting the
+ * Though collator attributes will be taken into consideration while
+ * performing matches, there are no APIs here for setting and getting the
* attributes. These attributes can be set by getting the collator
* from getCollator and using the APIs in coll.h.
- * Lastly to update StringSearch to the new collator attributes,
- * reset() has to be called.
+ * Lastly to update StringSearch to the new collator attributes,
+ * reset has to be called.
*
* Restriction:
* Consult the SearchIterator documentation for information on
* and examples of how to use instances of this class to implement text
* searching.
*
- * Note, StringSearch is not to be subclassed.
+ * Note, StringSearch is not to be subclassed.
*
- * Let S' be the sub-string of a text string S between the offsets start and
- * end
- * A pattern string P matches a text string S at the offsets
- * option 1. Some canonical equivalent of P matches some canonical equivalent
+ * option 1. Some canonical equivalent of P matches some canonical equivalent
* of S'
- * option 2. P matches S' and if P starts or ends with a combining mark,
- * there exists no non-ignorable combining mark before or after S?
- * in S respectively.
+ * option 2. P matches S' and if P starts or ends with a combining mark,
+ * there exists no non-ignorable combining mark before or after S?
+ * in S respectively.
*
* Option 2. will be the default.
*
*
*
* Currently there are no composite characters that consists of a
- * character with combining class > 0 before a character with combining
- * class == 0. However, if such a character exists in the future,
- * StringSearch does not guarantee the results for option 1.
+ * character with combining class > 0 before a character with combining
+ * class == 0. However, if such a character exists in the future,
+ * StringSearch does not guarantee the results for option 1.
*
*
- * UnicodeString target("The quick brown fox jumped over the lazy fox");
+ * UnicodeString target("The quick brown fox jumps over the lazy dog.");
* UnicodeString pattern("fox");
*
- * SearchIterator *iter = new StringSearch(pattern, target);
* UErrorCode error = U_ZERO_ERROR;
- * for (int pos = iter->first(error); pos != USEARCH_DONE;
- * pos = iter->next(error)) {
+ * StringSearch iter(pattern, target, Locale::getUS(), NULL, status);
+ * for (int pos = iter.first(error);
+ * pos != USEARCH_DONE;
+ * pos = iter.next(error))
+ * {
* printf("Found match at %d pos, length is %d\n", pos,
* iter.getMatchLength());
* }
*