com.atlassian.fisheye.spi.services

Interface SearchService

public interface SearchService

Provides an API for searching the fisheye repositories

Method Summary

Modifier and Type	Method and Description
java.util.List<ReviewData>	getReviewsForChangeset(java.lang.String repository, java.lang.String csid)
java.util.Map<java.lang.String,java.util.List<ReviewData>>	getReviewsForChangesets(java.lang.String repository, java.util.Set<java.lang.String> changesets)
java.util.List<FileRevisionKeyData>	query(java.lang.String repository, java.lang.String query) Run an EyeQL query against the specified repository.
java.util.List<FileRevisionKeyData>	query(java.lang.String repository, java.lang.String query, int maxResults) Run an EyeQL query against the specified repository.
TabularQueryResultData	queryAsRows(java.lang.String repository, java.lang.String query) Run an EyeQL query against the specified repository.
TabularQueryResultData	queryAsRows(java.lang.String repository, java.lang.String query, int maxResults) Run an EyeQL query against the specified repository.

Method Detail

query

java.util.List<FileRevisionKeyData> query(java.lang.String repository,
                                          java.lang.String query,
                                          int maxResults)

Run an EyeQL query against the specified repository.

The maximum number of results will be limited to maxResults or 3000, whichever is the smallest number.

Parameters:

repository - the key of the repository to search

query - the EyeQL query to perform. Should not contain a "returns" statement

maxResults - the maximum number of results to return

Returns:

a list of filerevisions matching the query, limited to maxResults or 3000 results, whichever is the smallest number

query

java.util.List<FileRevisionKeyData> query(java.lang.String repository,
                                          java.lang.String query)

Run an EyeQL query against the specified repository.

The maximum number of results will be limited to 3000 results.

Parameters:

repository - the key of the repository to search

query - the EyeQL query to perform. Should not contain a "returns" statement

Returns:

a list of filerevisions matching the query, limited to at most 3000 results

queryAsRows

TabularQueryResultData queryAsRows(java.lang.String repository,
                                   java.lang.String query,
                                   int maxResults)

Run an EyeQL query against the specified repository.

The maximum number of results will be limited to maxResults or 3000, whichever is the smallest number.

Parameters:

repository - the key of the repository to search

query - the EyeQL query to perform. Should contain a "returns" statement.

maxResults - the maximum number of results to return

Returns:

the result of the query in tabular form, limited to maxResults or 3000 results, whichever is the smallest number

queryAsRows

TabularQueryResultData queryAsRows(java.lang.String repository,
                                   java.lang.String query)

Run an EyeQL query against the specified repository.

The maximum number of results will be limited to 3000 results.

Parameters:

repository - the key of the repository to search

query - the EyeQL query to perform. Should contain a "returns" statement.

Returns:

the result of the query in tabular form, limited to at most 3000 results

getReviewsForChangeset

java.util.List<ReviewData> getReviewsForChangeset(java.lang.String repository,
                                                  java.lang.String csid)

Parameters:

repository - the key of the repository to search

csid - the changeset id to lookup reviews for

Returns:

a list of review permakeys that are associated with the provided changeset id in repository

getReviewsForChangesets

java.util.Map<java.lang.String,java.util.List<ReviewData>> getReviewsForChangesets(java.lang.String repository,
                                                                                   java.util.Set<java.lang.String> changesets)

Parameters:

repository - the key of the repository to search

changesets - the changeset id to lookup reviews for

Returns:

a map of changeset id to list of associated review permakeys