elephant/src/main/java/org/turro/plugin/command/SummaryPlugin.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2012 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.plugin.command;
 
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.turro.action.DefaultPlugin;
import org.turro.action.Plugins;
import org.turro.plugin.contacts.IContact;
 
public abstract class SummaryPlugin extends DefaultPlugin {
 
  protected String name;
  protected IContact contact;
  protected Collection<Object> result;
 
  public SummaryPlugin(String name) {
    this.name = name;
  }
  
  @Override
  public String getName() {
    return name;
  }
 
  @Override
  public boolean stopPropagating() {
    return false;
  }
 
  @Override
  public void execute() {
    contact = (IContact) getParam("contact");
    executePlugin();
  }
  
  protected abstract void executePlugin();
  
  public static Collection<Object> getSummaryFor(IContact contact, String name) {
    Map<String, Object> args = new HashMap<>();
    args.put("contact", contact);
    args = Plugins.execute(name, args);
    return args.values();
  }
  
}