|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectutil.ui.SearchFormSettings
public class SearchFormSettings
Settings for the SearchForm
SearchForm| Field Summary | |
|---|---|
static int |
MATCH_EXACTLY
Deprecated. Since 1.1. Use PluginManager.SEARCHER_TYPE_EXACTLY instead. |
static int |
MATCH_KEYWORD
Deprecated. Since 1.1. Use PluginManager.SEARCHER_TYPE_KEYWORD instead. |
static int |
MATCH_REGULAR_EXPRESSION
Deprecated. Since 1.1. Use PluginManager.SEARCHER_TYPE_REGULAR_EXPRESSION instead. |
static int |
SEARCH_IN_ALL
Specifies, that all fields should be searched. |
static int |
SEARCH_IN_TITLE
Specifies, that only titles should be searched. |
static int |
SEARCH_IN_USER_DEFINED
Specifies, that a user-defined set of fields should be searched. |
| Constructor Summary | |
|---|---|
SearchFormSettings(ObjectInputStream in)
Loads a SearchFormSettings instance from a stream. |
|
SearchFormSettings(String searchText)
Creates a new SearchFormSettings instance. |
|
| Method Summary | |
|---|---|
ProgramSearcher |
createSearcher()
Creates a searcher from these settings |
ProgramSearcher |
createSearcher(String text)
Creates a searcher from this settings |
boolean |
getCaseSensitive()
Gets whether to search case sensitive. |
Channel[] |
getChannels()
Get the Channels to search on This returns null when all channels should be searched |
ProgramFieldType[] |
getFieldTypes()
Gets the field types to search for. |
int |
getMatch()
Deprecated. Since 1.1. Use getSearcherType() instead. |
int |
getNrDays()
Gets the number of days If this value is negative, it searches all data (including yesterday) |
int |
getSearcherType()
Gets the searcher type to be used. |
int |
getSearchIn()
Gets where to search. |
String |
getSearchText()
Gets the search text. |
String |
getSearchTextAsRegex()
Deprecated. Since 1.1. Use createSearcher() instead. |
ProgramFieldType[] |
getUserDefinedFieldTypes()
Gets the field types defined by the user. |
void |
setCaseSensitive(boolean caseSensitive)
Sets whether to search case sensitive. |
void |
setChannels(Channel[] channel)
|
void |
setMatch(int match)
Deprecated. Since 1.1. Use getSearcherType() instead. |
void |
setNrDays(int nr)
Sets the number of days If this value is negative, it searches all data (including yesterday) |
void |
setSearcherType(int searcherType)
Sets the searcher type to be used. |
void |
setSearchIn(int searchIn)
Sets where to search. |
void |
setSearchText(String searchText)
Sets the search text. |
void |
setUserDefinedFieldTypes(ProgramFieldType[] typeArr)
Sets the user-defined field types to search for. |
String |
toString()
Gets the search text. |
void |
writeData(ObjectOutputStream out)
Writes the settings into a stream |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int MATCH_EXACTLY
PluginManager.SEARCHER_TYPE_EXACTLY instead.
public static final int MATCH_KEYWORD
PluginManager.SEARCHER_TYPE_KEYWORD instead.
public static final int MATCH_REGULAR_EXPRESSION
PluginManager.SEARCHER_TYPE_REGULAR_EXPRESSION instead.
public static final int SEARCH_IN_TITLE
public static final int SEARCH_IN_ALL
public static final int SEARCH_IN_USER_DEFINED
setUserDefinedFieldTypes(ProgramFieldType[]),
Constant Field Values| Constructor Detail |
|---|
public SearchFormSettings(String searchText)
searchText - The search text
public SearchFormSettings(ObjectInputStream in)
throws IOException,
ClassNotFoundException
in - The stream to read from
IOException - If reading failed
ClassNotFoundException - If the read data has the wrong formatwriteData(ObjectOutputStream)| Method Detail |
|---|
public void writeData(ObjectOutputStream out)
throws IOException
out - The stream to write to
IOException - If writing failedSearchFormSettings(ObjectInputStream)public String toString()
toString in class Objectpublic String getSearchText()
public void setSearchText(String searchText)
searchText - The search text
public ProgramSearcher createSearcher()
throws TvBrowserException
TvBrowserException - If creating the searcher failed.
public ProgramSearcher createSearcher(String text)
throws TvBrowserException
text - Search for this Text
TvBrowserException - If creating the searcher failed.public String getSearchTextAsRegex()
createSearcher() instead.
public ProgramFieldType[] getFieldTypes()
public ProgramFieldType[] getUserDefinedFieldTypes()
public void setUserDefinedFieldTypes(ProgramFieldType[] typeArr)
typeArr - The field types to search forpublic int getSearchIn()
SEARCH_IN_TITLE,
SEARCH_IN_ALL or SEARCH_IN_USER_DEFINED.
public void setSearchIn(int searchIn)
SEARCH_IN_TITLE,
SEARCH_IN_ALL or SEARCH_IN_USER_DEFINED.
searchIn - Where to searchpublic int getSearcherType()
PluginManager.createProgramSearcher(int, String, boolean)public void setSearcherType(int searcherType)
searcherType - The searcher type to be used.PluginManager.createProgramSearcher(int, String, boolean)public int getMatch()
getSearcherType() instead.
public void setMatch(int match)
getSearcherType() instead.
match - How the search text has to match.public boolean getCaseSensitive()
public void setCaseSensitive(boolean caseSensitive)
caseSensitive - Whether to search case sensitivepublic int getNrDays()
public void setNrDays(int nr)
nr - number of days to searchpublic Channel[] getChannels()
public void setChannels(Channel[] channel)
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||