StringSearch

public final class StringSearch
extends SearchIterator

StringSearch是一个SearchIterator ，它根据RuleBasedCollator对象中定义的比较规则提供对语言敏感的文本搜索。 StringSearch确保可以处理语言偏心，例如对于德语整理者来说，如果选择被忽略的情况，字符和SS将匹配。 有关更多信息，请参阅"ICU Collation Design Document" 。

有两种匹配选项可供选择：
令S'为偏移量开始和结束[开始，结束]之间的文本串S的子串。
模式字符串P匹配偏移量[开始，结束] if处的文本字符串S.

 
 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.
 

此搜索的API与其他文本迭代机制（如BreakIterator的中断迭代器） BreakIterator 。 使用这些API可以很容易地扫描文本，查找给定模式的所有事件。 此搜索迭代器允许通过调用reset()后跟next()或previous()来更改方向。 尽管可以在不致电reset()情况下改变方向，但这种操作会带来一些速度上的损失。 正向匹配结果将按相反顺序匹配反向结果匹配

SearchIterator提供API来指定文本字符串中的起始位置进行搜索，比如setIndex ， preceding和following 。 由于起始位置将按照规定进行设置，请注意，有些危险点可能导致搜索结果不正确：

• In the midst of a substring that requires normalization.
• If the following match is to be found, the position should not be the second character which requires swapping with the preceding character. Vice versa, if the preceding match is to be found, the position to search from should not be the first character which requires swapping with the next character. E.g certain Thai and Lao characters require swapping.
• If a following pattern match is to be found, any position within a contracting sequence except the first will fail. Vice versa if a preceding pattern match is to be found, an invalid starting point would be any character within a contracting sequence except the last.

如果只希望在逻辑中断处匹配，则可以使用BreakIterator 。 使用BreakIterator只会为您提供与BreakIterator给出的边界完全匹配的结果。 例如，如果使用字符中断迭代器，则字符串“Ô中将不会找到模式“e”。

提供选项来处理重叠匹配。 例如，在英语中，重叠匹配为文本“ababab”中的模式“abab”生成结果0和2，其中相互排斥的匹配仅产生0的结果。

还提供了选项，以实现 UTS #10 Unicode Collation Algorithm中所述的“非对称搜索”，特别是ElementComparisonType值。

虽然在执行匹配时会考虑到collator属性，但在这里没有用于设置和获取属性的API。 这些属性可以通过从getCollator()获取整理器并使用getCollator()中的API来RuleBasedCollator 。 最后要将StringSearch更新为新的reset()属性，必须调用reset() 。

限制：
目前，没有组合字符由组合类> 0的字符与组合类== 0之前的字符组成。但是，如果将来存在此类字符，则StringSearch不保证选项1的结果。

请参阅 SearchIterator文档以获取有关如何使用此类实例来实现文本搜索的信息和示例。

请注意， StringSearch不会被分类。

Summary

Inherited constants
From class android.icu.text.SearchIterator int DONE 在返回所有有效的匹配之后，DONE由previous（）和next（）返回，如果根本没有匹配，则由first（）和last（）返回。

Inherited fields
From class android.icu.text.SearchIterator protected BreakIterator breakIterator BreakIterator来定义逻辑匹配的边界。 protected int matchLength 目标文本中最新匹配的长度。 protected CharacterIterator targetText 搜索目标文本。

Inherited methods
From class android.icu.text.SearchIterator final int first() 返回字符串文本与搜索模式匹配的第一个索引。 final int following(int position) 返回等于或大于 position的第一个索引，其中字符串文本与搜索模式匹配。 BreakIterator getBreakIterator() 返回用于限制检测到匹配的索引的BreakIterator。 SearchIterator.ElementComparisonType getElementComparisonType() 返回排序规则元素比较类型。 abstract int getIndex() 返回正在搜索的文本中的当前索引。 int getMatchLength() 返回匹配搜索模式的字符串中的文本长度。 int getMatchStart() 返回搜索到的文本字符串中匹配的索引。 String getMatchedText() 返回由最近一次调用匹配文本 first() ， next() ， previous() ，或 last() 。 CharacterIterator getTarget() 返回要搜索的字符串文本。 abstract int handleNext(int start) 子类重写的抽象方法，提供在目标文本中查找下一个匹配的机制。 abstract int handlePrevious(int startAt) 抽象方法，它重写子类以提供在目标文本中查找先前匹配的机制。 boolean isOverlapping() 如果重叠属性已设置，则返回true。 final int last() 返回目标文本中与搜索模式匹配的最后一个索引。 int next() 从当前位置开始，返回文本与搜索模式匹配的下一个点的索引。迭代器将进行调整，以使其当前索引（如 getIndex()所返回的 getIndex() ）是匹配位置（如果找到了匹配位置）。 final int preceding(int position) 返回小于 position的第一个索引，其中字符串文本与搜索模式匹配。 int previous() 从当前位置开始，返回字符串文本与搜索模式匹配的前一个点的索引。 void reset() 重置迭代。 void setBreakIterator(BreakIterator breakiter) 设置将用于限制检测到匹配点的BreakIterator。 void setElementComparisonType(SearchIterator.ElementComparisonType type) 设置排序规则元素比较类型。 void setIndex(int position) 设置下一次搜索将开始的目标文本中的位置。 void setMatchLength(int length) 设置目标文本中最近一次匹配的长度。 void setOverlapping(boolean allowOverlap) 确定是否返回重叠匹配。 void setTarget(CharacterIterator text) 设置要搜索的目标文本。
From class java.lang.Object Object clone() 创建并返回此对象的副本。 boolean equals(Object obj) 指示其他某个对象是否“等于”这一个。 void finalize() 当垃圾收集确定没有更多对该对象的引用时，由对象上的垃圾回收器调用。 final Class<?> getClass() 返回此 Object的运行时类。 int hashCode() 返回对象的哈希码值。 final void notify() 唤醒正在等待该对象监视器的单个线程。 final void notifyAll() 唤醒在该对象监视器上等待的所有线程。 String toString() 返回对象的字符串表示形式。 final void wait(long millis, int nanos) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法，或者某个其他线程中断当前线程，或经过一定的实时时间。 final void wait(long millis) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法或经过了指定的时间量。 final void wait() 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法。

Public constructors

StringSearch (String pattern, 
                CharacterIterator target, 
                RuleBasedCollator collator, 
                BreakIterator breakiter)

StringSearch (String pattern, 
                CharacterIterator target, 
                RuleBasedCollator collator)

StringSearch (String pattern, 
                CharacterIterator target, 
                Locale locale)

StringSearch (String pattern, 
                CharacterIterator target, 
                ULocale locale)

StringSearch (String pattern, 
                String target)

Public methods

RuleBasedCollator getCollator ()

int getIndex ()

String getPattern ()

boolean isCanonical ()

void reset ()

void setCanonical (boolean allowCanonical)

void setCollator (RuleBasedCollator collator)

void setIndex (int position)

void setPattern (String pattern)

void setTarget (CharacterIterator text)

Protected methods

int handleNext (int position)

int handlePrevious (int position)