com.broadleafcommerce.enterprise.admin.service

Class TreeListGridBuilderServiceImpl

java.lang.Object

com.broadleafcommerce.enterprise.admin.service.TreeListGridBuilderServiceImpl

All Implemented Interfaces:

TreeListGridBuilderService

@Service(value="blTreeListGridBuilderService")
public class TreeListGridBuilderServiceImpl
extends Object
implements TreeListGridBuilderService

Author:

ckittrell

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALL_CHILD_CATEGORY_XREFS
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected static String	DEFAULT_ROOT_CATEGORY_NAME
protected org.broadleafcommerce.openadmin.web.service.FormBuilderService	formBuilderService
protected static String	PARENT_ID
protected static String	PARENT_PATH_FIELD_NAME
protected org.broadleafcommerce.common.sandbox.SandBoxHelper	sandBoxHelper
protected org.broadleafcommerce.openadmin.server.service.AdminEntityService	service
protected static String	TARGET_ID
protected static String	TREE_PARENT_PATH_JSON
protected TreeListGridBuilderDao	treeListGridBuilderDao
protected com.broadleafcommerce.enterprise.common.extension.enterprise.AdminTreeListGridExtensionManager	treeListGridExtensionManager

Constructor Summary

Constructors

Constructor and Description
TreeListGridBuilderServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addRootCategoryToResult(List<String> result) Make sure to add the Id of the default root category.
TreeListGrid	buildTreeListGrid(org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr, String sectionKey, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs, org.springframework.util.MultiValueMap<String,String> requestParams, String treeParentPathJson, Boolean isLookup) Service method to create a TreeListGrid object.
TreeListGridColumn	buildTreeListGridColumn(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr, org.broadleafcommerce.openadmin.dto.DynamicResultSet drs, org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, String sectionKey, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs, String parentId, Boolean isLookup) Service method to create a TreeListGridColumn object.
protected String	buildTreeParentPathJson(List<org.broadleafcommerce.core.catalog.domain.Category> parentPath)
org.broadleafcommerce.openadmin.web.form.component.ListGrid	buildTreeSearchListGrid(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr, org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, String sectionKey, List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs, Boolean isLookup) Service method to create a TreeListGrid's associated search ListGrid.
protected Integer	getCategoryRowIndex(org.broadleafcommerce.core.catalog.domain.Category category)
protected Integer	getColumnStartIndex(org.broadleafcommerce.core.catalog.domain.Category category)
protected Integer	getColumnStartIndex(String treeParentPathJson, int columnDepth)
protected int	getDefaultMaxResults()
protected List<String>	getParentCategoryIds(org.springframework.util.MultiValueMap<String,String> requestParams, String treeParentPathJson)
String	getTreeParentPathJson(org.springframework.util.MultiValueMap<String,String> requestParams) Service method to gather the tree's parentPathJson.
protected boolean	isParentRoot(org.broadleafcommerce.core.catalog.domain.Category targetCategory)
protected Integer	manipulateStartIndexWithMaxResults(Integer rowIndex)
protected boolean	shouldOnlyRetrieveNextColumn(org.springframework.util.MultiValueMap<String,String> requestParams)
protected boolean	shouldRetrievePathToTarget(org.springframework.util.MultiValueMap<String,String> requestParams)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROOT_CATEGORY_NAME

protected static final String DEFAULT_ROOT_CATEGORY_NAME

See Also:

Constant Field Values

ALL_CHILD_CATEGORY_XREFS

protected static final String ALL_CHILD_CATEGORY_XREFS

See Also:

Constant Field Values

TREE_PARENT_PATH_JSON

protected static final String TREE_PARENT_PATH_JSON

See Also:

Constant Field Values

PARENT_PATH_FIELD_NAME

protected static final String PARENT_PATH_FIELD_NAME

See Also:

Constant Field Values

TARGET_ID

protected static final String TARGET_ID

See Also:

Constant Field Values

PARENT_ID

protected static final String PARENT_ID

See Also:

Constant Field Values

service

protected org.broadleafcommerce.openadmin.server.service.AdminEntityService service

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

formBuilderService

protected org.broadleafcommerce.openadmin.web.service.FormBuilderService formBuilderService

sandBoxHelper

protected org.broadleafcommerce.common.sandbox.SandBoxHelper sandBoxHelper

