|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.search.SearchQuery
@StableMinor(version="6.2", sinceVersion="4.0") public class SearchQuery
Represents search criteria used to find matching information by a search engine.
Constructor Summary | |
---|---|
SearchQuery()
Constructs a SearchQuery object with neither user query and
attributes . |
|
SearchQuery(String query)
Constructs a SearchQuery object with the given user query
and no attributes . |
|
SearchQuery(String query,
SearchAttributes attributes)
Constructs a SearchQuery object with the given user query
and attributes . |
Method Summary | |
---|---|
SearchAttributes |
getAttributes()
Returns the query's attributes , that define additional information
to be passed to the search engine. |
ISearchQueryFilter |
getControlFilter()
Returns a query filter to be applied to the search. |
String |
getControlQuery()
Returns the control query, which is the system-defined portion of the query , usually containing criteria related to some metadata indexed
with the content (e.g. |
int |
getMaxRows()
Returns the maximum number of hits to be returned by the
query execution . |
int |
getStartAt()
Returns the number of the first hit to be returned by the
query execution . |
String |
getUserQuery()
Returns the user query, which is the user-defined portion of the query , usually entered by the final user using front-end interfaces. |
void |
setAttributes(SearchAttributes attributes)
Sets the query's attributes . |
void |
setControlFilter(ISearchQueryFilter controlFilter)
Sets the query filter to be applied to the search. |
void |
setControlQuery(String controlQuery)
Sets the control query . |
void |
setMaxRows(int maxRows)
Sets the maximum number of hits . |
void |
setStartAt(int startAt)
Sets the number of the first hit . |
void |
setUserQuery(String query)
Sets the user query . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SearchQuery()
SearchQuery
object with neither user query
and
attributes
.
public SearchQuery(String query)
SearchQuery
object with the given user query
and no attributes
.
query
- {@link #getUserQuery() user querypublic SearchQuery(String query, SearchAttributes attributes)
SearchQuery
object with the given user query
and attributes
.
query
- user query
attributes
- attributes
Method Detail |
---|
public SearchAttributes getAttributes()
attributes
, that define additional information
to be passed to the search engine.
attributes
public void setAttributes(SearchAttributes attributes)
query's attributes
.
attributes
- the query's attributes
public String getUserQuery()
query
, usually entered by the final user using front-end interfaces.
The search engines can and usually perform a
tokenization in the
user query in the same way they do in the contents
during the indexing process.
lumis.search
public void setUserQuery(String query)
user query
.
query
- the user query
public String getControlQuery()
query
, usually containing criteria related to some metadata indexed
with the content (e.g. service instance identifier).
The search engines must not perform a tokenization in the control query, because it usually consists in criteria for non-intelligible information (such as GUIDs).
getControlFilter()
public void setControlQuery(String controlQuery)
control query
.
controlQuery
- the control query
setControlFilter(ISearchQueryFilter)
public int getMaxRows()
hits
to be returned by the
query
execution
.
Usually this setting is used to paginate the search results
.
public void setMaxRows(int maxRows)
maximum number of hits
.
maxRows
- the maximum number of hitspublic int getStartAt()
hit
to be returned by the
query
execution
.
Usually this setting is used to paginate the search results
.
hit
public void setStartAt(int startAt)
number of the first hit
.
startAt
- the number of the first hit
public ISearchQueryFilter getControlFilter()
null
if none was specified.lumis.search.filter
,
getControlQuery()
public void setControlFilter(ISearchQueryFilter controlFilter)
the
- query filter.lumis.search.filter
,
setControlQuery(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |