SolrHelperServiceImpl (BroadleafCommerce Framework 4.0.0-BETA3 API)

java.lang.Object
- org.broadleafcommerce.core.search.service.solr.SolrHelperServiceImpl

All Implemented Interfaces:

SolrHelperService
```
@Service(value="blSolrHelperService")
public class SolrHelperServiceImpl
extends Object
implements SolrHelperService
```
Provides utility methods that are used by other Solr service classes

Author:

Andre Azzolini (apazzolini)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_NAMESPACE`
`protected static Locale`	`defaultLocale`
`protected SolrSearchServiceExtensionManager`	`extensionManager`
`protected static String`	`GLOBAL_FACET_TAG_FIELD`
`protected LocaleService`	`localeService`
`protected static String`	`PREFIX_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description

SolrHelperServiceImpl()

Constructors
Constructor and Description
`SolrHelperServiceImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected String`	`convertPrefixListToString(List<String> prefixList)`
`protected void`	`copyPropertyToCollection(Collection<Object> collection, Object o)`
`String`	`getCategoryFieldName()`
`Long`	`getCategoryId(Long tentativeCategoryId)` In certain cases, the category id used for Solr indexing is different than the direct id on the product.
`String`	`getCategorySortFieldName(Category category)`
`String`	`getCategorySortFieldName(Long categoryId)`
`String`	`getCurrentNamespace()` Determines the current namespace we are operating on.
`Locale`	`getDefaultLocale()` Returns the default locale.
`String`	`getDefaultLocalePrefix()`
`String`	`getExplicitCategoryFieldName()`
`String`	`getGlobalFacetTagField()` This property is needed to be non-null to allow filtering by multiple facets at one time and have the results be an AND of the facets.
`String`	`getIdFieldName()`
`String`	`getLocalePrefix()` Determines if there is a locale prefix that needs to be applied to the given field for this particular request.
`String`	`getNamespaceFieldName()`
`Long`	`getProductId(Long tentativeProductId)` In certain cases, the product id used for Solr indexing is different than the direct id on the product.
`String`	`getProductIdFieldName()`
`String`	`getPropertyNameForFieldFacet(Field field)` Returns the property name for the given field and its configured facet field type.
`String`	`getPropertyNameForFieldFacet(Field field, String prefix)` Returns the property name for the given field, its configured facet field type, and the given prefix
`String`	`getPropertyNameForFieldSearchable(Field field, FieldType searchableFieldType)` Returns the property name for the given field and field type.
`String`	`getPropertyNameForFieldSearchable(Field field, FieldType searchableFieldType, String prefix)` Returns the property name for the given field, field type, and prefix
`Object`	`getPropertyValue(Object object, Field field)` See getPropertyValue(Object, String)
`Object`	`getPropertyValue(Object object, String propertyName)` This method is meant to behave in a similar way to Apache's PropertyUtils.getProperty(Object, String).
`protected Object`	`getPropertyValueInternal(Object object, String[] components, int currentPosition)`
`List<FieldType>`	`getSearchableFieldTypes(Field field)` Returns the searchable field types for the given field.
`Long`	`getSkuId(Long tentativeSkuId)` In certain cases, the sku id used for Solr indexing is different than the direct id on the sku.
`String`	`getSkuIdFieldName()`
`String`	`getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Product product)`
`String`	`getSolrDocumentId(org.apache.solr.common.SolrInputDocument document, Sku sku)`
`void`	`swapActiveCores()` This should only ever be called when using the Solr reindex service to do a full reindex.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GLOBAL_FACET_TAG_FIELD
```
protected static final String GLOBAL_FACET_TAG_FIELD
```
    See Also:
    Constant Field Values
  - DEFAULT_NAMESPACE
```
protected static final String DEFAULT_NAMESPACE
```
    See Also:
    Constant Field Values
  - PREFIX_SEPARATOR
```
protected static final String PREFIX_SEPARATOR
```
    See Also:
    Constant Field Values
  - defaultLocale
```
protected static Locale defaultLocale
```
  - localeService
```
protected LocaleService localeService
```
  - extensionManager
