de.hybris.platform.solrfacetsearch.provider

Interface FieldNameProvider

All Known Implementing Classes:

DefaultFieldNameProvider

public interface FieldNameProvider

Generates the Solr field names for a given indexed property and a qualifier and field type. A qualifier can be something like the language ISO code or currency. With this it's possible to store multiple values for one property, such as localized values or multi-currency values. Field type denotes whether the field is used to store the value of a field or sort it

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FieldNameProvider.FieldType

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName(IndexedProperty indexedProperty, java.lang.String qualifier, FieldNameProvider.FieldType fieldType) Returns field name for a given property, qualifier and FieldType.
java.lang.String	getFieldName(SolrIndexedPropertyModel prop, java.lang.String qualifier, FieldNameProvider.FieldType fieldType) Returns field name for a given property, qualifier and FieldType.
java.util.Collection<java.lang.String>	getFieldNames(IndexedProperty indexedProperty, java.lang.String qualifier) Returns all field name for a given property and qualifier.
java.lang.String	getPropertyName(java.lang.String fieldName) Takes a SolrDocument field name and returns the property name

Method Detail

getFieldNames

java.util.Collection<java.lang.String> getFieldNames(IndexedProperty indexedProperty,
                                                     java.lang.String qualifier)

Returns all field name for a given property and qualifier. (see FieldNameProvider class comment.)

Parameters:

indexedProperty - the property to provide a field name for

qualifier - the qualifier

Returns:

the Solr field name

getFieldName

java.lang.String getFieldName(SolrIndexedPropertyModel prop,
                              java.lang.String qualifier,
                              FieldNameProvider.FieldType fieldType)
                       throws FacetConfigServiceException

Returns field name for a given property, qualifier and FieldType. (see FieldNameProvider class comment.)

Parameters:

prop - the property to provide a field name for

qualifier - the qualifier

Returns:

the Solr field name

Throws:

FacetConfigServiceException

getFieldName

java.lang.String getFieldName(IndexedProperty indexedProperty,
                              java.lang.String qualifier,
                              FieldNameProvider.FieldType fieldType)

Returns field name for a given property, qualifier and FieldType. (see FieldNameProvider class comment.)

Parameters:

indexedProperty - the property to provide a field name for

qualifier - the qualifier

Returns:

the Solr field name

getPropertyName

java.lang.String getPropertyName(java.lang.String fieldName)

Takes a SolrDocument field name and returns the property name

Parameters:

fieldName - the SolrDocumentField name

Returns:

the property name