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

Class ClusterNav

  • public class ClusterNav
extends java.lang.Object

    Contextual navigation details to navigate through results and clusters.

    For example you can follow a navigation path like:

    • King
    • King Richard
    • King Richard the great

    For each step a ClusterNav item will be provided.

    Since:
    11.0
    See Also:
    ContextualNavigation, Category, Cluster

    • Nested Class Summary

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String label
      Label for this navigation item, such as "King Richard".
      private java.lang.Integer level
      Level of this navigation item.
      private java.lang.String url
      URL to reach this navigation item.

    • Constructor Summary

      Constructors 
      Constructor Description
      ClusterNav()  
      ClusterNav​(java.lang.Integer level, java.lang.String url, java.lang.String label)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLabel()
      Label for this navigation item, such as "King Richard".
      java.lang.Integer getLevel()
      Level of this navigation item.
      java.lang.String getUrl()
      URL to reach this navigation item.
      void setLabel​(java.lang.String label)
      Label for this navigation item, such as "King Richard".
      void setLevel​(java.lang.Integer level)
      Level of this navigation item.
      void setUrl​(java.lang.String url)
      URL to reach this navigation item.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • level

        private java.lang.Integer level

        Level of this navigation item.

        0 is used for the root, then 1, 2, etc.

      • url

        private java.lang.String url

        URL to reach this navigation item.

      • label

        private java.lang.String label
        Label for this navigation item, such as "King Richard".

    • Constructor Detail

      • ClusterNav

        public ClusterNav​(java.lang.Integer level,
                  java.lang.String url,
                  java.lang.String label)

      • ClusterNav

        public ClusterNav()

    • Method Detail

      • getLevel

        public java.lang.Integer getLevel()

        Level of this navigation item.

        0 is used for the root, then 1, 2, etc.

      • setLevel

        public void setLevel​(java.lang.Integer level)

        Level of this navigation item.

        0 is used for the root, then 1, 2, etc.

      • getUrl

        public java.lang.String getUrl()

        URL to reach this navigation item.

      • setUrl

        public void setUrl​(java.lang.String url)

        URL to reach this navigation item.

      • getLabel

        public java.lang.String getLabel()
        Label for this navigation item, such as "King Richard".

      • setLabel

        public void setLabel​(java.lang.String label)
        Label for this navigation item, such as "King Richard".