package ncube.grv.exp;
import com.cedarsoftware.ncube.NCube;
import com.cedarsoftware.ncube.NCubeManager;
import com.cedarsoftware.ncube.exception.RuleJump;
import com.cedarsoftware.ncube.exception.RuleStop;
import com.cedarsoftware.util.CaseInsensitiveMap;
import java.util.Map;
/**
* Base class for all GroovyExpression and GroovyMethod's within n-cube CommandCells.
* @see com.cedarsoftware.ncube.GroovyBase
*
* @author John DeRegnaucourt (jdereg@gmail.com)
* <br/>
* Copyright (c) Cedar Software LLC
* <br/><br/>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <br/><br/>
* http://www.apache.org/licenses/LICENSE-2.0
* <br/><br/>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
public class NCubeGroovyExpression
{
protected Map input;
protected Map output;
protected NCube ncube;
/**
* @param args a Map that contains the 'input' Map, 'output' Map, 'ncube',
* and the 'stack.'
*/
public void init(Map args)
{
input = (Map) args.get("input");
output = (Map) args.get("output");
ncube = (NCube) args.get("ncube");
}
protected Map getInput() {
return input;
}
protected Map getOutput() {
return output;
}
protected NCube getNCube() {
return ncube;
}
public Object getFixedCell(Map coord)
{
return ncube.getCell(coord, output);
}
public Object getFixedCubeCell(String name, Map coord)
{
NCube cube = NCubeManager.getCube(name, ncube.getVersion());
if (cube == null)
{
throw new IllegalArgumentException("NCube '" + name + "' not loaded into NCubeManager, attempting fixed ($) reference to cell: " + coord.toString());
}
return cube.getCell(coord, output);
}
public Object getRelativeCell(Map coord)
{
input.putAll(coord);
return ncube.getCell(input, output);
}
public Object getRelativeCubeCell(String name, Map coord)
{
input.putAll(coord);
NCube cube = NCubeManager.getCube(name, ncube.getVersion());
if (cube == null)
{
throw new IllegalArgumentException("NCube '" + name + "' not loaded into NCubeManager, attempting relative (@) reference to cell: " + coord.toString());
}
return cube.getCell(input, output);
}
/**
* Restart rule execution. Must be executed within an n-cube with at least one rule axis.
*/
public void jump()
{
jump(new CaseInsensitiveMap<>());
}
/**
* Restart rule execution. The Map contains the names of rule axes to rule names. For any rule axis
* specified in the map, the rule step counter will be moved (jumped) to the named rule. More than one
* rule axis step counter can be moved by including multiple entries in the map.
* @param coord Map of rule axis names, to rule names. If the map is empty, it is the same as calling
* jump() with no args.
*/
public void jump(Map coord)
{
input.putAll(coord);
throw new RuleJump(input);
}
/**
* Run another rule cube
* @param name String name of the other rule cube
* @param coord Map input coordinate
* @return is the return Map from the other rule cube
*/
public Object runRuleCube(String name, Map coord)
{
input.putAll(coord);
NCube cube = NCubeManager.getCube(name, ncube.getVersion());
if (cube == null)
{
throw new IllegalArgumentException("NCube '" + name + "' not loaded into NCubeManager, attempting runRuleCube() to cell: " + coord.toString());
}
return cube.getCells(input, output);
}
public void ruleStop()
{
throw new RuleStop();
}
}