Class HeaderConfigTitle


  • public class HeaderConfigTitle
    extends java.lang.Object
    Configuration of an object (Type) header when displayed on report
    Author:
    radek
    See Also:
    in mind that we can apply special formatting to the paths, by adding [] or ** characters towards the beginning/end of the path and ReportObject needs to deal with that!
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  HeaderConfigTitle.TitlePart
      Holder for a path that appears in the title and any prefix and suffix values if they have been configured.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MAIN
      The first part of a page title.
      static java.lang.String SUB
      A subtitle.
      static java.lang.String[] TYPES
      The parts that make up a header (main title, sub title)
    • Field Detail

      • MAIN

        public static final java.lang.String MAIN
        The first part of a page title.
        See Also:
        Constant Field Values
      • TYPES

        public static final java.lang.String[] TYPES
        The parts that make up a header (main title, sub title)
    • Constructor Detail

      • HeaderConfigTitle

        public HeaderConfigTitle()
    • Method Detail

      • setMainTitles

        public void setMainTitles​(java.lang.String mainTitles)
        Set main title(s) path(s) for the object, e.g.: symbol, primaryIdentifier => eve FBgn0000606
        Parameters:
        mainTitles - a '|' delineated string of paths
      • setSubTitles

        public void setSubTitles​(java.lang.String subTitles)
        Set subtitle(s) path(s) for the object, e.g.: organism.shortName => D. melanogaster
        Parameters:
        subTitles - a '|' delineated string of paths
      • setNumberOfMainTitlesToShow

        public void setNumberOfMainTitlesToShow​(java.lang.Integer maxNumber)
        How many main titles to show in the main title
        Parameters:
        maxNumber - integer
      • getNumberOfMainTitlesToShow

        public java.lang.Integer getNumberOfMainTitlesToShow()
        Returns:
        number of main titles to show at the maximum
        See Also:
        might not want to show primaryId if we have a symbol etc.
      • addTitleParts

        public void addTitleParts​(java.util.HashMap<java.lang.String,​java.util.List<HeaderConfigTitle.TitlePart>> partsToAdd)
        Add title parts to this header config.
        Parameters:
        partsToAdd - parts to add to config
      • getTitles

        public java.util.HashMap<java.lang.String,​java.util.List<HeaderConfigTitle.TitlePart>> getTitles()
        Returns:
        map of titles
      • setAppendConfig

        public void setAppendConfig​(java.lang.Boolean value)
        Set whether to append config from parent
        Parameters:
        value - Boolean
      • getAppendConfig

        public java.lang.Boolean getAppendConfig()
        Returns:
        Boolean value as to whether or not to append configuration from parent