Class TextSaver

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, EnvironmentHandler, BeanCommon, TextListener, Visible

@KFStep(category="DataSinks", toolTipText="Save text output to a file") public class TextSaver extends JPanel implements TextListener, BeanCommon, Visible, Serializable, EnvironmentHandler
Simple component to save the text carried in text events out to a file
Version:
$Revision: 9250 $
Author:
thuvh (thuvh87{[at]}gmail{[dot]}com), Mark Hall (mhall{[at]}pentaho{[dot]}com)
See Also:
  • Constructor Details

    • TextSaver

      public TextSaver()
      Default constructors a new TextSaver
  • Method Details

    • globalInfo

      public String globalInfo()
      Global info for this bean
      Returns:
      a String value
    • setFilename

      public void setFilename(String filename)
      Set the filename to save to
      Parameters:
      filename - the filename to save to
    • getFilename

      public String getFilename()
      Get the filename to save to
      Returns:
      the filename to save to
    • setAppend

      public void setAppend(boolean append)
    • getAppend

      public boolean getAppend()
    • setEnvironment

      public void setEnvironment(Environment env)
      Set environment variables to use
      Specified by:
      setEnvironment in interface EnvironmentHandler
      Parameters:
      env - the environment variables to use
    • useDefaultVisual

      public void useDefaultVisual()
      Description copied from interface: Visible
      Use the default visual representation
      Specified by:
      useDefaultVisual in interface Visible
    • setVisual

      public void setVisual(BeanVisual newVisual)
      Description copied from interface: Visible
      Set a new visual representation
      Specified by:
      setVisual in interface Visible
      Parameters:
      newVisual - a BeanVisual value
    • getVisual

      public BeanVisual getVisual()
      Description copied from interface: Visible
      Get the visual representation
      Specified by:
      getVisual in interface Visible
      Returns:
      a BeanVisual value
    • setCustomName

      public void setCustomName(String name)
      Description copied from interface: BeanCommon
      Set a custom (descriptive) name for this bean
      Specified by:
      setCustomName in interface BeanCommon
      Parameters:
      name - the name to use
    • getCustomName

      public String getCustomName()
      Description copied from interface: BeanCommon
      Get the custom (descriptive) name for this bean (if one has been set)
      Specified by:
      getCustomName in interface BeanCommon
      Returns:
      the custom name (or the default name)
    • stop

      public void stop()
      Description copied from interface: BeanCommon
      Stop any processing that the bean might be doing.
      Specified by:
      stop in interface BeanCommon
    • isBusy

      public boolean isBusy()
      Description copied from interface: BeanCommon
      Returns true if. at this time, the bean is busy with some (i.e. perhaps a worker thread is performing some calculation).
      Specified by:
      isBusy in interface BeanCommon
      Returns:
      true if the bean is busy.
    • setLog

      public void setLog(Logger logger)
      Description copied from interface: BeanCommon
      Set a logger
      Specified by:
      setLog in interface BeanCommon
      Parameters:
      logger - a weka.gui.Logger value
    • connectionAllowed

      public boolean connectionAllowed(EventSetDescriptor esd)
      Description copied from interface: BeanCommon
      Returns true if, at this time, the object will accept a connection via the named event
      Specified by:
      connectionAllowed in interface BeanCommon
      Parameters:
      esd - the EventSetDescriptor for the event in question
      Returns:
      true if the object will accept a connection
    • connectionAllowed

      public boolean connectionAllowed(String eventName)
      Description copied from interface: BeanCommon
      Returns true if, at this time, the object will accept a connection via the named event
      Specified by:
      connectionAllowed in interface BeanCommon
      Parameters:
      eventName - the name of the event
      Returns:
      true if the object will accept a connection
    • connectionNotification

      public void connectionNotification(String eventName, Object source)
      Description copied from interface: BeanCommon
      Notify this object that it has been registered as a listener with a source for recieving events described by the named event This object is responsible for recording this fact.
      Specified by:
      connectionNotification in interface BeanCommon
      Parameters:
      eventName - the event
      source - the source with which this object has been registered as a listener
    • disconnectionNotification

      public void disconnectionNotification(String eventName, Object source)
      Description copied from interface: BeanCommon
      Notify this object that it has been deregistered as a listener with a source for named event. This object is responsible for recording this fact.
      Specified by:
      disconnectionNotification in interface BeanCommon
      Parameters:
      eventName - the event
      source - the source with which this object has been registered as a listener
    • acceptText

      public void acceptText(TextEvent textEvent)
      Accept and process an TextEvent
      Specified by:
      acceptText in interface TextListener
      Parameters:
      textEvent - the TextEvent to process