```
protected SolrSearchServiceExtensionManager extensionManager
```
- Constructor Detail
  - SolrHelperServiceImpl
```
public SolrHelperServiceImpl()
```
- Method Detail
  - swapActiveCores
```
public void swapActiveCores()
                     throws ServiceException
```
    This should only ever be called when using the Solr reindex service to do a full reindex.
    
    Specified by:
    
    swapActiveCores in interface SolrHelperService
    
    Throws:
    
    ServiceException
  - getCurrentNamespace
```
public String getCurrentNamespace()
```
    Description copied from interface: SolrHelperService
    Determines the current namespace we are operating on. For example, if you have multiple sites set up, you may want to filter that here.
    - Note: This method should ALWAYS return a non-empty string.
    Specified by:
    
    getCurrentNamespace in interface SolrHelperService
    
    Returns:
    the global namespace
  - getGlobalFacetTagField
```
public String getGlobalFacetTagField()
```
    Description copied from interface: SolrHelperService
    
    This property is needed to be non-null to allow filtering by multiple facets at one time and have the results be an AND of the facets. Apart from being non-empty, the actual value does not matter.
    
    Specified by:
    
    getGlobalFacetTagField in interface SolrHelperService
    
    Returns:
    the non-empty global facet tag field
  - getPropertyNameForFieldSearchable
```
public String getPropertyNameForFieldSearchable(Field field,
                                       FieldType searchableFieldType,
                                       String prefix)
```
    Description copied from interface: SolrHelperService
    
    Returns the property name for the given field, field type, and prefix
    
    Specified by:
    
    getPropertyNameForFieldSearchable in interface SolrHelperService
    
    Returns:
    the property name for the field and fieldtype
  - getPropertyNameForFieldFacet
```
public String getPropertyNameForFieldFacet(Field field,
                                  String prefix)
```
    Description copied from interface: SolrHelperService
    
    Returns the property name for the given field, its configured facet field type, and the given prefix
    
    Specified by:
    
    getPropertyNameForFieldFacet in interface SolrHelperService
    
    Returns:
    the property name for the facet type of this field
  - getSearchableFieldTypes
```
public List<FieldType> getSearchableFieldTypes(Field field)
```
    Description copied from interface: SolrHelperService
    
    Returns the searchable field types for the given field. If there were none configured, will return a list with TEXT FieldType.
    
    Specified by:
    
    getSearchableFieldTypes in interface SolrHelperService
    
    Returns:
    the searchable field types for the given field
  - getPropertyNameForFieldSearchable
```
public String getPropertyNameForFieldSearchable(Field field,
                                       FieldType searchableFieldType)
```
    Description copied from interface: SolrHelperService
    
    Returns the property name for the given field and field type. This will apply the global prefix to the field, and it will also apply either the locale prefix or the pricelist prefix, depending on whether or not the field type was set to FieldType.PRICE
    
    Specified by:
    
    getPropertyNameForFieldSearchable in interface SolrHelperService
    
    Returns:
    the property name for the field and fieldtype
  - getPropertyNameForFieldFacet
```
public String getPropertyNameForFieldFacet(Field field)
```
    Description copied from interface: SolrHelperService
    
    Returns the property name for the given field and its configured facet field type. This will apply the global prefix to the field, and it will also apply either the locale prefix or the pricelist prefix, depending on whether or not the field type was set to FieldType.PRICE
    
    Specified by:
    
    getPropertyNameForFieldFacet in interface SolrHelperService
    
    Returns:
    the property name for the facet type of this field
  - convertPrefixListToString
```
protected String convertPrefixListToString(List<String> prefixList)
```
  - getCategoryId
```
public Long getCategoryId(Long tentativeCategoryId)
```
    Description copied from interface: SolrHelperService
    
    In certain cases, the category id used for Solr indexing is different than the direct id on the product. This method provides a hook to substitute the category id if necessary.
    
    Specified by:
    
    getCategoryId in interface SolrHelperService
    
    Returns:
    the category id to use
  - getProductId
