elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.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.TreeSet;
import org.turro.command.Command;
import org.turro.command.Context;
import org.turro.elephant.context.Application;
import org.turro.plugin.contacts.IContact;
 
public abstract class TimelinePlugin implements IPlugin, Command {
 
  protected IContact contact;
  protected Collection<TimelineEvent> result;
  
  @Override
  public String getName() {
    return "Timeline";
  }
 
  @Override
  public boolean stopsPropagating() {
    return false;
  }
 
  @Override
  public void setParams(Object params) {
    if(params instanceof IContact) {
      contact = (IContact) params;
    }
  }
 
  @Override
  public Object execute(Context context) {
//    if(getName().equals(context.get(CommandFactory.COMMAND_PARS))) {
//      setParams(context.get(CommandFactory.DATA));
//      result = (Collection<TimelineEvent>) context.get(CommandFactory.RESULT);
//      executePlugin(context);
//      context.put(CommandFactory.RESULT, result);
//      if(stopsPropagating()) {
//        return PROCESSING_COMPLETE;
//      }
//    }
//    return CONTINUE_PROCESSING;
    return null;
  };
  
  protected void addToResult(Object data) {
    if(result == null) {
      result = new TreeSet<TimelineEvent>();
    }
    if(data instanceof TimelineEvent) {
      result.add((TimelineEvent) data);
    }
  }
 
  protected abstract void executePlugin(Context context) throws Exception;
  
  public static String getTimelineFor(Application app, IContact contact) {
//    Collection<TimelineEvent> list = (Collection<TimelineEvent>) CommandFactory
//            .executePlugins(app, contact, "Timeline");
//    if(list != null) {
//      return generateXML(app, list);
//    }
    return null;
  }
  
  public static String generateXML(Application app, Collection<TimelineEvent> result) {
    StringBuilder sb = new StringBuilder("<data>\n");
    for(TimelineEvent tle : result) {
      sb.append(tle.getEvent(app));
    }
    sb.append("\n</data>");
    return sb.toString();
  }
  
}