com.google.refine.expr.functions.strings.ReplaceEach Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of main Show documentation
OpenRefine is a free, open source power tool for working with messy data and improving it
There is a newer version: 3.9-beta1

package com.google.refine.expr.functions.strings;

import java.util.Arrays;
import java.util.Properties;

import com.google.refine.expr.EvalError;
import com.google.refine.grel.ControlFunctionRegistry;
import com.google.refine.grel.EvalErrorMessage;
import com.google.refine.grel.Function;
import com.google.refine.grel.FunctionDescription;
import com.google.refine.util.StringUtils;

public class ReplaceEach implements Function {

    /**
     * Replace each occurrence of a substring in a string with another substring.
     * 
     * @param bindings
     *            bindings
     * @param args
     *            arguments
     * @return result
     */
    @Override
    public Object call(Properties bindings, Object[] args) {
        if (args.length == 3) {
            if (args[0] instanceof String && args[1] instanceof Object[] && (args[2] instanceof Object[] || args[2] instanceof String)) {
                String[] searchArgs = new String[((Object[]) args[1]).length];
                Object[] originalSearchArgs = (Object[]) args[1];
                for (var i = 0; i < searchArgs.length; i++) {
                    searchArgs[i] = StringUtils.toString(originalSearchArgs[i]);
                }
                String[] search = searchArgs, replace;

                if (args[2] instanceof String) {
                    replace = new String[] { (String) args[2] };
                } else {
                    String[] replaceArgs = new String[((Object[]) args[2]).length];
                    Object[] originalReplaceArgs = (Object[]) args[2];
                    for (var i = 0; i < replaceArgs.length; i++) {
                        replaceArgs[i] = StringUtils.toString(originalReplaceArgs[i]);
                    }
                    replace = replaceArgs;
                }

                // Check that the search array is greater than or equal to the replace array in length
                if (search.length >= replace.length) {
                    // check that the replace array and search array are the same length
                    if (search.length != replace.length) {
                        // make multiple replacements of the last element in replace
                        String[] newReplace = new String[search.length];
                        Arrays.fill(newReplace, replace[replace.length - 1]);
                        replace = newReplace;
                    }

                    // replace each occurrence of search with corresponding element in replace
                    return org.apache.commons.lang3.StringUtils.replaceEachRepeatedly((String) args[0], search, replace);
                } else {
                    // replacements must be equal to or less than the number of search strings.");
                    return new EvalError(
                            EvalErrorMessage.str_replace_replacements_equal_to_searches(ControlFunctionRegistry.getFunctionName(this)));
                }
            }
        }
        // strings to replace, array of replacement strings");
        return new EvalError(
                EvalErrorMessage.str_replace_expects_one_string_two_arrays_string(ControlFunctionRegistry.getFunctionName(this)));
    }

    @Override
    public String getDescription() {
        return FunctionDescription.str_replace_each();
    }

    @Override
    public String getParams() {
        return "string, array of strings to replace, array of replacement strings";
    }

    @Override
    public String getReturns() {
        return "string";
    }
}