Package com.broadleafcommerce.search.core.web.endpoint

Class FacetGroupEndpoint

java.lang.Object
com.broadleafcommerce.search.core.web.endpoint.FacetGroupEndpoint
@FrameworkRestController @FrameworkMapping("/facet-groups") @DataRouteByKey("search") public class FacetGroupEndpoint extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BASE_URI
     
    static final String
    GROUP_INDEXABLE_TYPE
     
    static final String
    STRING_EQUALS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FacetGroupEndpoint(FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> facetGroupService, FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService, FacetGroupFacetService<com.broadleafcommerce.search.api.domain.FacetGroupFacet> facetGroupFacetService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected cz.jirutka.rsql.parser.ast.Node
    applyGroupIndexableTypeFilters(String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters)
     
    com.broadleafcommerce.search.api.domain.FacetGroupFacet
    createFacetForFacetGroup(String id, com.broadleafcommerce.search.api.domain.FacetGroupFacet facetGroupFacet, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    com.broadleafcommerce.search.api.domain.FacetGroup
    createFacetGroup(com.broadleafcommerce.search.api.domain.FacetGroup facetGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    void
    deleteFacetForFacetGroup(String id, String facetGroupFacetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    void
    deleteFacetGroup(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    protected FacetGroupFacetService<com.broadleafcommerce.search.api.domain.FacetGroupFacet>
    getFacetGroupFacetService()
     
    protected FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup>
    getFacetGroupService()
     
    protected FacetService<com.broadleafcommerce.search.api.domain.Facet>
    getFacetService()
     
    protected org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet>
    getFacetsForFacetGroup(String id, Boolean isSorted, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>
    getParser()
     
    protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>
    getTranslationEntityService()
     
    org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroup>
    readAllFacetGroups(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
     
    com.broadleafcommerce.search.api.domain.FacetGroup
    readFacetGroupById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet>
    readFacetsForFacetGroup(String id, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet>
    readFacetsForFacetGroup(String id, Boolean isSorted, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    com.broadleafcommerce.search.api.domain.FacetGroupFacet
    reorderFacetForFacetGroup(String id, String facetGroupFacetId, com.broadleafcommerce.data.tracking.core.sort.SortPositionRequest sortPositionRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    com.broadleafcommerce.translation.service.dto.TranslationsPayload
    replaceAllFacetGroupTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
     
    com.broadleafcommerce.search.api.domain.FacetGroup
    replaceFacetGroup(com.broadleafcommerce.search.api.domain.FacetGroup facetGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
     
    void
    setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)
     
    protected void
    validateFacetIsAssociatedWithFacetGroup(com.broadleafcommerce.search.api.domain.FacetGroupFacet facetGroupFacet, String facetGroupId)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • FacetGroupEndpoint

      public FacetGroupEndpoint(FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> facetGroupService, FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService, FacetGroupFacetService<com.broadleafcommerce.search.api.domain.FacetGroupFacet> facetGroupFacetService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

  • Method Details

    • readAllFacetGroups

      @FrameworkGetMapping @Policy(permissionRoots="FACET_GROUP", operationTypes=READ) public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroup> readAllFacetGroups(@ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, @RequestParam(value="q",required=false) String query, @RequestParam(value="groupIndexableType",required=false) String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters, @PageableDefault(size=50) org.springframework.data.domain.Pageable page)

    • readFacetGroupById

      @FrameworkGetMapping("/{id}") @Policy(permissionRoots="FACET_GROUP", operationTypes=READ) public com.broadleafcommerce.search.api.domain.FacetGroup readFacetGroupById(@PathVariable("id") String id, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • createFacetGroup

      @FrameworkPostMapping(consumes="application/json") @Policy(permissionRoots="FACET_GROUP", operationTypes=CREATE) public com.broadleafcommerce.search.api.domain.FacetGroup createFacetGroup(@RequestBody com.broadleafcommerce.search.api.domain.FacetGroup facetGroup, @ContextOperation(CREATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • deleteFacetGroup

      @FrameworkDeleteMapping("/{id}") @Policy(permissionRoots="FACET_GROUP", operationTypes=DELETE) public void deleteFacetGroup(@PathVariable("id") String id, @ContextOperation(DELETE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • replaceFacetGroup

      @FrameworkPutMapping(value="/{id}", consumes="application/json") @Policy(permissionRoots="FACET_GROUP", operationTypes=UPDATE) public com.broadleafcommerce.search.api.domain.FacetGroup replaceFacetGroup(@RequestBody com.broadleafcommerce.search.api.domain.FacetGroup facetGroup, @ContextOperation(UPDATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, @PathVariable("id") String id)

    • readFacetsForFacetGroup

      @FrameworkGetMapping("/{id}/facets") @Policy(permissionRoots="FACET_GROUP", operationTypes=READ) public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet> readFacetsForFacetGroup(@PathVariable("id") String id, cz.jirutka.rsql.parser.ast.Node filters, @PageableDefault(size=50) org.springframework.data.domain.Pageable page, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • readFacetsForFacetGroup

      @FrameworkGetMapping(value="/{id}/facets", params="isSorted") @Policy(permissionRoots="FACET_GROUP", operationTypes=READ) public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet> readFacetsForFacetGroup(@PathVariable("id") String id, @RequestParam(value="isSorted",required=false) Boolean isSorted, cz.jirutka.rsql.parser.ast.Node filters, @PageableDefault(size=50) org.springframework.data.domain.Pageable page, @ContextOperation com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • getFacetsForFacetGroup

      protected org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FacetGroupFacet> getFacetsForFacetGroup(String id, @Nullable Boolean isSorted, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • createFacetForFacetGroup

      @FrameworkPostMapping("/{id}/facets") @Policy(permissionRoots="FACET_GROUP", operationTypes=CREATE) public com.broadleafcommerce.search.api.domain.FacetGroupFacet createFacetForFacetGroup(@PathVariable("id") String id, @RequestBody com.broadleafcommerce.search.api.domain.FacetGroupFacet facetGroupFacet, @ContextOperation(CREATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • deleteFacetForFacetGroup

      @FrameworkDeleteMapping("/{id}/facets/{facetGroupFacetId}") @Policy(permissionRoots="FACET_GROUP", operationTypes=DELETE) public void deleteFacetForFacetGroup(@PathVariable("id") String id, @PathVariable("facetGroupFacetId") String facetGroupFacetId, @ContextOperation(DELETE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • reorderFacetForFacetGroup

      @FrameworkPatchMapping("/{id}/facets/{facetGroupFacetId}/sort") @Policy(permissionRoots="FACET_GROUP") public com.broadleafcommerce.search.api.domain.FacetGroupFacet reorderFacetForFacetGroup(@PathVariable("id") String id, @PathVariable("facetGroupFacetId") String facetGroupFacetId, @UpdateSortOperation("facetGroupFacetId") com.broadleafcommerce.data.tracking.core.sort.SortPositionRequest sortPositionRequest, @ContextOperation(UPDATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • replaceAllFacetGroupTranslations

      @FrameworkPutMapping(value="/{id}/translations/{locale}", consumes="application/json") @Policy(permissionRoots="FACET_GROUP") public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllFacetGroupTranslations(@ContextOperation(UPDATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo context, @PathVariable("id") String id, @PathVariable("locale") Locale locale, @RequestBody com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

    • applyGroupIndexableTypeFilters

      @NonNull protected cz.jirutka.rsql.parser.ast.Node applyGroupIndexableTypeFilters(String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters)

    • validateFacetIsAssociatedWithFacetGroup

      protected void validateFacetIsAssociatedWithFacetGroup(com.broadleafcommerce.search.api.domain.FacetGroupFacet facetGroupFacet, String facetGroupId)

    • getFacetGroupService

      protected FacetGroupService<com.broadleafcommerce.search.api.domain.FacetGroup> getFacetGroupService()

    • getFacetService

      protected FacetService<com.broadleafcommerce.search.api.domain.Facet> getFacetService()

    • getFacetGroupFacetService

      protected FacetGroupFacetService<com.broadleafcommerce.search.api.domain.FacetGroupFacet> getFacetGroupFacetService()

    • getTranslationEntityService

      protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()

    • getParser

      protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getParser()

    • setParser

      @Autowired public void setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)