treeListGridBuilderDao

protected TreeListGridBuilderDao treeListGridBuilderDao

treeListGridExtensionManager

protected com.broadleafcommerce.enterprise.common.extension.enterprise.AdminTreeListGridExtensionManager treeListGridExtensionManager

Constructor Detail

TreeListGridBuilderServiceImpl

public TreeListGridBuilderServiceImpl()

Method Detail

buildTreeListGrid

public TreeListGrid buildTreeListGrid(org.broadleafcommerce.openadmin.dto.ClassMetadata cmd,
                                      org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr,
                                      String sectionKey,
                                      List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs,
                                      org.springframework.util.MultiValueMap<String,String> requestParams,
                                      String treeParentPathJson,
                                      Boolean isLookup)
                               throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: TreeListGridBuilderService

Service method to create a TreeListGrid object. TreeListGrids are essentially a collection of TreeListGridColumns.

Specified by:

buildTreeListGrid in interface TreeListGridBuilderService

Returns:

the TreeListGrid

Throws:

org.broadleafcommerce.common.exception.ServiceException

buildTreeListGridColumn

public TreeListGridColumn buildTreeListGridColumn(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr,
                                                  org.broadleafcommerce.openadmin.dto.DynamicResultSet drs,
                                                  org.broadleafcommerce.openadmin.dto.ClassMetadata cmd,
                                                  String sectionKey,
                                                  List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs,
                                                  String parentId,
                                                  Boolean isLookup)
                                           throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: TreeListGridBuilderService

Service method to create a TreeListGridColumn object.

Specified by:

buildTreeListGridColumn in interface TreeListGridBuilderService

Returns:

the ListGrid

Throws:

org.broadleafcommerce.common.exception.ServiceException

buildTreeSearchListGrid

public org.broadleafcommerce.openadmin.web.form.component.ListGrid buildTreeSearchListGrid(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest ppr,
                                                                                           org.broadleafcommerce.openadmin.dto.ClassMetadata cmd,
                                                                                           String sectionKey,
                                                                                           List<org.broadleafcommerce.openadmin.dto.SectionCrumb> sectionCrumbs,
                                                                                           Boolean isLookup)
                                                                                    throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: TreeListGridBuilderService

Service method to create a TreeListGrid's associated search ListGrid.

Specified by:

buildTreeSearchListGrid in interface TreeListGridBuilderService

Returns:

the ListGrid

Throws:

org.broadleafcommerce.common.exception.ServiceException

getParentCategoryIds

protected List<String> getParentCategoryIds(org.springframework.util.MultiValueMap<String,String> requestParams,
                                            String treeParentPathJson)

addRootCategoryToResult

protected void addRootCategoryToResult(List<String> result)

Make sure to add the Id of the default root category. This ensures that the first level of the hierarchy is correctly displayed in the first column.

Parameters:

result -

requestParams -

getTreeParentPathJson

public String getTreeParentPathJson(org.springframework.util.MultiValueMap<String,String> requestParams)

Description copied from interface: TreeListGridBuilderService

Service method to gather the tree's parentPathJson.

Specified by:

getTreeParentPathJson in interface TreeListGridBuilderService

Returns:

the tree's parentPathJson

shouldRetrievePathToTarget

protected boolean shouldRetrievePathToTarget(org.springframework.util.MultiValueMap<String,String> requestParams)

shouldOnlyRetrieveNextColumn

protected boolean shouldOnlyRetrieveNextColumn(org.springframework.util.MultiValueMap<String,String> requestParams)

isParentRoot

protected boolean isParentRoot(org.broadleafcommerce.core.catalog.domain.Category targetCategory)

buildTreeParentPathJson

protected String buildTreeParentPathJson(List<org.broadleafcommerce.core.catalog.domain.Category> parentPath)

getCategoryRowIndex

protected Integer getCategoryRowIndex(org.broadleafcommerce.core.catalog.domain.Category category)

getColumnStartIndex

protected Integer getColumnStartIndex(org.broadleafcommerce.core.catalog.domain.Category category)

getColumnStartIndex

protected Integer getColumnStartIndex(String treeParentPathJson,
                                      int columnDepth)

manipulateStartIndexWithMaxResults

protected Integer manipulateStartIndexWithMaxResults(Integer rowIndex)

getDefaultMaxResults

protected int getDefaultMaxResults()