com.google.refine.expr.functions.Cross 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.8.7
/*

Copyright 2010, Google Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
    * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,           
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY           
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

package com.google.refine.expr.functions;

import java.util.Properties;

import com.google.refine.LookupCacheManager.ProjectLookup;
import com.google.refine.ProjectManager;
import com.google.refine.expr.EvalError;
import com.google.refine.expr.WrappedCell;
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.model.Project;
import com.google.refine.util.GetProjectIDException;
import com.google.refine.util.LookupException;

public class Cross implements Function {

    public static final String INDEX_COLUMN_NAME = "_OpenRefine_Index_Column_Name_";

    @Override
    public Object call(Properties bindings, Object[] args) {
        if (1 <= args.length && args.length <= 3) {
            // 1st argument can take either value or cell(for backward compatibility)
            Object v = args[0];
            // if 2nd argument is omitted or set to "", use the current project name
            Object targetProjectName = "";
            boolean isCurrentProject = false;
            if (args.length < 2 || "".equals(args[1])) {
                isCurrentProject = true;
            } else {
                targetProjectName = args[1];
            }
            // if 3rd argument is omitted or set to "", use the index column
            Object targetColumnName = args.length < 3 || "".equals(args[2]) ? INDEX_COLUMN_NAME : args[2];

            long targetProjectID;
            ProjectLookup lookup;

            if (v != null && targetProjectName instanceof String && targetColumnName instanceof String) {
                try {
                    targetProjectID = isCurrentProject ? ((Project) bindings.get("project")).id
                            : ProjectManager.singleton.getProjectID((String) targetProjectName);
                } catch (GetProjectIDException e) {
                    return new EvalError(e.getMessage());
                }

                try {
                    lookup = ProjectManager.singleton.getLookupCacheManager().getLookup(targetProjectID, (String) targetColumnName);
                } catch (LookupException e) {
                    return new EvalError(e.getMessage());
                }

                if (v instanceof WrappedCell) {
                    return lookup.getRows(((WrappedCell) v).cell.value);
                } else {
                    return lookup.getRows(v);
                }
            }
        }

        // name to look up (optional), and a column name in that project (optional)");
        return new EvalError(EvalErrorMessage.fun_cross_expects_value_project_column(ControlFunctionRegistry.getFunctionName(this)));
    }

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

    @Override
    public String getParams() {
        return "cell or value, string projectName (optional), string columnName (optional)";
    }

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