Package com.funnelback.publicui.search.model.padre

Class ContextualNavigation

  • public class ContextualNavigation
extends java.lang.Object
    Contextual navigation parent class.
    Since:
    11.0
    See Also:
    Category, Cluster, ClusterNav

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ContextualNavigation.Schema
      Constants for the PADRE XML result packet tags.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<Category> categories
      List of categories (type, topic, site).
      private ClusterNav clusterNav
      Navigation items
      private java.util.Map<java.lang.String,​java.lang.Object> customData
      Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
      private java.lang.String searchTerm
      Terms used within this contextual navigation object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<Category> getCategories()
      List of categories (type, topic, site).
      ClusterNav getClusterNav()
      Navigation items
      java.util.Map<java.lang.String,​java.lang.Object> getCustomData()
      Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
      java.lang.String getSearchTerm()
      Terms used within this contextual navigation object
      void setClusterNav​(ClusterNav clusterNav)
      Navigation items
      void setSearchTerm​(java.lang.String searchTerm)
      Terms used within this contextual navigation object

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • searchTerm

        private java.lang.String searchTerm
        Terms used within this contextual navigation object

      • clusterNav

        private ClusterNav clusterNav
        Navigation items

      • categories

        private final java.util.List<Category> categories
        List of categories (type, topic, site).

      • customData

        private final java.util.Map<java.lang.String,​java.lang.Object> customData
        Custom data placeholder allowing any arbitrary data to be stored by hook scripts.

    • Constructor Detail

      • ContextualNavigation

        public ContextualNavigation()

    • Method Detail

      • getSearchTerm

        public java.lang.String getSearchTerm()
        Terms used within this contextual navigation object

      • setSearchTerm

        public void setSearchTerm​(java.lang.String searchTerm)
        Terms used within this contextual navigation object

      • getClusterNav

        public ClusterNav getClusterNav()
        Navigation items

      • setClusterNav

        public void setClusterNav​(ClusterNav clusterNav)
        Navigation items

      • getCategories

        public java.util.List<Category> getCategories()
        List of categories (type, topic, site).

      • getCustomData

        public java.util.Map<java.lang.String,​java.lang.Object> getCustomData()
        Custom data placeholder allowing any arbitrary data to be stored by hook scripts.