org.turro.plugin.command.TimelinePlugin Class Reference

Inheritance diagram for org.turro.plugin.command.TimelinePlugin:

Collaboration diagram for org.turro.plugin.command.TimelinePlugin:

Public Member Functions
String	getName ()
boolean	stopPropagating ()
void	execute ()
String	getName ()
boolean	stopsPropagating ()
void	setParams (Object params)
Object	execute (Context context)
Public Member Functions inherited from org.turro.action.DefaultPlugin
void	setContext (Map< String, Object > params, Map< String, Object > results)
Object	getParam (String key)
boolean	itsMe (String name)
Object	addResult (String key, Object value)

Static Public Member Functions
static String	getTimelineFor (IContact contact)
static String	generateXML (Collection result)
static String	getTimelineFor (Application app, IContact contact)
static String	generateXML (Application app, Collection< TimelineEvent > result)

Protected Member Functions
abstract void	executePlugin ()
void	addToResult (Object data)
abstract void	executePlugin (Context context) throws Exception

Protected Attributes
IContact	contact
Collection< TimelineEvent >	result
Protected Attributes inherited from org.turro.action.DefaultPlugin
Map< String, Object >	params
Map< String, Object >	results

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 32 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

Member Function Documentation

addToResult()

void org.turro.plugin.command.TimelinePlugin.addToResult ( Object  data )

protected

Definition at line 69 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                          {
    if(result == null) {
      result = new TreeSet<TimelineEvent>();
    }
    if(data instanceof TimelineEvent) {
      result.add((TimelineEvent) data);
    }
  }

execute() [1/2]

void org.turro.plugin.command.TimelinePlugin.execute

(

)

Reimplemented from org.turro.action.DefaultPlugin.

Definition at line 48 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                        {
    contact = (IContact) getParam("contact");
    executePlugin();
  }

Here is the call graph for this function:

execute() [2/2]

Object org.turro.plugin.command.TimelinePlugin.execute

(

Context

context

)

Definition at line 55 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                         {
//    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;
  };

executePlugin() [1/2]

abstract void org.turro.plugin.command.TimelinePlugin.executePlugin ( )

abstractprotected

Reimplemented in org.turro.dossier.command.IssueTimeline.

Here is the caller graph for this function:

executePlugin() [2/2]

abstract void org.turro.plugin.command.TimelinePlugin.executePlugin ( Context  context ) throws Exception

abstractprotected

generateXML() [1/2]

static String org.turro.plugin.command.TimelinePlugin.generateXML ( Application  app, Collection< TimelineEvent >  result  )

static

Definition at line 89 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                                                                      {
    StringBuilder sb = new StringBuilder("<data>\n");
    for(TimelineEvent tle : result) {
      sb.append(tle.getEvent(app));
    }
    sb.append("\n</data>");
    return sb.toString();
  }

generateXML() [2/2]

static String org.turro.plugin.command.TimelinePlugin.generateXML ( Collection  result )

static

Definition at line 62 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                                      {
    StringBuilder sb = new StringBuilder("<data>\n");
    for(TimelineEvent tle : (Collection<TimelineEvent>) result) {
      sb.append(tle.getEvent());
    }
    sb.append("\n</data>");
    return sb.toString();
  }

Here is the caller graph for this function:

getName() [1/2]

String org.turro.plugin.command.TimelinePlugin.getName

(

)

Reimplemented from org.turro.action.DefaultPlugin.

Definition at line 38 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                          {
    return "Timeline";
  }

getName() [2/2]

String org.turro.plugin.command.TimelinePlugin.getName

(

)

Reimplemented from org.turro.action.DefaultPlugin.

Definition at line 38 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                          {
    return "Timeline";
  }

getTimelineFor() [1/2]

static String org.turro.plugin.command.TimelinePlugin.getTimelineFor ( Application  app, IContact  contact  )

static

Definition at line 80 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                                                         {
//    Collection<TimelineEvent> list = (Collection<TimelineEvent>) CommandFactory
//            .executePlugins(app, contact, "Timeline");
//    if(list != null) {
//      return generateXML(app, list);
//    }
    return null;
  }

getTimelineFor() [2/2]

static String org.turro.plugin.command.TimelinePlugin.getTimelineFor ( IContact  contact )

static

Definition at line 55 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                                        {
    Map<String, Object> args = new HashMap<>();
    args.put("contact", contact);
    args = Plugins.execute("Timeline", args);
    return generateXML(args.values());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setParams()

void org.turro.plugin.command.TimelinePlugin.setParams

(

Object

params

)

Implements org.turro.plugin.command.IPlugin.

Definition at line 48 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                       {
    if(params instanceof IContact) {
      contact = (IContact) params;
    }
  }

stopPropagating()

boolean org.turro.plugin.command.TimelinePlugin.stopPropagating

(

)

Reimplemented from org.turro.action.DefaultPlugin.

Definition at line 43 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                   {
    return false;
  }

stopsPropagating()

boolean org.turro.plugin.command.TimelinePlugin.stopsPropagating

(

)

Implements org.turro.plugin.command.IPlugin.

Definition at line 43 of file elephant-plugins/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

                                    {
    return false;
  }

Member Data Documentation

contact

IContact org.turro.plugin.command.TimelinePlugin.contact

protected

Definition at line 34 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

result

Collection< TimelineEvent > org.turro.plugin.command.TimelinePlugin.result

protected

Definition at line 35 of file elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java.

---

The documentation for this class was generated from the following file:

• elephant/src/main/java/org/turro/plugin/command/TimelinePlugin.java