package org.openphacts.nextprot.util;
   
   /**
    * <code>EchoTool</code> is a simple tool that can be placed in a velocity context to
    * enable output to the console.
    *
    * Created: Wed Jun 13 15:01:33 2012
    *
    * @author <a href="mailto:">Oliver Karch</a>
   * @version 1.0
   */
  import java.math.BigDecimal;
  
  import org.apache.velocity.tools.generic.SafeConfig;
  
  public class EchoTool extends SafeConfig {
      private Object hashMark;
      private int maxColumns;
      private long progressCount;
  
      /**
       * Creates the echo tool
       */
      public EchoTool() {
  	super();
  	this.hashMark = new String( "#" );
  	this.maxColumns = 80;
  	this.progressCount = 0L;
      } // EchoTool constructor
      
      /**
       * Prints a message to stdout.
       *
       * @param x the message object
       */
      public void println( Object x ) {
  	if( x != null )
  	    System.out.println( x );
      }
  
      private BigDecimal convertNumber( Object x ) {
  	BigDecimal num = null;
  	if( x != null ) {
  	    try {
  		num = new BigDecimal( x.toString() );
  	    }
  	    catch( NumberFormatException nfe ) {
  		num = null;
  	    }
  	}
  	return num;
      }
  
      private void printHashMark() {
  	if( (progressCount % (long)maxColumns) == 0 )
  	    System.out.println();
  	if( hashMark != null ) 
  	    System.out.print( hashMark );
      }
  
      /**
       * Resets the progress meter
       */
      public void startProgress() {
  	this.progressCount = 0L;
      }
  
      /**
       * Advances the progress meter by a certain amount.
       *
       * @param amount the amount of progress.
       */
      public void advance( Object amount ) {
  	BigDecimal amt = convertNumber( amount );
  	if( amt != null ) {
  	    progressCount+=amt.longValue();
  	    printHashMark();
  	}
      }
  
      /**
       * Advances the progress meter by a single unit.
       */
      public void advance() {
  	progressCount++;
  	printHashMark();
      }
  
      /**
       * Get the HashMark value.
       * @return the HashMark value.
       */
      public Object getMark() {
  	return hashMark;
      }
  
      /**
       * Set the HashMark value.
       * @param newHashMark The new HashMark value.
      */
     public void setMark(Object newHashMark) {
 	this.hashMark = newHashMark;
     }
     
     /**
      * Get the MaxCols value.
      * @return the MaxCols value.
      */
     public Object getColumns() {
 	return new Integer(maxColumns);
     }
 
     /**
      * Set the MaxCols value.
      * @param newMaxCols The new MaxCols value.
      */
     public void setColumns(Object newMaxCols) {
 	BigDecimal cols = convertNumber( newMaxCols );
 	if( cols != null ) 
 	    maxColumns = cols.intValue();
     }
     
 } // EchoTool