```
public Long getProductId(Long tentativeProductId)
```
    Description copied from interface: SolrHelperService
    
    In certain cases, the product id used for Solr indexing is different than the direct id on the product. This method provides a hook to substitute the product id if necessary.
    
    Specified by:
    
    getProductId in interface SolrHelperService
    
    Returns:
    the product id to use
  - getSkuId
```
public Long getSkuId(Long tentativeSkuId)
```
    Description copied from interface: SolrHelperService
    
    In certain cases, the sku id used for Solr indexing is different than the direct id on the sku. This method provides a hook to substitute the sku id if necessary.
    
    Specified by:
    
    getSkuId in interface SolrHelperService
    
    Returns:
    the sku id to use
  - getSolrDocumentId
```
public String getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
                       Product product)
```
    Specified by:
    
    getSolrDocumentId in interface SolrHelperService
    
    Returns:
    the Solr id of this product
  - getSolrDocumentId
```
public String getSolrDocumentId(org.apache.solr.common.SolrInputDocument document,
                       Sku sku)
```
    Specified by:
    
    getSolrDocumentId in interface SolrHelperService
    
    Returns:
    the Solr id of this sku
  - getNamespaceFieldName
```
public String getNamespaceFieldName()
```
    Specified by:
    
    getNamespaceFieldName in interface SolrHelperService
    
    Returns:
    the name of the field that keeps track what namespace this document belongs to
  - getIdFieldName
```
public String getIdFieldName()
```
    Specified by:
    
    getIdFieldName in interface SolrHelperService
    
    Returns:
    the id field name, with the global prefix as appropriate
  - getProductIdFieldName
```
public String getProductIdFieldName()
```
    Specified by:
    
    getProductIdFieldName in interface SolrHelperService
    
    Returns:
    the productId field name
  - getSkuIdFieldName
```
public String getSkuIdFieldName()
```
    Specified by:
    
    getSkuIdFieldName in interface SolrHelperService
    
    Returns:
    the skuId field name
  - getCategoryFieldName
```
public String getCategoryFieldName()
```
    Specified by:
    
    getCategoryFieldName in interface SolrHelperService
    
    Returns:
    the category field name, with the global prefix as appropriate
  - getExplicitCategoryFieldName
```
public String getExplicitCategoryFieldName()
```
    Specified by:
    
    getExplicitCategoryFieldName in interface SolrHelperService
    
    Returns:
    the explicit category field name, with the global prefix as appropriate
  - getCategorySortFieldName
```
public String getCategorySortFieldName(Category category)
```
    Specified by:
    
    getCategorySortFieldName in interface SolrHelperService
    
    Returns:
    the default sort field name for this category
  - getCategorySortFieldName
```
public String getCategorySortFieldName(Long categoryId)
```
    Specified by:
    
    getCategorySortFieldName in interface SolrHelperService
    
    Returns:
    the default sort field name for this category
  - getLocalePrefix
```
public String getLocalePrefix()
```
    Description copied from interface: SolrHelperService
    Determines if there is a locale prefix that needs to be applied to the given field for this particular request. By default, a locale prefix is not applicable for category, explicitCategory, or fields that have type Price. Also, it is not applicable for non-translatable fields
    - Note: This method should NOT return null. There must be a default locale configured.
    Specified by:
    
    getLocalePrefix in interface SolrHelperService
    
    Returns:
    the global prefix if there is one, "" if there isn't
  - getDefaultLocalePrefix
```
public String getDefaultLocalePrefix()
```
    Specified by:
    
    getDefaultLocalePrefix in interface SolrHelperService
    
    Returns:
    the default locale's prefix
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Description copied from interface: SolrHelperService
    
    Returns the default locale. Will cache the result for subsequent use. Note: There is no currently configured cache invalidation strategy for the the default locale. Override this method to provide for one if you need it.
    
    Specified by:
    
    getDefaultLocale in interface SolrHelperService
    
    Returns:
    the default locale
  - getPropertyValue
```
public Object getPropertyValue(Object object,
                      Field field)
                        throws NoSuchMethodException,
                               InvocationTargetException,
                               IllegalAccessException
```
    Description copied from interface: SolrHelperService
    
    See getPropertyValue(Object, String)
    
    Specified by:
    
    getPropertyValue in interface SolrHelperService
    
    Returns:
    
    Throws:
    
    NoSuchMethodException
    
    InvocationTargetException
    
    IllegalAccessException
  - getPropertyValue
