au.org.ala.biocache.dao

Interface SearchDAO

All Known Implementing Classes:

SearchDAOImpl

public interface SearchDAO

DAO for searching occurrence records held in the biocache.

Author:

"Nick dos Remedios " .

Method Summary

Methods

Modifier and Type	Method and Description
TaxaRankCountDTO	calculateBreakdown(BreakdownRequestParams queryParams) Calculate taxon breakdown.
List<TaxaCountDTO>	findAllSpecies(SpatialSearchRequestParams requestParams) Find all species (and counts) for a given query.
List<TaxaCountDTO>	findAllSpeciesByCircleAreaAndHigherTaxa(SpatialSearchRequestParams requestParams, String speciesGroup) Find all species (and counts) for a given location search (lat/long and radius) and a higher taxon (with rank)
org.apache.solr.common.SolrDocumentList	findByFulltext(SpatialSearchRequestParams searchParams) Find all occurrences for a given query as SolrDocumentList
SearchResultDTO	findByFulltextSpatialQuery(SpatialSearchRequestParams requestParams, boolean includeSensitive, Map<String,String[]> extraParams) Find all occurrences for a given (full text) query, latitude, longitude & radius (km).
SearchResultDTO	findByFulltextSpatialQuery(SpatialSearchRequestParams requestParams, Map<String,String[]> extraParams) Find all occurrences for a given (full text) query, latitude, longitude & radius (km).
List<FieldResultDTO>	findRecordByStateFor(String query)
List<OccurrencePoint>	findRecordsForLocation(SpatialSearchRequestParams requestParams, PointType pointType) Get a list of occurrence points for a given lat/long and distance (radius)
TaxaRankCountDTO	findTaxonCountForUid(BreakdownRequestParams breakdownParams, String query) Returns the scientific name and counts for the taxon rank that proceed or include the supplied rank.
List<DataProviderCountDTO>	getDataProviderCounts() Find all the data providers with records.
List<DataProviderCountDTO>	getDataProviderList(SpatialSearchRequestParams requestParams) Get a data provider list for a query.
List<FieldResultDTO>	getEndemicSpecies(SpatialSearchRequestParams requestParams) Finds the endemic species of the supplied area.
List<FacetResultDTO>	getFacetCounts(SpatialSearchRequestParams searchParams) Retrieve facet counts for this query
List<OccurrencePoint>	getFacetPoints(SpatialSearchRequestParams searchParams, PointType pointType) Retrieve an OccurrencePoint (distinct list of points - lat-long to 4 decimal places) for a given search
Set<IndexFieldDTO>	getIndexedFields() Retrieve a list of the indexed fields.
Set<IndexFieldDTO>	getIndexFieldDetails(String... field) Returns the up to date statistics for the supplied field
List<LegendItem>	getLegend(SpatialSearchRequestParams searchParams, String facet, String[] cutpoints) Get legend items for a query and specified facet.
Map<String,Integer>	getOccurrenceCountsForTaxa(List<String> taxa) Returns the occurrence counts based on lft and rgt values for each of the supplied taxa.
List<OccurrencePoint>	getOccurrences(SpatialSearchRequestParams requestParams, PointType pointType, String colourBy, int searchType) Retrieve a list of occurrence uid's for a given search
Map<String,Integer>	getSourcesForQuery(SpatialSearchRequestParams searchParams) Find all the sources for the supplied query
Map<String,org.apache.solr.client.solrj.response.FieldStatsInfo>	getStatistics(SpatialSearchRequestParams searchParams) Statistics for each of the fields included as facets.
List<FieldResultDTO>	getValuesForFacet(SpatialSearchRequestParams requestParams) Retrieve a list of facet values for the supplied query.
void	refreshCaches() Refresh any caches in use to populate queries.
void	writeCoordinatesToStream(SearchRequestParams searchParams, OutputStream out) Write coordinates out to the supplied stream.
void	writeFacetToStream(SpatialSearchRequestParams searchParams, boolean includeCount, boolean lookupName, boolean includeSynonyms, OutputStream out, DownloadDetailsDTO dd) Write facet content to supplied output stream
Map<String,Integer>	writeResultsFromIndexToStream(DownloadRequestParams downloadParams, OutputStream out, boolean includeSensitive, DownloadDetailsDTO dd, boolean checkLimit) Writes the results of this query to the output stream using the index as a source of the data.
Map<String,Integer>	writeResultsToStream(DownloadRequestParams searchParams, OutputStream out, int maxNoOfRecords, boolean includeSensitive, DownloadDetailsDTO dd) Write out the results of this query to the output stream
int	writeSpeciesCountByCircleToStream(SpatialSearchRequestParams requestParams, String speciesGroup, javax.servlet.ServletOutputStream out) Writes the species count in the specified circle to the output stream.

