/*
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2001 - 2013 Object Refinery Ltd, Pentaho Corporation and Contributors..  All rights reserved.
 */

package org.pentaho.reporting.engine.classic.core.function.strings;

import org.pentaho.reporting.engine.classic.core.function.AbstractExpression;

import java.util.StringTokenizer;

/**
 * Tokenizes a string and replaces all occurences of the delimeter with the value given in replacement. An optional
 * prefix and suffix can be appended to the string.
 *
 * @author Thomas Morgner
 * @deprecated Use a formula: "prefix & SUBSTITUTE(field, delimeter, replacement) & suffix"
 */
public class TokenizeStringExpression extends AbstractExpression {
  /**
   * The field from where to read the original value.
   */
  private String field;
  /**
   * The delimeter value.
   */
  private String delimeter;
  /**
   * The replacement value.
   */
  private String replacement;
  /**
   * The (optional) prefix value.
   */
  private String prefix;
  /**
   * The (optional) suffix value.
   */
  private String suffix;

  /**
   * Default Constructor.
   */
  public TokenizeStringExpression() {
  }

  /**
   * Returns the name of the datarow-column from where to read the string value.
   *
   * @return the field.
   */
  public String getField() {
    return field;
  }

  /**
   * Defines the name of the datarow-column from where to read the string value.
   *
   * @param field
   *          the field.
   */
  public void setField( final String field ) {
    this.field = field;
  }

  /**
   * Returns the delimeter string.
   *
   * @return the delimeter.
   */
  public String getDelimeter() {
    return delimeter;
  }

  /**
   * Defines the delimeter string.
   *
   * @param delimeter
   *          the delimeter.
   */
  public void setDelimeter( final String delimeter ) {
    this.delimeter = delimeter;
  }

  /**
   * Returns the replacement for the delimter.
   *
   * @return the replacement text.
   */
  public String getReplacement() {
    return replacement;
  }

  /**
   * Defines the replacement for the delimter.
   *
   * @param replacement
   *          the replacement text.
   */
  public void setReplacement( final String replacement ) {
    this.replacement = replacement;
  }

  /**
   * Returns the prefix text.
   *
   * @return the prefix text.
   */
  public String getPrefix() {
    return prefix;
  }

  /**
   * Defines the prefix text.
   *
   * @param prefix
   *          the prefix text.
   */
  public void setPrefix( final String prefix ) {
    this.prefix = prefix;
  }

  /**
   * Returns the suffix text.
   *
   * @return the suffix text.
   */
  public String getSuffix() {
    return suffix;
  }

  /**
   * Defines the suffix text.
   *
   * @param suffix
   *          the suffix text.
   */
  public void setSuffix( final String suffix ) {
    this.suffix = suffix;
  }

  /**
   * Computes the tokenized string. Replaces
   *
   * @return the value of the function.
   */
  public Object getValue() {
    final Object raw = getDataRow().get( getField() );
    if ( raw == null ) {
      return null;
    }
    final String text = String.valueOf( raw );

    final StringBuffer buffer = new StringBuffer();
    if ( prefix != null ) {
      buffer.append( prefix );
    }

    if ( delimeter != null ) {
      final StringTokenizer strtok = new StringTokenizer( text, delimeter, false );
      while ( strtok.hasMoreTokens() ) {
        final String o = strtok.nextToken();
        buffer.append( o );
        if ( replacement != null && strtok.hasMoreTokens() ) {
          buffer.append( replacement );
        }
      }
    }

    if ( suffix != null ) {
      buffer.append( suffix );
    }
    return buffer.toString();
  }
}