public abstract class InsightInputFilter
extends java.lang.Object
Constructor and Description |
---|
InsightInputFilter() |
Modifier and Type | Method and Description |
---|---|
abstract ListDataItem |
findClosestDataItem(ListDataItem[] dataList, java.lang.String name)
Utility routine to find the
ListDataItem with display name, as returned by getName() that is closest to the provided name. |
abstract java.lang.String |
findCommonPrefix(ListDataItem[] dataList, java.lang.String name)
Utility routine to find the common prefix of
ListDataItems the data list that begin with the specified name. |
abstract ListDataItem[] |
getMatchingData(ListDataItem[] dataList, java.lang.String prefix)
Utility routine which fetches the subset of data items in this list model that starts with the given prefix specified.
|
protected abstract void |
sortData(ListDataItem[] dataList) |
protected abstract void sortData(ListDataItem[] dataList)
public abstract ListDataItem findClosestDataItem(ListDataItem[] dataList, java.lang.String name)
ListDataItem
with display name, as returned by getName()
that is closest to the provided name. For example, suppose the user had the following items in the list:
If the passed in name is "equalsFoo()", the data item returned will be "equalsIgnoreCase()". If the passed in name is "regionMatches()", the data item returned will be "substring()".
This utility routine can be used by clients to help locate the closest data item that should be selected in an insight list so that the list tracks what the user is typing.
name
- the display name to find the closest data item forpublic abstract ListDataItem[] getMatchingData(ListDataItem[] dataList, java.lang.String prefix)
prefix
- the prefix to search for matching itemspublic abstract java.lang.String findCommonPrefix(ListDataItem[] dataList, java.lang.String name)
ListDataItems
the data list that begin with the specified name. As with findClosestDataItem()
, the name of the ListDataItem
used is what is returned by getName()
.
If there are no items that start with the specified name, an empty (zero-length) String will be returned.