Method Detail

getEndemicSpecies

List<FieldResultDTO> getEndemicSpecies(SpatialSearchRequestParams requestParams)
                                       throws Exception

Finds the endemic species of the supplied area.

Parameters:

requestParams -

Returns:

Throws:

Exception

getValuesForFacet

List<FieldResultDTO> getValuesForFacet(SpatialSearchRequestParams requestParams)
                                       throws Exception

Retrieve a list of facet values for the supplied query.

Parameters:

requestParams -

Returns:

Throws:

Exception

findByFulltextSpatialQuery

SearchResultDTO findByFulltextSpatialQuery(SpatialSearchRequestParams requestParams,
                                         Map<String,String[]> extraParams)

Find all occurrences for a given (full text) query, latitude, longitude & radius (km). I.e. a full-text spatial query.

Parameters:

requestParams -

Returns:

Throws:

Exception

findByFulltextSpatialQuery

SearchResultDTO findByFulltextSpatialQuery(SpatialSearchRequestParams requestParams,
                                         boolean includeSensitive,
                                         Map<String,String[]> extraParams)

Find all occurrences for a given (full text) query, latitude, longitude & radius (km). I.e. a full-text spatial query. The result will include the sensitive coordinates if available.

Parameters:

requestParams -

Returns:

Throws:

Exception

writeSpeciesCountByCircleToStream

int writeSpeciesCountByCircleToStream(SpatialSearchRequestParams requestParams,
                                    String speciesGroup,
                                    javax.servlet.ServletOutputStream out)
                                      throws Exception

Writes the species count in the specified circle to the output stream.

Parameters:

requestParams -

speciesGroup -

out -

Returns:

Throws:

Exception

writeResultsToStream

Map<String,Integer> writeResultsToStream(DownloadRequestParams searchParams,
                                       OutputStream out,
                                       int maxNoOfRecords,
                                       boolean includeSensitive,
                                       DownloadDetailsDTO dd)
                                         throws Exception

Write out the results of this query to the output stream

Parameters:

searchParams -

out -

maxNoOfRecords -

includeSensitive - Whether or not the sensitive values should be included in the download

Returns:

A map of uids and counts that needs to be logged to the ala-logger

Throws:

Exception

writeResultsFromIndexToStream

Map<String,Integer> writeResultsFromIndexToStream(DownloadRequestParams downloadParams,
                                                OutputStream out,
                                                boolean includeSensitive,
                                                DownloadDetailsDTO dd,
                                                boolean checkLimit)
                                                  throws Exception

Writes the results of this query to the output stream using the index as a source of the data.

Parameters:

downloadParams -

out -

includeSensitive -

Returns:

Throws:

Exception

writeCoordinatesToStream

void writeCoordinatesToStream(SearchRequestParams searchParams,
                            OutputStream out)
                              throws Exception

Write coordinates out to the supplied stream.

Parameters:

searchParams -

out -

Throws:

Exception

writeFacetToStream

void writeFacetToStream(SpatialSearchRequestParams searchParams,
                      boolean includeCount,
                      boolean lookupName,
                      boolean includeSynonyms,
                      OutputStream out,
                      DownloadDetailsDTO dd)
                        throws Exception

Write facet content to supplied output stream

Parameters:

searchParams -

includeCount -

lookupName -

includeSynonyms -

out -

dd -

Throws:

Exception

getIndexedFields

Set<IndexFieldDTO> getIndexedFields()
                                    throws Exception

Retrieve a list of the indexed fields.

Returns:

Throws:

Exception

getIndexFieldDetails

Set<IndexFieldDTO> getIndexFieldDetails(String... field)
                                        throws Exception

Returns the up to date statistics for the supplied field

Parameters:

field -

Returns:

Throws:

Exception

getFacetPoints

List<OccurrencePoint> getFacetPoints(SpatialSearchRequestParams searchParams,
                                   PointType pointType)
                                     throws Exception

Retrieve an OccurrencePoint (distinct list of points - lat-long to 4 decimal places) for a given search

