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

Class FacetEndpoint

java.lang.Object
com.broadleafcommerce.search.core.web.endpoint.FacetEndpoint
@FrameworkRestController @FrameworkMapping("/facets") @DataRouteByKey("search") public class FacetEndpoint extends Object

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FacetEndpoint(FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService, FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService, 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
    applyFieldIndexableTypeFilters(String fieldIndexableType, cz.jirutka.rsql.parser.ast.Node filters)
     
    protected com.broadleafcommerce.search.api.domain.FieldRef
    buildFieldRef(com.broadleafcommerce.search.api.domain.FieldDefinition field)
    Builds the FieldRef object based on a FieldDefinition
    com.broadleafcommerce.search.api.domain.Facet
    createFacet(com.broadleafcommerce.search.api.domain.Facet facet, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    void
    deleteFacet(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    protected FacetService<com.broadleafcommerce.search.api.domain.Facet>
    getFacetService()
     
    protected FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition>
    getFieldDefinitionService()
     
    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()
     
    protected com.broadleafcommerce.common.extension.TypeFactory
    getTypeFactory()
     
    org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.Facet>
    readAllFacets(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String fieldIndexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
     
    com.broadleafcommerce.search.api.domain.Facet
    readFacetById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    com.broadleafcommerce.translation.service.dto.TranslationsPayload
    replaceAllFacetTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
     
    com.broadleafcommerce.search.api.domain.Facet
    replaceFacet(com.broadleafcommerce.search.api.domain.Facet facet, 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)
     
    void
    setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • FacetEndpoint

      public FacetEndpoint(FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService, FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

  • Method Details

    • readAllFacets

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

    • readFacetById

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

    • createFacet

      @FrameworkPostMapping(consumes="application/json") @Policy(permissionRoots="FACET", operationTypes=CREATE) public com.broadleafcommerce.search.api.domain.Facet createFacet(@RequestBody com.broadleafcommerce.search.api.domain.Facet facet, @ContextOperation(CREATE) com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • deleteFacet

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

    • replaceFacet

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

    • replaceAllFacetTranslations

      @FrameworkPutMapping(value="/{id}/translations/{locale}", consumes="application/json") @Policy(permissionRoots="FACET") public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllFacetTranslations(@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)

    • buildFieldRef

      protected com.broadleafcommerce.search.api.domain.FieldRef buildFieldRef(com.broadleafcommerce.search.api.domain.FieldDefinition field)
      Builds the FieldRef object based on a FieldDefinition
      Returns:
      The FieldRef object.

    • applyFieldIndexableTypeFilters

      @NonNull protected cz.jirutka.rsql.parser.ast.Node applyFieldIndexableTypeFilters(String fieldIndexableType, cz.jirutka.rsql.parser.ast.Node filters)

    • getFacetService

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

    • getFieldDefinitionService

      protected FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> getFieldDefinitionService()

    • 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)

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

    • setTypeFactory

      @Autowired public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)