Package adams.flow.transformer.wordcloud

Class SqrtFontScalar

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class SqrtFontScalar
extends AbstractFontScalar
    Uses squareroot scaling between the specified min and max.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Max
      the maximum font size.
      protected int m_Min
      the minimum font size.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      SqrtFontScalar()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      com.kennycason.kumo.font.scale.FontScalar generate​(adams.core.MessageCollection errors)
      Generates the font scalar.
      int getMax()
      Returns the maximum font size.
      int getMin()
      Returns the minimum font size.
      String globalInfo()
      Returns a string describing the object.
      String maxTipText()
      Returns the tip text for this property.
      String minTipText()
      Returns the tip text for this property.
      void setMax​(int value)
      Sets the maximum font size.
      void setMin​(int value)
      Sets the minimum font size.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Min

        protected int m_Min
        the minimum font size.

      • m_Max

        protected int m_Max
        the maximum font size.

    • Constructor Detail

      • SqrtFontScalar

        public SqrtFontScalar()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setMin

        public void setMin​(int value)
        Sets the minimum font size.
        Parameters:
        value - the minimum

      • getMin

        public int getMin()
        Returns the minimum font size.
        Returns:
        the minimum

      • minTipText

        public String minTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMax

        public void setMax​(int value)
        Sets the maximum font size.
        Parameters:
        value - the maximum

      • getMax

        public int getMax()
        Returns the maximum font size.
        Returns:
        the maximum

      • maxTipText

        public String maxTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generate

        public com.kennycason.kumo.font.scale.FontScalar generate​(adams.core.MessageCollection errors)
        Generates the font scalar.
        Specified by:
        generate in class AbstractFontScalar
        Parameters:
        errors - for collecting errors
        Returns:
        the font scalar, null if none generated