com.atakmap.android.preference

Class PreferenceSearchIndex

java.lang.Object

com.atakmap.android.preference.PreferenceSearchIndex

public class PreferenceSearchIndex
extends java.lang.Object

Index to support searching preferences

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreferenceSearchIndex.MatchResults Results of match to include a matched term (may have matched multiple) and a score

Constructor Summary

Constructors

Constructor and Description
PreferenceSearchIndex(java.lang.Class<? extends AtakPreferenceFragment> fragClass, java.lang.String parentKey, java.lang.String key, java.lang.String summary, java.lang.String parentSummary, android.graphics.drawable.Drawable icon, java.util.List<java.lang.String> terms) Create index for an individual preference

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends AtakPreferenceFragment>	getFragClass() Gets the ATAK preference fragment that this search index represents.
android.graphics.drawable.Drawable	getIcon()
java.lang.String	getKey() Gets the preference key for the preference described by the search index.
PreferenceSearchIndex.MatchResults	getMatch() Get results of last match
PreferenceSearchIndex.MatchResults	getMatch(java.lang.String searchTerms) Match on the search terms
java.lang.String	getParentKey() Gets the parent key for the search index.
java.lang.String	getParentSummary() Gets the parent summary for the search index.
java.lang.String	getSummary() Gets the preference summary for the preference described by the search index.
java.util.List<java.lang.String>	getTerms()
boolean	hasIcon() Checks to see if the preference has a icon
boolean	match(java.lang.String searchTerms)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PreferenceSearchIndex

public PreferenceSearchIndex(java.lang.Class<? extends AtakPreferenceFragment> fragClass,
                             java.lang.String parentKey,
                             java.lang.String key,
                             java.lang.String summary,
                             java.lang.String parentSummary,
                             android.graphics.drawable.Drawable icon,
                             java.util.List<java.lang.String> terms)

Create index for an individual preference

Parameters:

fragClass - Class/type of parent Preference/screen

key - Key of the preference

summary - Summary/label of the preference

parentSummary - Summary/label of the parent preference

icon - Icon of the preference

terms - Terms to match on when searching

Method Detail

getFragClass

public java.lang.Class<? extends AtakPreferenceFragment> getFragClass()

Gets the ATAK preference fragment that this search index represents.

Returns:

the ATAK preference fragment

getParentSummary

public java.lang.String getParentSummary()

Gets the parent summary for the search index.

Returns:

the parent summary

getParentKey

public java.lang.String getParentKey()

Gets the parent key for the search index.

Returns:

the parent key

getKey

public java.lang.String getKey()

Gets the preference key for the preference described by the search index.

Returns:

the preference key

getSummary

public java.lang.String getSummary()

Gets the preference summary for the preference described by the search index.

Returns:

the preference summary

hasIcon

public boolean hasIcon()

Checks to see if the preference has a icon

Returns:

true if the preference has an icon

getIcon

public android.graphics.drawable.Drawable getIcon()

getTerms

public java.util.List<java.lang.String> getTerms()

match

public boolean match(java.lang.String searchTerms)

getMatch

public PreferenceSearchIndex.MatchResults getMatch(java.lang.String searchTerms)

Match on the search terms

Parameters:

searchTerms - the search term to look for.

Returns:

null if no match, otherwise a scored/weighted result

getMatch

public PreferenceSearchIndex.MatchResults getMatch()

Get results of last match

Returns:

the Match Results based on a search.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object