au.org.ala.biocache.util

Class SearchUtils

java.lang.Object

au.org.ala.biocache.util.SearchUtils

@Component(value="searchUtils")
public class SearchUtils
extends Object

A class to provide utility methods used to populate search details.

Author:

Natasha

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SearchUtils.Month Enum for months lookup

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<String>	defaultParams
protected String	nameIndexLocation
protected boolean	taxonProfileEnabled

Constructor Summary

Constructors

Constructor and Description
SearchUtils()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Facet>	addFacetMap(String[] filterQuery, Set<String> authIndexFields) Create a HashMap for the filter queries, using the first SOLR field as the key and subsequent query string as the value.
String	convertRankAndName(String query) Extracts the a rank and name from a query.
static String	formatDynamicFieldName(String fieldName)
static String	formatGuid(String guid)
static String	formatSearchQuery(String query) Formats the query string before
static Map<String,String[]>	getExtraParams(Map map)
List<String>	getNextRanks(String rank, boolean includeSuppliedRank) Returns an ordered list of the next ranks after the supplied rank.
List<String>	getRanks()
List<OccurrenceSourceDTO>	getSourceInformation(Map<String,Integer> sources) Returns the information for the supplied source keys TODO: There may be a better location for this method.
String[]	getTaxonSearch(String lsid) Returns an array where the first value is the search string and the second is a display string.
String	getUidDisplayString(String fieldName, String uid)
String	getUidDisplayString(String fieldName, String uid, boolean includeField) Returns the display string for the supplied uid
String	getUidSearchField(String uid) returns the solr field that should be used to search for a particular uid
String	getUIDSearchString(String[] uids)
static void	setDefaultParams(SearchRequestParams requestParams) Provide default values for parameters if they have any null or "empty" values
static String	stripEscapedQuotes(String uid)
boolean	updateCollectionSearchString(SearchRequestParams searchParams, String uid) Returns an array that contains the search string to use for a collection search and display name for the results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nameIndexLocation

protected String nameIndexLocation

taxonProfileEnabled

protected boolean taxonProfileEnabled

defaultParams

protected static List<String> defaultParams

Constructor Detail

SearchUtils

public SearchUtils()

Method Detail

updateCollectionSearchString

public boolean updateCollectionSearchString(SearchRequestParams searchParams,
                                   String uid)

Returns an array that contains the search string to use for a collection search and display name for the results.

Returns:

true when UID could be located and query updated correctly

getUIDSearchString

public String getUIDSearchString(String[] uids)

stripEscapedQuotes

public static String stripEscapedQuotes(String uid)

getUidDisplayString

public String getUidDisplayString(String fieldName,
                         String uid)

getUidDisplayString

public String getUidDisplayString(String fieldName,
                         String uid,
                         boolean includeField)

Returns the display string for the supplied uid

Parameters:

uid -

Returns:

a user friendly display name for this UID

convertRankAndName

public String convertRankAndName(String query)

Extracts the a rank and name from a query. E.g. genus:Macropus will return an a array of new String[]{"genus", "Macropus"};

Parameters:

query -

getTaxonSearch

public String[] getTaxonSearch(String lsid)

Returns an array where the first value is the search string and the second is a display string.

Parameters:

lsid -

Returns:

formatSearchQuery

public static String formatSearchQuery(String query)

Formats the query string before

Parameters:

query -

Returns:

formatGuid

public static String formatGuid(String guid)

getUidSearchField

public String getUidSearchField(String uid)

returns the solr field that should be used to search for a particular uid

Parameters:

uid -

Returns:

getNextRanks

public List<String> getNextRanks(String rank,
                        boolean includeSuppliedRank)

Returns an ordered list of the next ranks after the supplied rank.

Parameters:

rank -

Returns:

getRanks

public List<String> getRanks()

getSourceInformation

public List<OccurrenceSourceDTO> getSourceInformation(Map<String,Integer> sources)

Returns the information for the supplied source keys

TODO: There may be a better location for this method.

Parameters:

sources -

Returns:

setDefaultParams

public static void setDefaultParams(SearchRequestParams requestParams)

Provide default values for parameters if they have any null or "empty" values

Parameters:

requestParams -

getExtraParams

public static Map<String,String[]> getExtraParams(Map map)

formatDynamicFieldName

public static String formatDynamicFieldName(String fieldName)

addFacetMap

public Map<String,Facet> addFacetMap(String[] filterQuery,
                            Set<String> authIndexFields)

Create a HashMap for the filter queries, using the first SOLR field as the key and subsequent query string as the value. Refactor: now returns a Map with an additional field "label" that is used to provide a human readable version of the filter query. NC 2013-01-11: This method has been moved from hubs-webapp so that all the processing is performed by the service rather than the client. This means that the authService will perform the lookup here.

Parameters:

filterQuery -

Returns: