weka.core.expressionlanguage.common.MacroDeclarationsCompositor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mini-weka Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This version represents the developer version, the "bleeding edge" of development, you could say. New functionality gets added to this version.

The newest version!

/*
 *   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, see .
 */

/*
 *    MacroDeclarationsCompositor.java
 *    Copyright (C) 2015 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.core.expressionlanguage.common;

import weka.core.expressionlanguage.core.Macro;
import weka.core.expressionlanguage.core.MacroDeclarations;

/**
 * A helper class that allows to combine several macro declarations together.
 * 
 * It can be though of as layering several scopes over one another.
 * 
 * It will delegate the {@link #hasMacro(String)} and {@link #getMacro(String)}
 * methods to other macro declarations.
 * 
 * Each macro declaration combined is checked in sequential order.
 * 
 * No checks for conflicts are done. Thus shadowing is possible.
 * 
 * @author Benjamin Weber ( benweber at student dot ethz dot ch )
 * @version $Revision: 1000 $
 */
public class MacroDeclarationsCompositor implements MacroDeclarations {

  /** the declarations being combined */
  private final MacroDeclarations[] declarations;
  
  /**
   * Constructs a {@link MacroDeclarationsCompositor} containing the provided
   * declarations
   * 
   * The order of the declarations will determine the order of checking the
   * declarations for macros.
   * 
   * @param declarations the declarations being combined
   */
  public MacroDeclarationsCompositor(MacroDeclarations... declarations) {
    this.declarations = declarations;
  }

  /**
   * Whether the macro is contained in one of the combined declarations.
   * 
   * @param name name of the macro
   * @return whether the macro is contained in one of the combined declarations
   */
  @Override
  public boolean hasMacro(String name) {
    for (MacroDeclarations declaration : declarations)
      if (declaration.hasMacro(name))
        return true;
    return false;
  }

  /**
   * Tries to fetch a macro from one of the combined declarations.
   * 
   * The same invariant of {@link MacroDeclarations} applies here too.
   * 
   * @param name the name of the macro to be fetched
   * @return a macro
   */
  @Override
  public Macro getMacro(String name) {
    for (MacroDeclarations declaration : declarations)
      if (declaration.hasMacro(name))
        return declaration.getMacro(name);
    throw new RuntimeException("Macro '" + name + "' doesn't exist!");
  }

}