```
public Object getPropertyValue(Object object,
                      String propertyName)
                        throws NoSuchMethodException,
                               InvocationTargetException,
                               IllegalAccessException
```
    Description copied from interface: SolrHelperService
    
    This method is meant to behave in a similar way to Apache's PropertyUtils.getProperty(Object, String). This is attempting to get the value or values for a property using the property name specified in field.getPropertyName(). The real difference with this method is that it iterates over Collections, Map values, and arrays until it reaches end of the property name. For example, consider a Product and the property name "defaultSku.fees.currency.currencyCode". The property "fees" is a collection of SkuFee objects on the Sku. If an Product is passed to this method, with a field defining a property name of "defaultSku.fees.currency.currencyCode", this method will return a Collection of Strings. Specifically, it will return a Set of Strings. The point is, for Solr indexing, it is often desirable to specify all of the values associated with a product for a given Solr field. In this case, you are trying to get all of the unique currency codes associated with the collection of fees associated with the default Sku for the given product. This works similarly for Maps, Collections, Dates, Strings, Integers, Longs, and other primitives. Note, though, that this will return complex objects as well, if you do not specify the more primitive property that you are trying to access. For example, if you used "defaultSku.fees.currency" as a property name, you would get a collection of BroadleafCurrency objects back. Solr will not be happy if you try to index these. Note that, for arrays, this method only works with one dimensional arrays. For Maps, if a key is not specified, this method ignores the key, and iterates over the values collection and treats the values the same way that it treats any other collection. If they key is specified, then this method returns the keyed value rather than all of the values. So, for example, if you have a product and a property such as "productAttributes(heatRange).value", it will return a single value if there is a ProductAttribute keyed by "heatRange", or null if there is not. If you use the property "productAttributes.value" then is will return a collection of the values associated with each of the values in the productAttributes map. In this regard it is quite different than PropertyUtils.getMappedProperty(Object, String). Keep in mind that, since this method returns either a Collection or a single object that is not a Map or Array, you need to make sure that the field can handle such a value. For example, if your field is intended to index a collection of Strings, you need to make sure Solr's definition of this field (or dynamic field) is a multi-valued type according to your Solr schema definition (e.g. _txt or _ss or _is, etc.).
    
    Specified by:
    
    getPropertyValue in interface SolrHelperService
    
    Returns:
    
    Throws:
    
    NoSuchMethodException
    
    InvocationTargetException
    
    IllegalAccessException
  - getPropertyValueInternal
```
protected Object getPropertyValueInternal(Object object,
                              String[] components,
                              int currentPosition)
                                   throws NoSuchMethodException,
                                          InvocationTargetException,
                                          IllegalAccessException
```
    Throws:
    
    NoSuchMethodException
    
    InvocationTargetException
    
    IllegalAccessException
  - copyPropertyToCollection
```
protected void copyPropertyToCollection(Collection<Object> collection,
                            Object o)
```

Class SolrHelperServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GLOBAL_FACET_TAG_FIELD

DEFAULT_NAMESPACE

PREFIX_SEPARATOR

defaultLocale

localeService

extensionManager

Constructor Detail

SolrHelperServiceImpl

Method Detail

swapActiveCores

getCurrentNamespace

getGlobalFacetTagField

getPropertyNameForFieldSearchable

getPropertyNameForFieldFacet

getSearchableFieldTypes

getPropertyNameForFieldSearchable

getPropertyNameForFieldFacet

convertPrefixListToString

getCategoryId

getProductId

getSkuId

getSolrDocumentId

getSolrDocumentId

getNamespaceFieldName

getIdFieldName

getProductIdFieldName

getSkuIdFieldName

getCategoryFieldName

getExplicitCategoryFieldName

getCategorySortFieldName

getCategorySortFieldName

getLocalePrefix

getDefaultLocalePrefix

getDefaultLocale

getPropertyValue

getPropertyValue

getPropertyValueInternal

copyPropertyToCollection