Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* #%L
* BroadleafCommerce Framework
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.core.search.service.solr;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.common.SolrInputDocument;
import org.broadleafcommerce.common.extension.ExtensionHandler;
import org.broadleafcommerce.common.extension.ExtensionResultStatusType;
import org.broadleafcommerce.common.locale.domain.Locale;
import org.broadleafcommerce.core.catalog.domain.Product;
import org.broadleafcommerce.core.search.domain.Field;
import org.broadleafcommerce.core.search.domain.ProductSearchCriteria;
import org.broadleafcommerce.core.search.domain.SearchFacetDTO;
import org.broadleafcommerce.core.search.domain.SearchFacetRange;
import org.broadleafcommerce.core.search.domain.solr.FieldType;
import java.lang.reflect.InvocationTargetException;
import java.util.List;
import java.util.Map;
/**
* @author Andre Azzolini (apazzolini), bpolster
*/
public interface SolrSearchServiceExtensionHandler extends ExtensionHandler {
/**
* Returns a prefix if required for the passed in facet.
*/
public ExtensionResultStatusType buildPrefixListForSearchableFacet(Field field, List prefixList);
/**
* Returns a prefix if required for the passed in searchable field.
*/
public ExtensionResultStatusType buildPrefixListForSearchableField(Field field, FieldType searchableFieldType,
List prefixList);
/**
* Builds the search facet ranges for the provided dto.
*
* @param context
* @param dto
* @param ranges
*/
public ExtensionResultStatusType filterSearchFacetRanges(SearchFacetDTO dto, List ranges);
/**
* Given the input field, populates the values array with the fields needed for the
* passed in field.
*
* For example, a handler might create multiple fields for the given passed in field.
* @param product
* @param field
* @param values
* @param propertyName
* @param locales
* @return
* @throws IllegalAccessException
* @throws InvocationTargetException
* @throws NoSuchMethodException
*/
public ExtensionResultStatusType addPropertyValues(Product product, Field field, FieldType fieldType,
Map values, String propertyName, List locales)
throws IllegalAccessException, InvocationTargetException, NoSuchMethodException;
/**
* Provides an extension point to modify the SolrQuery.
*
* @param context
* @param query
* @param qualifiedSolrQuery
* @param facets
* @param searchCriteria
* @param defaultSort
* * @return
*/
public ExtensionResultStatusType modifySolrQuery(SolrQuery query, String qualifiedSolrQuery,
List facets, ProductSearchCriteria searchCriteria, String defaultSort);
/**
* Allows the extension additional fields to the document that are not configured via the DB.
*/
public ExtensionResultStatusType attachAdditionalBasicFields(Product product, SolrInputDocument document,
SolrHelperService shs);
/**
* In certain scenarios, we may want to produce a different Solr document id than the default.
* If this method returns {@link ExtensionResultStatusType#HANDLED}, the value placed in the 0th element
* in the returnContainer should be used.
*
* @param document
* @param product
* @return the extension result status type
*/
public ExtensionResultStatusType getSolrDocumentId(SolrInputDocument document, Product product, String[] returnContainer);
/**
* In certain scenarios, the requested category id might not be the one that should be used in Solr.
* If this method returns {@link ExtensionResultStatusType#HANDLED}, the value placed in the 0th element
* in the returnContainer should be used.
*
* @param tentativeId
* @param returnContainer
* @return the extension result status type
*/
public ExtensionResultStatusType getCategoryId(Long tentativeId, Long[] returnContainer);
/**
* In certain scenarios, the requested product id might not be the one that should be used in Solr.
* If this method returns {@link ExtensionResultStatusType#HANDLED}, the value placed in the 0th element
* in the returnContainer should be used.
*
* @param tentativeId
* @param returnContainer
* @return the extension result status type
*/
public ExtensionResultStatusType getProductId(Long tentativeId, Long[] returnContainer);
}
