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
  • Method Details

    • getFieldNames

      Collection<String> getFieldNames(IndexedProperty indexedProperty, 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

      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

      String getFieldName(IndexedProperty indexedProperty, 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

      String getPropertyName(String fieldName)
      Takes a SolrDocument field name and returns the property name
      Parameters:
      fieldName - the SolrDocumentField name
      Returns:
      the property name