Package com.polarion.platform.persistence.spi

Interface IQueryExpander

public interface IQueryExpander

Query expanders are contributable componentes that are given the possibility to pre-process queries passed to the data service. Typical task is to expand query variables.

Author:

Jiri Banszel, POLARION SOFTWARE

Method Summary

Modifier and Type	Method	Description
default String	expandQuery(String index, String query)	Returns expanded version of the query, or the input query if there is nothing to do for this expander.
default List<SubterraURI>	sortResult(String index, List<SubterraURI> uris, String sort)	Deprecated. Since 3.24.10 and discouraged from the usage.

Method Details

expandQuery

default String expandQuery(@NotNull
 String index,
 @Nullable
 String query)

Returns expanded version of the query, or the input query if there is nothing to do for this expander.

Parameters:

index - name of the index, this is usually the name of the prototype

query - may be null

sortResult

@Deprecated
default List<SubterraURI> sortResult(String index,
 List<SubterraURI> uris,
 String sort)

Deprecated.

Since 3.24.10 and discouraged from the usage.

Sorts the result list of URIs according to sorting criteria. By default it returns not modified input.

Parameters:

index - name of the index, this is usually the name of the prototype

uris - result of previous query, possibly not modifiable

sort - the format is same as for IIndexSearch.sort(String)

Returns:

newly sorted result

Since:

3.5.1