org.finra.herd.service.impl

Class IndexSearchServiceImpl

java.lang.Object

org.finra.herd.service.impl.IndexSearchServiceImpl

All Implemented Interfaces:

FacetFieldValidationService, IndexSearchService, SearchableService

@Service
public class IndexSearchServiceImpl
extends Object
implements IndexSearchService, SearchableService, FacetFieldValidationService

IndexSearchServiceImpl is the implementation of the IndexSearchService and includes an indexSearch method that will handle search requests against a search index.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPLAY_NAME_FIELD Constant to hold the display name option for the index search
static String	MATCH_COLUMN_FIELD Constant to hold the column match field option for the index search.
static int	SEARCH_TERM_MINIMUM_ALLOWABLE_LENGTH The minimum allowable length of a search term.
static String	SHORT_DESCRIPTION_FIELD Constant to hold the short description option for the index search.

Constructor Summary

Constructors

Constructor and Description
IndexSearchServiceImpl()

Method Summary

Modifier and Type	Method and Description
Set<String>	getValidFacetFields() Returns valid facet fields.
Set<String>	getValidSearchResponseFields() Returns valid search response fields.
IndexSearchResponse	indexSearch(IndexSearchRequest request, Set<String> fields, Set<String> match) The index indexSearch method will take as parameters an index indexSearch request that contains a indexSearch term string, and a set of field strings.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.finra.herd.service.SearchableService

validateSearchResponseFields

Methods inherited from interface org.finra.herd.service.FacetFieldValidationService

validateFacetFields

Field Detail

DISPLAY_NAME_FIELD

public static final String DISPLAY_NAME_FIELD

Constant to hold the display name option for the index search

See Also:

Constant Field Values

MATCH_COLUMN_FIELD

public static final String MATCH_COLUMN_FIELD

Constant to hold the column match field option for the index search.

See Also:

Constant Field Values

SEARCH_TERM_MINIMUM_ALLOWABLE_LENGTH

public static final int SEARCH_TERM_MINIMUM_ALLOWABLE_LENGTH

The minimum allowable length of a search term.

See Also:

Constant Field Values

SHORT_DESCRIPTION_FIELD

public static final String SHORT_DESCRIPTION_FIELD

Constant to hold the short description option for the index search.

See Also:

Constant Field Values

Constructor Detail

IndexSearchServiceImpl

public IndexSearchServiceImpl()

Method Detail

indexSearch

public IndexSearchResponse indexSearch(IndexSearchRequest request,
                                       Set<String> fields,
                                       Set<String> match)

Description copied from interface: IndexSearchService

The index indexSearch method will take as parameters an index indexSearch request that contains a indexSearch term string, and a set of field strings. It will perform an index indexSearch on the indexSearch term and return the fields specified in the index indexSearch response. The search may be constrained by a set of match fields that will limit the search to the fields specified.

Specified by:

indexSearch in interface IndexSearchService

Parameters:

request - the index indexSearch request that contains a indexSearch term string

fields - the set of fields that are to be returned in the index indexSearch response

match - the set of match fields that are to be searched upon in the index search

Returns:

an index indexSearch response object containing the total index indexSearch results and index indexSearch results

getValidSearchResponseFields

public Set<String> getValidSearchResponseFields()

Description copied from interface: SearchableService

Returns valid search response fields.

Specified by:

getValidSearchResponseFields in interface SearchableService

Returns:

the set of valid search response fields

getValidFacetFields

public Set<String> getValidFacetFields()

Description copied from interface: FacetFieldValidationService

Returns valid facet fields.

Specified by:

getValidFacetFields in interface FacetFieldValidationService

Returns:

the set of valid facet fields