Package io.virtdata.docsys.metafs.fs.renderfs.model.topics

Interface Topic

    • Method Summary

      Modifier and Type Method Description
      void addSubTopic​(Topic topic)
      Add a subtopic to this topic.
      java.lang.String getId()
      Return the self-same generated ref id that will be rendered in HTML.
      default java.lang.String getIndent()  
      default java.lang.String getIndent2()  
      int getLevel()
      Get a level associated with this topic.
      java.lang.String getName()  
      java.lang.String getPath()  
      java.util.LinkedList<Topic> getSubTopics()
      Get subtopics that are associated with this topic, or contained by this topic.
      void setLevel​(int i)  

    • Method Detail

      • getName

        java.lang.String getName()

      • getId

        java.lang.String getId()
        Return the self-same generated ref id that will be rendered in HTML. The rendered HTML and the parsed model of the markdown use the same generator scheme.
        Returns:
        A simple text based ref id

      • getPath

        java.lang.String getPath()
        Returns:
        the logical path associated with this topic, without the extension.

      • getLevel

        int getLevel()
        Get a level associated with this topic. Lower numbers represent broader topics. The is akin to "indentation level".
        Returns:
        The level of nesting for this topic

      • setLevel

        void setLevel​(int i)

      • getSubTopics

        java.util.LinkedList<Topic> getSubTopics()
        Get subtopics that are associated with this topic, or contained by this topic.
        Returns:
        A list of topics

      • addSubTopic

        void addSubTopic​(Topic topic)
        Add a subtopic to this topic.
        Parameters:
        topic - a ne subtopic

      • getIndent

        default java.lang.String getIndent()

      • getIndent2

        default java.lang.String getIndent2()