public interface

SearchService

com.atlassian.fisheye.spi.services.SearchService

Class Overview

Provides an API for searching the fisheye repositories

Summary

Public Methods
abstract List<ReviewData> getReviewsForChangeset(String repository, String csid)
abstract Map<StringList<ReviewData>> getReviewsForChangesets(String repository, Set<String> changesets)
abstract List<FileRevisionKeyData> query(String repository, String query, int maxResults)
Run an EyeQL query against the specified repository.
abstract List<FileRevisionKeyData> query(String repository, String query)
Run an EyeQL query against the specified repository.
abstract TabularQueryResultData queryAsRows(String repository, String query, int maxResults)
Run an EyeQL query against the specified repository.
abstract TabularQueryResultData queryAsRows(String repository, String query)
Run an EyeQL query against the specified repository.

Public Methods

public abstract List<ReviewData> getReviewsForChangeset (String repository, String csid)

Parameters
repository the name 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

public abstract Map<StringList<ReviewData>> getReviewsForChangesets (String repository, Set<String> changesets)

Parameters
repository the name 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

public abstract List<FileRevisionKeyData> query (String repository, 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 name 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

public abstract List<FileRevisionKeyData> query (String repository, String query)

Run an EyeQL query against the specified repository.

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

Parameters
repository the name 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

public abstract TabularQueryResultData queryAsRows (String repository, 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 name 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

public abstract TabularQueryResultData queryAsRows (String repository, String query)

Run an EyeQL query against the specified repository.

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

Parameters
repository the name 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