org.datacleaner.beans.script.JavaScriptTransformer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DataCleaner-javascript
There is a newer version: 6.0.0
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Free Software Foundation, Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.beans.script;

import javax.inject.Named;

import org.datacleaner.api.Alias;
import org.datacleaner.api.Categorized;
import org.datacleaner.api.Configured;
import org.datacleaner.api.Description;
import org.datacleaner.api.Initialize;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.InputRow;
import org.datacleaner.api.OutputColumns;
import org.datacleaner.api.StringProperty;
import org.datacleaner.api.Transformer;
import org.datacleaner.components.categories.ScriptingCategory;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.ContextFactory;
import org.mozilla.javascript.Script;
import org.mozilla.javascript.Scriptable;
import org.mozilla.javascript.ScriptableObject;

/**
 * A transformer that uses userwritten JavaScript to generate a value
 */
@Named("JavaScript transformer (simple)")
@Alias("JavaScript transformer")
@Description("Supply your own piece of JavaScript to do a custom transformation")
@Categorized(ScriptingCategory.class)
public class JavaScriptTransformer implements Transformer {

    public enum ReturnType {
        STRING, NUMBER, BOOLEAN
    }

    @Configured
    InputColumn[] columns;

    @Configured
    ReturnType returnType = ReturnType.STRING;

    @Configured
    @Description(
            "Available variables:\nvalues[0..]: Array of values\nvalues[\"my_col\"]: Map of values\nmy_col: "
                    + "Each column value has it's own variable\nout: Print to console using out.println('hello')\n"
                    + "log: Print to log using log.info(...), log.warn(...), log.error(...)")
    @StringProperty(multiline = true, mimeType = { "text/javascript", "application/x-javascript" })
    String sourceCode = "function eval() {\n\treturn \"hello \" + values[0];\n}\n\neval();";

    private ContextFactory _contextFactory;
    private Script _script;

    // this scope is shared between all threads
    private ScriptableObject _sharedScope;

    @Override
    public OutputColumns getOutputColumns() {
        final OutputColumns outputColumns = new OutputColumns(Object.class, "JavaScript output");
        if (returnType == ReturnType.NUMBER) {
            outputColumns.setColumnType(0, Number.class);
        } else if (returnType == ReturnType.BOOLEAN) {
            outputColumns.setColumnType(0, Boolean.class);
        } else {
            outputColumns.setColumnType(0, String.class);
        }
        return outputColumns;
    }

    @Initialize
    public void init() {
        _contextFactory = new ContextFactory();
        final Context context = _contextFactory.enterContext();

        try {
            _script = context.compileString(sourceCode, this.getClass().getSimpleName(), 1, null);
            _sharedScope = context.initStandardObjects();

            JavaScriptUtils.addToScope(_sharedScope, new JavaScriptLogger(), "logger", "log");
            JavaScriptUtils.addToScope(_sharedScope, System.out, "out");
        } finally {
            Context.exit();
        }
    }

    @Override
    public Object[] transform(final InputRow inputRow) {
        final Context context = _contextFactory.enterContext();

        try {

            // this scope is local to the execution of a single row
            final Scriptable scope = context.newObject(_sharedScope);
            scope.setPrototype(_sharedScope);
            scope.setParentScope(null);

            JavaScriptUtils.addToScope(scope, inputRow, columns, "values");

            Object result = _script.exec(context, scope);
            // String stringResult = Context.toString(result);

            if (result == null) {
                result = null;
            } else if (returnType == ReturnType.NUMBER) {
                result = Context.toNumber(result);
            } else if (returnType == ReturnType.BOOLEAN) {
                result = Context.toBoolean(result);
            } else {
                result = Context.toString(result);
            }
            return new Object[] { result };
        } finally {
            Context.exit();
        }
    }

    public void setSourceCode(final String sourceCode) {
        this.sourceCode = sourceCode;
    }

    public void setColumns(final InputColumn[] columns) {
        this.columns = columns;
    }
}