Package de.hybris.platform.solrfacetsearch.search

Interface FieldNameTranslator

All Known Implementing Classes:

DefaultFieldNameTranslator

public interface FieldNameTranslator

Translates field names during search.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FieldNameTranslator.FieldInfo	Placeholder for field details.
static interface	FieldNameTranslator.FieldInfosMapping	Placeholder for field details.

Method Summary

Modifier and Type	Method	Description
FieldNameTranslator.FieldInfosMapping	getFieldInfos(FacetSearchContext searchContext)	Returns information about the known fields, including the translated field names.
String	translate(FacetSearchContext searchContext, String field)	Returns the translated field name for a given search context and field.
String	translate(FacetSearchContext searchContext, String field, FieldNameProvider.FieldType fieldType)	Returns the translated field name for a given search context, field and field type.
String	translate(SearchQuery searchQuery, String field, FieldNameProvider.FieldType fieldType)	Returns the translated field name for a given searchQuery, field and field type.

Method Details

translate

String translate(SearchQuery searchQuery,
 String field,
 FieldNameProvider.FieldType fieldType)

Returns the translated field name for a given searchQuery, field and field type.

Parameters:

searchQuery - - the search query

field - - the field name to translate (might be an indexed property)

fieldType - - the field type

Returns:

the translated field name

translate

String translate(FacetSearchContext searchContext,
 String field,
 FieldNameProvider.FieldType fieldType)

Returns the translated field name for a given search context, field and field type.

Parameters:

searchContext - - the facet search context

field - - the field name to translate (might be an indexed property)

fieldType - - the field type

Returns:

the translated field name

translate

String translate(FacetSearchContext searchContext,
 String field)

Returns the translated field name for a given search context and field.

Parameters:

searchContext - - the facet search context

field - - the field name to translate (might be an indexed property)

Returns:

the translated field name

getFieldInfos

FieldNameTranslator.FieldInfosMapping getFieldInfos(FacetSearchContext searchContext)

Returns information about the known fields, including the translated field names.

Parameters:

searchContext - - the facet search context

Returns:

the information about the known fields