/*
* #%L
* BroadleafCommerce Framework Web
* %%
* 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.web.processor;
import org.apache.commons.lang.StringUtils;
import org.broadleafcommerce.common.extension.ExtensionResultHolder;
import org.broadleafcommerce.common.extension.ExtensionResultStatusType;
import org.broadleafcommerce.common.web.dialect.AbstractModelVariableModifierProcessor;
import org.broadleafcommerce.core.catalog.domain.Category;
import org.broadleafcommerce.core.catalog.domain.CategoryXref;
import org.broadleafcommerce.core.catalog.service.CatalogService;
import org.thymeleaf.Arguments;
import org.thymeleaf.dom.Element;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Resource;
/**
* A Thymeleaf processor that will add the desired categories to the model. It does this by
* searching for the <b>parentCategory</b> by name> and adding up to <b>maxResults</b> subcategories under
* the model attribute specified by <b>resultVar</b>
*
* @param parentCategory (required) the name of the parent category to get subcategories from
* @param resultVar (required) the model variable that the resulting list of categories should be set to
* @param maxResults (optional) the maximum number of categories to return
*
* @author apazzolini
*/
public class CategoriesProcessor extends AbstractModelVariableModifierProcessor {
@Resource(name = "blCatalogService")
protected CatalogService catalogService;
@Resource(name = "blCategoriesProcessorExtensionManager")
protected CategoriesProcessorExtensionManager extensionManager;
/**
* Sets the name of this processor to be used in Thymeleaf template
*/
public CategoriesProcessor() {
super("categories");
}
@Override
public int getPrecedence() {
return 10000;
}
@Override
protected void modifyModelAttributes(Arguments arguments, Element element) {
String resultVar = element.getAttributeValue("resultVar");
String parentCategory = element.getAttributeValue("parentCategory");
String unparsedMaxResults = element.getAttributeValue("maxResults");
if (extensionManager != null) {
ExtensionResultHolder holder = new ExtensionResultHolder();
ExtensionResultStatusType result = extensionManager.getProxy().findAllPossibleChildCategories(parentCategory, unparsedMaxResults, holder);
if (ExtensionResultStatusType.HANDLED.equals(result)) {
addToModel(arguments, resultVar, holder.getResult());
return;
}
}
// TODO: Potentially write an algorithm that will pick the minimum depth category
// instead of the first category in the list
List<Category> categories = catalogService.findCategoriesByName(parentCategory);
if (categories != null && categories.size() > 0) {
// gets child categories in order ONLY if they are in the xref table and active
List<CategoryXref> subcategories = categories.get(0).getChildCategoryXrefs();
if (subcategories != null && !subcategories.isEmpty()) {
if (StringUtils.isNotEmpty(unparsedMaxResults)) {
int maxResults = Integer.parseInt(unparsedMaxResults);
if (subcategories.size() > maxResults) {
subcategories = subcategories.subList(0, maxResults);
}
}
}
List<Category> results = new ArrayList<Category>(subcategories.size());
for (CategoryXref xref : subcategories) {
results.add(xref.getSubCategory());
}
addToModel(arguments, resultVar, results);
}
}
}