- * 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.
*
* Caller may modify but must not delete the RuleBasedCollator!
- * Modifications to this collator will affect the original collator passed in to
- * the StringSearch>/tt> constructor or to setCollator, if any.
+ * Modifications to this collator will affect the original collator passed in to
+ * the StringSearch> constructor or to setCollator, if any.
* @return collator used for string search
* @stable ICU 2.0
*/
@@ -351,9 +366,7 @@ public:
/**
* Sets the collator used for the language rules. User retains the
* ownership of this collator, thus the responsibility of deletion lies
- * with the user. This method causes internal data such as Boyer-Moore
- * shift tables to be recalculated, but the iterator's position is
- * unchanged.
+ * with the user. The iterator's position will not be changed by this method.
* @param coll collator
* @param status for errors if any
* @stable ICU 2.0
@@ -362,8 +375,7 @@ public:
/**
* Sets the pattern used for matching.
- * Internal data like the Boyer Moore table will be recalculated, but
- * the iterator's position is unchanged.
+ * The iterator's position will not be changed by this method.
* @param pattern search pattern to be found
* @param status for errors if any. If the pattern length is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
@@ -403,16 +415,16 @@ public:
/**
* ICU "poor man's RTTI", returns a UClassID for the actual class.
*
- * @draft ICU 2.2
+ * @stable ICU 2.2
*/
- virtual inline UClassID getDynamicClassID() const;
+ virtual UClassID getDynamicClassID() const;
/**
* ICU "poor man's RTTI", returns a UClassID for this class.
*
- * @draft ICU 2.2
+ * @stable ICU 2.2
*/
- static inline UClassID getStaticClassID();
+ static UClassID U_EXPORT2 getStaticClassID();
protected:
@@ -421,15 +433,15 @@ protected:
/**
* Search forward for matching text, starting at a given location.
* Clients should not call this method directly; instead they should
- * call {@link SearchIterator#next}.
+ * call {@link SearchIterator#next }.
*
* If a match is found, this method returns the index at which the match
- * starts and calls {@link SearchIterator#setMatchLength} with the number
+ * starts and calls {@link SearchIterator#setMatchLength } with the number
* of characters in the target text that make up the match. If no match
* is found, the method returns USEARCH_DONE.
*
* The StringSearch is adjusted so that its current index
- * (as returned by {@link #getOffset()}) is the match position if one was
+ * (as returned by {@link #getOffset }) is the match position if one was
* found.
* If a match is not found, USEARCH_DONE will be returned and
* the StringSearch will be adjusted to the index USEARCH_DONE.
@@ -448,12 +460,12 @@ protected:
* SearchIterator.previous(), which this method overrides.
*
* If a match is found, this method returns the index at which the match
- * starts and calls {@link SearchIterator#setMatchLength} with the number
+ * starts and calls {@link SearchIterator#setMatchLength } with the number
* of characters in the target text that make up the match. If no match
* is found, the method returns USEARCH_DONE.
*
* The StringSearch is adjusted so that its current index
- * (as returned by {@link #getOffset()}) is the match position if one was
+ * (as returned by {@link #getOffset }) is the match position if one was
* found.
* If a match is not found, USEARCH_DONE will be returned and
* the StringSearch will be adjusted to the index USEARCH_DONE.
@@ -471,42 +483,19 @@ private :
// private data members ----------------------------------------------
- /**
- * RuleBasedCollator, contains exactly the same UCollator * in m_strsrch_
- * @stable ICU 2.0
- */
- RuleBasedCollator m_collator_;
/**
* Pattern text
* @stable ICU 2.0
*/
UnicodeString m_pattern_;
/**
- * Corresponding collation rules
- * @stable ICU 2.0
- */
- UnicodeString m_collation_rules_;
- /**
* String search struct data
* @stable ICU 2.0
*/
UStringSearch *m_strsrch_;
- /**
- * The address of this static class variable serves as this class's ID
- * for ICU "poor man's RTTI".
- */
- static const char fgClassID;
};
-inline UClassID
-StringSearch::getStaticClassID()
-{ return (UClassID)&fgClassID; }
-
-inline UClassID
-StringSearch::getDynamicClassID() const
-{ return StringSearch::getStaticClassID(); }
-
U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_COLLATION */
- * 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·
+ * 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());
* }
*