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 -
Method Summary
Modifier and TypeMethodDescriptiongetFieldName(IndexedProperty indexedProperty, String qualifier, FieldNameProvider.FieldType fieldType) Returns field name for a given property, qualifier and FieldType.getFieldName(SolrIndexedPropertyModel prop, String qualifier, FieldNameProvider.FieldType fieldType) Returns field name for a given property, qualifier and FieldType.getFieldNames(IndexedProperty indexedProperty, String qualifier) Returns all field name for a given property and qualifier.getPropertyName(String fieldName) Takes a SolrDocument field name and returns the property name
-
Method Details
-
getFieldNames
Returns all field name for a given property and qualifier. (see FieldNameProvider class comment.)- Parameters:
indexedProperty- the property to provide a field name forqualifier- the qualifier- Returns:
- the Solr field name
-
getFieldName
String getFieldName(SolrIndexedPropertyModel prop, 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 forqualifier- 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 forqualifier- the qualifier- Returns:
- the Solr field name
-
getPropertyName
Takes a SolrDocument field name and returns the property name- Parameters:
fieldName- the SolrDocumentField name- Returns:
- the property name
-