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

Class FieldReferenceEndpoint

java.lang.Object
com.broadleafcommerce.search.core.web.endpoint.FieldReferenceEndpoint
@FrameworkRestController @FrameworkMapping("/field-refs") @DataRouteByKey("search") public class FieldReferenceEndpoint extends Object

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldReferenceEndpoint(FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected cz.jirutka.rsql.parser.ast.Node
    applyIndexableTypeFilters(String indexableType, 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
    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.common.extension.TypeFactory
    getTypeFactory()
     
    org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FieldRef>
    readAllFieldReferences(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String indexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
     
    com.broadleafcommerce.search.api.domain.FieldRef
    readFieldReferenceById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    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

    • FieldReferenceEndpoint

      public FieldReferenceEndpoint(FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService)

  • Method Details

    • readAllFieldReferences

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

    • readFieldReferenceById

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

    • applyIndexableTypeFilters

      @NonNull protected cz.jirutka.rsql.parser.ast.Node applyIndexableTypeFilters(String indexableType, cz.jirutka.rsql.parser.ast.Node filters)

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

    • getFieldDefinitionService

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

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