com.flexive.shared.interfaces

Interface SearchEngine

All Known Subinterfaces:

SearchEngineLocal

public interface SearchEngine

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_ROWS The default size of a search query result.
static int	DEFAULT_QUERY_TIMEOUT The default query timeout in seconds.
static java.lang.String	PROP_CUSTOM_SQL A custom query property.
static java.lang.String	PROP_USERWILDCARD The user wildcard selects the properties predefined by the user through the ResultPreferencesEngine.
static java.lang.String	PROP_WILDCARD The wildcard character selects all properties of the result content type.

Method Summary

Modifier and Type	Method and Description
long	getLastContentChange(boolean live) Returns the last time that any content that affects queries was changed.
com.flexive.shared.search.query.QueryRootNode	load(com.flexive.shared.search.ResultLocation location, java.lang.String name) Load the query of the given name, for the current user.
com.flexive.shared.search.query.QueryRootNode	loadDefault(com.flexive.shared.search.ResultLocation location) Load the default query for the given type/location.
java.util.Collection<java.lang.String>	loadNames(com.flexive.shared.search.ResultLocation location) Returns the names of the stored queries for the calling user/location.
com.flexive.shared.search.query.QueryRootNode	loadSystemDefault(com.flexive.shared.search.ResultLocation location) Load the system-wide default query for the given type/location.
void	remove(com.flexive.shared.search.ResultLocation location, java.lang.String name) Remove the query of the given name and type from the database.
void	save(com.flexive.shared.search.query.QueryRootNode query) Store the given query for the current user.
void	saveDefault(com.flexive.shared.search.query.QueryRootNode query) Sets the user-defined default query for the query's type and location.
void	saveSystemDefault(com.flexive.shared.search.query.QueryRootNode query) Sets the system-wide default query for the query's type and location.
com.flexive.shared.search.FxResultSet	search(java.lang.String query) Executes a query.
com.flexive.shared.search.FxResultSet	search(java.lang.String query, int startIndex, int fetchRows, com.flexive.shared.search.FxSQLSearchParams params) Executes a query.
com.flexive.shared.search.FxResultSet	search(java.lang.String query, int startIndex, int fetchRows, com.flexive.shared.search.FxSQLSearchParams params, com.flexive.shared.search.ResultLocation location, com.flexive.shared.search.ResultViewType viewType) Executes a query.

Field Detail

PROP_WILDCARD

static final java.lang.String PROP_WILDCARD

The wildcard character selects all properties of the result content type.

See Also:

Constant Field Values

PROP_USERWILDCARD

static final java.lang.String PROP_USERWILDCARD

The user wildcard selects the properties predefined by the user through the ResultPreferencesEngine.

See Also:

Constant Field Values

PROP_CUSTOM_SQL

static final java.lang.String PROP_CUSTOM_SQL

A custom query property.

Since:

3.2.1

See Also:

FxSQLSearchParams.addCustomSqlQuery(String, String), Constant Field Values

DEFAULT_QUERY_TIMEOUT

static final int DEFAULT_QUERY_TIMEOUT

The default query timeout in seconds.

Since:

3.1

See Also:

Constant Field Values

DEFAULT_MAX_ROWS

static final int DEFAULT_MAX_ROWS

The default size of a search query result.

Since:

3.1

See Also:

Constant Field Values

Method Detail

search

com.flexive.shared.search.FxResultSet search(java.lang.String query)
                                      throws com.flexive.shared.exceptions.FxApplicationException

Executes a query.

Parameters:

query - the query to execute

Returns:

the result set

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the search failed

search

com.flexive.shared.search.FxResultSet search(java.lang.String query,
                                             int startIndex,
                                             int fetchRows,
                                             com.flexive.shared.search.FxSQLSearchParams params)
                                      throws com.flexive.shared.exceptions.FxApplicationException

Executes a query.

Parameters:

query - the query to execute

startIndex - return data starting at the given row, 0 based

fetchRows - the maximum rows to fetch, -1 to fetch all rows

params - all additional search options

Returns:

the result set

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the search failed

search