Parameters:

searchParams -

pointType -

Returns:

Throws:

Exception

getOccurrences

List<OccurrencePoint> getOccurrences(SpatialSearchRequestParams requestParams,
                                   PointType pointType,
                                   String colourBy,
                                   int searchType)
                                     throws Exception

Retrieve a list of occurrence uid's for a given search

Parameters:

requestParams -

pointType -

colourBy -

searchType -

Returns:

Throws:

Exception

findRecordsForLocation

List<OccurrencePoint> findRecordsForLocation(SpatialSearchRequestParams requestParams,
                                           PointType pointType)
                                             throws Exception

Get a list of occurrence points for a given lat/long and distance (radius)

Parameters:

requestParams -

pointType -

Returns:

Throws:

Exception

refreshCaches

void refreshCaches()

Refresh any caches in use to populate queries.

findAllSpeciesByCircleAreaAndHigherTaxa

List<TaxaCountDTO> findAllSpeciesByCircleAreaAndHigherTaxa(SpatialSearchRequestParams requestParams,
                                                         String speciesGroup)
                                                           throws Exception

Find all species (and counts) for a given location search (lat/long and radius) and a higher taxon (with rank)

Parameters:

requestParams -

speciesGroup -

Returns:

Throws:

Exception

getDataProviderCounts

List<DataProviderCountDTO> getDataProviderCounts()
                                                 throws Exception

Find all the data providers with records.

Returns:

Throws:

Exception

findRecordByStateFor

List<FieldResultDTO> findRecordByStateFor(String query)
                                          throws Exception

Throws:

Exception

getSourcesForQuery

Map<String,Integer> getSourcesForQuery(SpatialSearchRequestParams searchParams)
                                       throws Exception

Find all the sources for the supplied query

Parameters:

searchParams -

Returns:

Throws:

Exception

calculateBreakdown

TaxaRankCountDTO calculateBreakdown(BreakdownRequestParams queryParams)
                                    throws Exception

Calculate taxon breakdown.

Parameters:

queryParams -

Returns:

Throws:

Exception

getOccurrenceCountsForTaxa

Map<String,Integer> getOccurrenceCountsForTaxa(List<String> taxa)
                                               throws Exception

Returns the occurrence counts based on lft and rgt values for each of the supplied taxa.

Parameters:

taxa -

Returns:

Throws:

Exception

findTaxonCountForUid

TaxaRankCountDTO findTaxonCountForUid(BreakdownRequestParams breakdownParams,
                                    String query)
                                      throws Exception

Returns the scientific name and counts for the taxon rank that proceed or include the supplied rank.

Parameters:

breakdownParams -

query -

Returns:

Throws:

Exception

findAllSpecies

List<TaxaCountDTO> findAllSpecies(SpatialSearchRequestParams requestParams)
                                  throws Exception

Find all species (and counts) for a given query.

Parameters:

requestParams -

Returns:

Throws:

Exception

findByFulltext

org.apache.solr.common.SolrDocumentList findByFulltext(SpatialSearchRequestParams searchParams)
                                                       throws Exception

Find all occurrences for a given query as SolrDocumentList

Parameters:

searchParams -

Returns:

Throws:

Exception

getStatistics

Map<String,org.apache.solr.client.solrj.response.FieldStatsInfo> getStatistics(SpatialSearchRequestParams searchParams)
                                                                               throws Exception

Statistics for each of the fields included as facets. Statistics are only possible for numeric fields.

Parameters:

searchParams -

Returns:

Throws:

Exception

getLegend

List<LegendItem> getLegend(SpatialSearchRequestParams searchParams,
                         String facet,
                         String[] cutpoints)
                           throws Exception

Get legend items for a query and specified facet. Continuous variable cut-points can be specified. Includes the minimum and maximum values. Returns an empty list if no valid values are found.

Parameters:

searchParams -

facet -

Returns:

Throws:

Exception

getDataProviderList

List<DataProviderCountDTO> getDataProviderList(SpatialSearchRequestParams requestParams)
                                               throws Exception

Get a data provider list for a query.

Parameters:

requestParams -

Returns:

Throws:

Exception

getFacetCounts

List<FacetResultDTO> getFacetCounts(SpatialSearchRequestParams searchParams)
                                    throws Exception

Retrieve facet counts for this query

Parameters:

searchParams -

Returns:

Throws:

Exception