Class Profile


  • public class Profile
    extends java.lang.Object

    A search profile.

    Profile configurations resides in a sub directory in the main collection's conf/[collection]/ directory.

    Each profile can have specific query processor options and a specific faceted navigation configuration.

    Each collection comes with two default profiles, _default and _default_preview used in the preview / publish system.

    Since:
    11.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Profile.ProfileBuilder  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private CuratorConfig curatorConfig
      Curator configuration in conf/[collection]/[profile]/curator.json or conf/[collection]/[profile]/curator.yaml.
      private FacetedNavigationConfig facetedNavConfConfig
      Faceted navigation configuration in conf/[collection]/[profile]/faceted_navigation.cfg
      private java.lang.String id
      Profile id, identical to the name of the folder containing the profile configuration under conf/[collection]/[profile]/.
      private java.lang.String padreOpts
      Specific query processor options for this profile.
      private com.funnelback.config.configtypes.service.ServiceConfigReadOnly serviceConfig  
    • Constructor Summary

      Constructors 
      Constructor Description
      Profile()  
      Profile​(java.lang.String id)  
      Profile​(java.lang.String id, FacetedNavigationConfig facetedNavConfConfig, CuratorConfig curatorConfig, com.funnelback.config.configtypes.service.ServiceConfigReadOnly serviceConfig, java.lang.String padreOpts)  
    • Field Detail

      • id

        private java.lang.String id
        Profile id, identical to the name of the folder containing the profile configuration under conf/[collection]/[profile]/.
      • facetedNavConfConfig

        private FacetedNavigationConfig facetedNavConfConfig
        Faceted navigation configuration in conf/[collection]/[profile]/faceted_navigation.cfg
      • curatorConfig

        private CuratorConfig curatorConfig
        Curator configuration in conf/[collection]/[profile]/curator.json or conf/[collection]/[profile]/curator.yaml. JSON takes precedence.
      • serviceConfig

        private com.funnelback.config.configtypes.service.ServiceConfigReadOnly serviceConfig
      • padreOpts

        private java.lang.String padreOpts

        Specific query processor options for this profile.

        Read from conf/[collection]/[profile]/padre_opts.cfg.

    • Constructor Detail

      • Profile

        public Profile​(java.lang.String id)
      • Profile

        public Profile()
      • Profile

        public Profile​(java.lang.String id,
                       FacetedNavigationConfig facetedNavConfConfig,
                       CuratorConfig curatorConfig,
                       com.funnelback.config.configtypes.service.ServiceConfigReadOnly serviceConfig,
                       java.lang.String padreOpts)
    • Method Detail

      • cloneBuilder

        public Profile.ProfileBuilder cloneBuilder()
        A Profile builder with the currently set fields already set on the builder.
        Returns:
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getId

        public java.lang.String getId()
        Profile id, identical to the name of the folder containing the profile configuration under conf/[collection]/[profile]/.
      • getFacetedNavConfConfig

        public FacetedNavigationConfig getFacetedNavConfConfig()
        Faceted navigation configuration in conf/[collection]/[profile]/faceted_navigation.cfg
      • setFacetedNavConfConfig

        public void setFacetedNavConfConfig​(FacetedNavigationConfig facetedNavConfConfig)
        Faceted navigation configuration in conf/[collection]/[profile]/faceted_navigation.cfg
      • getCuratorConfig

        public CuratorConfig getCuratorConfig()
        Curator configuration in conf/[collection]/[profile]/curator.json or conf/[collection]/[profile]/curator.yaml. JSON takes precedence.
      • setCuratorConfig

        public void setCuratorConfig​(CuratorConfig curatorConfig)
        Curator configuration in conf/[collection]/[profile]/curator.json or conf/[collection]/[profile]/curator.yaml. JSON takes precedence.
      • getServiceConfig

        public com.funnelback.config.configtypes.service.ServiceConfigReadOnly getServiceConfig()
      • setServiceConfig

        public void setServiceConfig​(com.funnelback.config.configtypes.service.ServiceConfigReadOnly serviceConfig)
      • getPadreOpts

        public java.lang.String getPadreOpts()

        Specific query processor options for this profile.

        Read from conf/[collection]/[profile]/padre_opts.cfg.

      • setPadreOpts

        public void setPadreOpts​(java.lang.String padreOpts)

        Specific query processor options for this profile.

        Read from conf/[collection]/[profile]/padre_opts.cfg.