com.flexive.shared.search.FxResultSet search(java.lang.String query,
                                             int startIndex,
                                             int fetchRows,
                                             com.flexive.shared.search.FxSQLSearchParams params,
                                             com.flexive.shared.search.ResultLocation location,
                                             com.flexive.shared.search.ResultViewType viewType)
                                      throws com.flexive.shared.exceptions.FxApplicationException

Executes a query.

Parameters:

query - the query to execute

startIndex - return data starting at the given row, 0 based

fetchRows - the maximum rows to fetch, -1 to fetch all rows.

params - all additional search options

location - the result location

viewType - the result view type

Returns:

the result set

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the search failed

getLastContentChange

long getLastContentChange(boolean live)

Returns the last time that any content that affects queries was changed.

Parameters:

live - if true only the last changes of live contents are checked

Returns:

the last time that any content that affects queries was changed

save

void save(com.flexive.shared.search.query.QueryRootNode query)
   throws com.flexive.shared.exceptions.FxApplicationException

Store the given query for the current user.

Parameters:

query - the query to be stored

Throws:

com.flexive.shared.exceptions.FxApplicationException - TODO

saveDefault

void saveDefault(com.flexive.shared.search.query.QueryRootNode query)
          throws com.flexive.shared.exceptions.FxApplicationException

Sets the user-defined default query for the query's type and location.

Parameters:

query - the query to be stored

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the default query could not be set.

See Also:

QueryRootNode.getType(), QueryRootNode.getLocation()

saveSystemDefault

void saveSystemDefault(com.flexive.shared.search.query.QueryRootNode query)
                throws com.flexive.shared.exceptions.FxApplicationException

Sets the system-wide default query for the query's type and location. Only the global supervisor may set the default query.

Parameters:

query - the default query to be set

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the default query could not be set, or the caller lacks supervisor privileges

See Also:

QueryRootNode.getType(), QueryRootNode.getLocation()

load

com.flexive.shared.search.query.QueryRootNode load(com.flexive.shared.search.ResultLocation location,
                                                   java.lang.String name)
                                            throws com.flexive.shared.exceptions.FxApplicationException

Load the query of the given name, for the current user.

Parameters:

location - the query location

name - query to be loaded @return the loaded query tree

Returns:

the query root node

Throws:

com.flexive.shared.exceptions.FxApplicationException - TODO

com.flexive.shared.exceptions.FxNotFoundException - if the query does not exist

loadDefault

com.flexive.shared.search.query.QueryRootNode loadDefault(com.flexive.shared.search.ResultLocation location)
                                                   throws com.flexive.shared.exceptions.FxApplicationException

Load the default query for the given type/location. If none is set, an empty query is returned.

Parameters:

location - the query location, usually matched to the location of its result

Returns:

the default query for the given type/location

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the default query could not be loaded

loadSystemDefault

com.flexive.shared.search.query.QueryRootNode loadSystemDefault(com.flexive.shared.search.ResultLocation location)
                                                         throws com.flexive.shared.exceptions.FxApplicationException

Load the system-wide default query for the given type/location. If none is set, an empty query is returned.

Parameters:

location - the query location, usually matched to the location of its result

Returns:

the default query for the given type/location

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the default query could not be loaded

loadNames

java.util.Collection<java.lang.String> loadNames(com.flexive.shared.search.ResultLocation location)
                                          throws com.flexive.shared.exceptions.FxApplicationException

Returns the names of the stored queries for the calling user/location. The query names are also the keys for retrieving the actual search query via load(com.flexive.shared.search.ResultLocation, String).

Parameters:

location - the query location, usually matched to the location of its result

Returns:

all stored queries for the given location of the current user

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the query names could not be retrieved

remove

void remove(com.flexive.shared.search.ResultLocation location,
            java.lang.String name)
     throws com.flexive.shared.exceptions.FxApplicationException

Remove the query of the given name and type from the database.

Parameters:

location - the query location

name - the query to be removed @throws FxApplicationException TODO

Throws:

com.flexive.shared.exceptions.FxApplicationException - if the query could not be deleted