Package adams.flow.transformer

Class GenerateWordCloud

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, Serializable, Comparable
    public class GenerateWordCloud
extends adams.flow.transformer.AbstractTransformer
    Generates a word cloud from the incoming word frequencies.

    Input/output:
    - accepts:
       com.kennycason.kumo.WordFrequency[]
       com.kennycason.kumo.WordFrequency[][]
    - generates:
       adams.data.image.BufferedImageContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: GenerateWordCloud
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -width <int> (property: width)
    The width for the image.
    default: 600
    minimum: 1
 
    -height <int> (property: height)
    The height for the image.
    default: 300
    minimum: 1
 
    -collision-mode <RECTANGLE|PIXEL_PERFECT> (property: collisionMode)
    The collision mode to use.
    default: PIXEL_PERFECT
 
    -polar-blend-mode <EVEN|BLUR> (property: polarBlendMode)
    The polar blend mode to use.
    default: BLUR
 
    -padding <int> (property: padding)
    The padding to use.
    default: 2
    minimum: 0
 
    -color-palette <adams.flow.transformer.wordcloud.AbstractColorPalette> (property: colorPalette)
    The color palette to use.
    default: adams.flow.transformer.wordcloud.DefaultColorPalette
 
    -font-scalar <adams.flow.transformer.wordcloud.AbstractFontScalar> (property: fontScalar)
    The font scalar to use.
    default: adams.flow.transformer.wordcloud.DefaultFontScalar
 
    -background <adams.flow.transformer.wordcloud.AbstractBackground> (property: background)
    The background to use.
    default: adams.flow.transformer.wordcloud.DefaultBackground
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected AbstractBackground m_Background
      the background.
      protected com.kennycason.kumo.CollisionMode m_CollisionMode
      the collision mode.
      protected AbstractColorPalette m_ColorPalette
      the color palette to use.
      protected AbstractFontScalar m_FontScalar
      the font scalar to use.
      protected int m_Height
      the height.
      protected int m_Padding
      the padding.
      protected com.kennycason.kumo.PolarBlendMode m_PolarBlendMode
      the blendmode when combining two frequency lists.
      protected int m_Width
      the width.

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      String backgroundTipText()
      Returns the tip text for this property.
      String collisionModeTipText()
      Returns the tip text for this property.
      String colorPaletteTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String fontScalarTipText()
      Returns the tip text for this property.
      Class[] generates()
      Returns the class of objects that it generates.
      AbstractBackground getBackground()
      Returns the background to use.
      com.kennycason.kumo.CollisionMode getCollisionMode()
      Returns the collision mode in use.
      AbstractColorPalette getColorPalette()
      Returns the color palette to use.
      AbstractFontScalar getFontScalar()
      Returns the font scalar to use.
      int getHeight()
      Returns the height for the image.
      int getPadding()
      Returns the padding in use.
      com.kennycason.kumo.PolarBlendMode getPolarBlendMode()
      Returns the polar blend mode in use.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      int getWidth()
      Returns the width for the image.
      String globalInfo()
      Returns a string describing the object.
      String heightTipText()
      Returns the tip text for this property.
      String paddingTipText()
      Returns the tip text for this property.
      String polarBlendModeTipText()
      Returns the tip text for this property.
      void setBackground​(AbstractBackground value)
      Sets the background to use.
      void setCollisionMode​(com.kennycason.kumo.CollisionMode value)
      Sets the collision mode to use.
      void setColorPalette​(AbstractColorPalette value)
      Sets the color palette to use.
      void setFontScalar​(AbstractFontScalar value)
      Sets the font scalar to use.
      void setHeight​(int value)
      Sets the height for the image.
      void setPadding​(int value)
      Sets the padding to use.
      void setPolarBlendMode​(com.kennycason.kumo.PolarBlendMode value)
      Sets the polar blend mode to use.
      void setWidth​(int value)
      Sets the width for the image.
      String widthTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Width

        protected int m_Width
        the width.

      • m_Height

        protected int m_Height
        the height.

      • m_CollisionMode

        protected com.kennycason.kumo.CollisionMode m_CollisionMode
        the collision mode.

      • m_PolarBlendMode

        protected com.kennycason.kumo.PolarBlendMode m_PolarBlendMode
        the blendmode when combining two frequency lists.

      • m_Padding

        protected int m_Padding
        the padding.

    • Constructor Detail

      • GenerateWordCloud

        public GenerateWordCloud()

    • 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.flow.core.AbstractActor

      • setWidth

        public void setWidth​(int value)
        Sets the width for the image.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width for the image.
        Returns:
        the width

      • widthTipText

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

      • setHeight

        public void setHeight​(int value)
        Sets the height for the image.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height for the image.
        Returns:
        the height

      • heightTipText

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

      • setCollisionMode

        public void setCollisionMode​(com.kennycason.kumo.CollisionMode value)
        Sets the collision mode to use.
        Parameters:
        value - the mode

      • getCollisionMode

        public com.kennycason.kumo.CollisionMode getCollisionMode()
        Returns the collision mode in use.
        Returns:
        the mode

      • collisionModeTipText

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

      • setPolarBlendMode

        public void setPolarBlendMode​(com.kennycason.kumo.PolarBlendMode value)
        Sets the polar blend mode to use.
        Parameters:
        value - the mode

      • getPolarBlendMode

        public com.kennycason.kumo.PolarBlendMode getPolarBlendMode()
        Returns the polar blend mode in use.
        Returns:
        the mode

      • polarBlendModeTipText

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

      • setPadding

        public void setPadding​(int value)
        Sets the padding to use.
        Parameters:
        value - the padding

      • getPadding

        public int getPadding()
        Returns the padding in use.
        Returns:
        the padding

      • paddingTipText

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

      • setColorPalette

        public void setColorPalette​(AbstractColorPalette value)
        Sets the color palette to use.
        Parameters:
        value - the palette

      • getColorPalette

        public AbstractColorPalette getColorPalette()
        Returns the color palette to use.
        Returns:
        the palette

      • colorPaletteTipText

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

      • setFontScalar

        public void setFontScalar​(AbstractFontScalar value)
        Sets the font scalar to use.
        Parameters:
        value - the font scalar

      • getFontScalar

        public AbstractFontScalar getFontScalar()
        Returns the font scalar to use.
        Returns:
        the font scalar

      • fontScalarTipText

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

      • setBackground

        public void setBackground​(AbstractBackground value)
        Sets the background to use.
        Parameters:
        value - the background

      • getBackground

        public AbstractBackground getBackground()
        Returns the background to use.
        Returns:
        the background

      • backgroundTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message