|
|||||||||
| Home >> All >> com >> RuntimeCollective >> search >> [ bean overview ] | PREV NEXT | ||||||||
A
- addCriterion(SearchCriterion) - Method in class com.RuntimeCollective.search.bean.Search
- Adds a criterion to this search.
- allResults - Variable in class com.RuntimeCollective.search.bean.SearchResults
C
- cleanCriterion(String) - Static method in class com.RuntimeCollective.search.bean.SearchCriterion
- Replaces +, -, :, ( and ) with a space in the given String, using Oro regular expressions
- com.RuntimeCollective.search.bean - package com.RuntimeCollective.search.bean
- The Search module uses Jakarta Lucene to provide a (hopefully) flexible search facility for Java objects.
- criteria - Variable in class com.RuntimeCollective.search.bean.Search
- criterion - Variable in class com.RuntimeCollective.search.bean.SearchCriterion
D
- DEFAULT_WEIGHT - Static variable in class com.RuntimeCollective.search.bean.SearchCriterion
- doc - Variable in class com.RuntimeCollective.search.bean.SearchResult
F
- field - Variable in class com.RuntimeCollective.search.bean.SearchCriterion
- findAllWords - Variable in class com.RuntimeCollective.search.bean.SearchCriterion
G
- getAllResults() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Return a List that contains all the SearchResult objects in this collection.
- getCriteria() - Method in class com.RuntimeCollective.search.bean.Search
- Gets an Iterator of
SearchCriterionobjects, that have been added to this search - getCriteriaAsArray() - Method in class com.RuntimeCollective.search.bean.Search
- getCriterion() - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Get the keywords, or phrase, to search for
- getDocument() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the Document, useful for doing some complex post-processing.
- getField() - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Get the Field to limit this criterion to (optional)
- getFields() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Get a Collection of Strings, for every Field that can be searched for on this object.
- getFindAllWords() - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Get Whether to search for all of these words (true), or any of them (false)
- getFirstCriterion() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Return a string of the first search criteria given for this search.
- getFirstFindAllWords() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Return the value of the first search criteria's
findAllWords. - getHasNextPage() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Returns
trueif there is another search results page - getHasPreviousPage() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Returns
trueif there is a previous search results page - getIndex() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the index of this search result.
- getLink() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get a link that will display this search result
- getLink() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Get a link that will display this object (ok, so this is a bit of a hack - there must be a better way)
- getMaxNoResults() - Method in class com.RuntimeCollective.search.bean.Search
- Get the max number of results.
- getMaxPageNumber() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Get the highest page number available
- getNumberOfResults() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Returns the number of search results
- getPageNumber() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Get which "page" of results will be returned by getPageResults()
- getPageResults() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Return a List that contains the next set of SearchResult objects in this collection.
- getQuery() - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Returns a Lucene query string for searching for the given criteria
- getResults() - Method in class com.RuntimeCollective.search.bean.Search
- getResultsPerPage() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Get the number of results to return with getPageResults()
- getScore() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the score, or ranking, of this search result.
- getSearchCriteriaObjects() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Return an array of SearchCriteria.
- getSearchSummary() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Get a short, one paragraph summary for this searchable object.
- getSearchText() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the full text of the this search result.
- getSearchText() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Get all text for this object that will be searched on.
- getSearchTitle() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Get a one-line title for this searchable object.
- getSearchable() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the Searchable object that this search result refers to.
- getSummary() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the summary of this search result.
- getTitle() - Method in class com.RuntimeCollective.search.bean.SearchResult
- Get the title of the this search result.
- getUseAndNotOr() - Method in class com.RuntimeCollective.search.bean.Search
- Get the max number of results.
- getUser() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Returns the User who performed this Search
- getWeight() - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Get the Weight, default to DEFAULT_WEIGHT
I
- index - Variable in class com.RuntimeCollective.search.bean.SearchResult
L
- logCriteria() - Method in class com.RuntimeCollective.search.bean.Search
- Log the search criteria in the database
M
- main(String[]) - Static method in class com.RuntimeCollective.search.bean.SearchCriterion
- maxNoResults - Variable in class com.RuntimeCollective.search.bean.Search
- The max number of results that you want to get, NO_MAX_NO_RESULTS if no limit.
N
- NO_MAX_NO_RESULTS - Static variable in class com.RuntimeCollective.search.bean.Search
- When no max number of results is set.
- nextPage() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Advance one page; returns false if there is no next page
- numberOfDoubleQuotes(String) - Static method in class com.RuntimeCollective.search.bean.SearchCriterion
P
- page - Variable in class com.RuntimeCollective.search.bean.SearchResults
- populateIndex() - Method in interface com.RuntimeCollective.search.bean.Searchable
- Return all Searchable objects of this class that should be added to the search index, given an empty index to populate.
- previousPage() - Method in class com.RuntimeCollective.search.bean.SearchResults
- Go back one page; returns false if there is no page before
R
- removeCriterion(SearchCriterion) - Method in class com.RuntimeCollective.search.bean.Search
- Removes a criterion from this search.
- removeResult(int) - Method in class com.RuntimeCollective.search.bean.SearchResults
- Remove one result
- resultsPerPage - Variable in class com.RuntimeCollective.search.bean.SearchResults
S
- SPECIAL_CHARACTERS - Static variable in class com.RuntimeCollective.search.bean.SearchCriterion
- These are the current reserved characters used by Lucene.
- Search - class com.RuntimeCollective.search.bean.Search.
- Represents a search query made by a user.
- Search() - Constructor for class com.RuntimeCollective.search.bean.Search
- Make a new search.
- SearchCriterion - class com.RuntimeCollective.search.bean.SearchCriterion.
- One criterion to search by.
- SearchCriterion(String) - Constructor for class com.RuntimeCollective.search.bean.SearchCriterion
- Make a new SearchCriterion, searching for any of
criterion - SearchCriterion(String, boolean) - Constructor for class com.RuntimeCollective.search.bean.SearchCriterion
- Make a new SearchCriterion
- SearchCriterion(String, String) - Constructor for class com.RuntimeCollective.search.bean.SearchCriterion
- Make a new SearchCriterion
- SearchCriterion(String, boolean, String) - Constructor for class com.RuntimeCollective.search.bean.SearchCriterion
- Make a new SearchCriterion
- SearchCriterion(String, boolean, String, int) - Constructor for class com.RuntimeCollective.search.bean.SearchCriterion
- Make a new SearchCriterion
- SearchResult - class com.RuntimeCollective.search.bean.SearchResult.
- A single search result.
- SearchResult(Document, float, int) - Constructor for class com.RuntimeCollective.search.bean.SearchResult
- Make a new SearchResult from a Lucene
document, and this document's score. - SearchResults - class com.RuntimeCollective.search.bean.SearchResults.
- A collection of SearchResult objects, with methods to access them conveniently from a jsp
- SearchResults(Hits, SearchCriterion[]) - Constructor for class com.RuntimeCollective.search.bean.SearchResults
- Make a new set of SearchResults, from a Lucene
Hitscollection. - SearchResults(Hits, SearchCriterion[], int) - Constructor for class com.RuntimeCollective.search.bean.SearchResults
- Make a new set of SearchResults, from a Lucene
Hitscollection, with a maximum size. - Searchable - interface com.RuntimeCollective.search.bean.Searchable.
- A javabean must implement this interface to be searchable.
- score - Variable in class com.RuntimeCollective.search.bean.SearchResult
- searchCategory - Static variable in interface com.RuntimeCollective.search.bean.Searchable
- The category, or section name, to "file" this object under in the search index.
- searchCriteria - Variable in class com.RuntimeCollective.search.bean.SearchResults
- searchIndex - Variable in class com.RuntimeCollective.search.bean.Search
- searchable - Variable in class com.RuntimeCollective.search.bean.SearchResult
- setAllResults(List) - Method in class com.RuntimeCollective.search.bean.SearchResults
- Set the List that contains all the SearchResult objects in this collection.
- setCriterion(String) - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Set the keywords, or phrase, to search for.
- setField(String) - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Set the Field to limit this criterion to (optional)
- setFindAllWords(boolean) - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Set Whether to search for all of these words (true), or any of them (false)
- setIndex(int) - Method in class com.RuntimeCollective.search.bean.SearchResult
- Set the index of this search result.
- setMaxNoResults(int) - Method in class com.RuntimeCollective.search.bean.Search
- Set the max number of results.
- setNoMaxNoResults() - Method in class com.RuntimeCollective.search.bean.Search
- Say we don't want to have any max number of results for this query.
- setPageNumber(int) - Method in class com.RuntimeCollective.search.bean.SearchResults
- Directly select which "page" of results to return with getPageResults().
- setResultsPerPage(int) - Method in class com.RuntimeCollective.search.bean.SearchResults
- Set the number of results to return with getPageResults()
- setUseAndNotOr(boolean) - Method in class com.RuntimeCollective.search.bean.Search
- Set the max number of results.
- setUser(User) - Method in class com.RuntimeCollective.search.bean.SearchResults
- Set the User who performed this Search
- setWeight(int) - Method in class com.RuntimeCollective.search.bean.SearchCriterion
- Set the Weight, default to DEFAULT_WEIGHT
T
- TheUser - Variable in class com.RuntimeCollective.search.bean.SearchResults
U
- useAndNotOr - Variable in class com.RuntimeCollective.search.bean.Search
- Whether to use AND (the default) or OR to join the criteria.
W
- weight - Variable in class com.RuntimeCollective.search.bean.SearchCriterion
A C D F G I L M N P R S T U W
|
|||||||||
| Home >> All >> com >> RuntimeCollective >> search >> [ bean overview ] | PREV NEXT | ||||||||