Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2020 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.expressionevaluator.impl.function.dataaccess;

import org.apache.commons.lang3.Range;

import org.gvsig.expressionevaluator.Interpreter;

import org.gvsig.expressionevaluator.impl.DALFunctions;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.feature.Feature;

/**

 *

 * @author jjdelcerro

 */

public class SetRowTagFunction extends AbstractFeatureFunction {

  public SetRowTagFunction() {

    super(  DALFunctions.GROUP_DATA_ACCESS,

            DataManager.FUNCTION_SET_ROW_TAG,

            Range.is(1),

            "Assign a value associated with a label of the current row. " + 

              "This value is not persistent. The function return the " +

              "value assigned to the tag.\n" +

              "If the function is used outer a table filter it will have no any effect.",

            DataManager.FUNCTION_SET_ROW_TAG+"({{name}}, value)",

            null,

            "Object",

            false

    );

  }

  @Override

  public boolean allowConstantFolding() {

    return false;

  }

  @Override

  public boolean useArgumentsInsteadObjects() {

    return false;

  }

  @Override

  public Object call(Interpreter interpreter, Object[] args) throws Exception {

    Feature f = this.current_row(interpreter);

    if( f!=null ) {

      String name = getStr(args,0);

      f.setExtraValue(name, args[0]);

    }

    return args[0];

  }

}