BrightSide Workbench Full Report + Source Code
org.turro.plugin.command.SummaryPlugin Class Referenceabstract
Inheritance diagram for org.turro.plugin.command.SummaryPlugin:
Collaboration diagram for org.turro.plugin.command.SummaryPlugin:

Public Member Functions

 SummaryPlugin (String name)
 
String getName ()
 
boolean stopPropagating ()
 
void execute ()
 
 SummaryPlugin (String name)
 
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 Collection< Object > getSummaryFor (IContact contact, String name)
 
static Collection< Object > getSummaryFor (Application app, IContact contact, String name)
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

Constructor & Destructor Documentation

◆ SummaryPlugin() [1/2]

org.turro.plugin.command.SummaryPlugin.SummaryPlugin ( String  name)

◆ SummaryPlugin() [2/2]

org.turro.plugin.command.SummaryPlugin.SummaryPlugin ( String  name)

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

38  {
39  this.name = name;
40  }

Member Function Documentation

◆ addToResult()

void org.turro.plugin.command.SummaryPlugin.addToResult ( Object  data)
protected

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

74  {
75  if(result == null) {
76  result = new ArrayList<Object>();
77  }
78  result.add(data);
79  }

◆ execute() [1/2]

void org.turro.plugin.command.SummaryPlugin.execute ( )

Reimplemented from org.turro.action.DefaultPlugin.

Definition at line 53 of file elephant/src/main/java/org/turro/plugin/command/SummaryPlugin.java.

Here is the call graph for this function:

◆ execute() [2/2]

Object org.turro.plugin.command.SummaryPlugin.execute ( Context  context)

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

60  {
61 // if(getName().equals(context.get(CommandFactory.COMMAND_PARS))) {
62 // setParams(context.get(CommandFactory.DATA));
63 // result = (Collection<Object>) context.get(CommandFactory.RESULT);
64 // executePlugin(context);
65 // context.put(CommandFactory.RESULT, result);
66 // if(stopsPropagating()) {
67 // return PROCESSING_COMPLETE;
68 // }
69 // }
70 // return CONTINUE_PROCESSING;
71  return null;
72  };

◆ executePlugin() [1/2]

◆ executePlugin() [2/2]

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

◆ getName() [1/2]

String org.turro.plugin.command.SummaryPlugin.getName ( )

Reimplemented from org.turro.action.DefaultPlugin.

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

43  {
44  return name;
45  }

◆ getName() [2/2]

String org.turro.plugin.command.SummaryPlugin.getName ( )

Reimplemented from org.turro.action.DefaultPlugin.

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

43  {
44  return name;
45  }

◆ getSummaryFor() [1/2]

static Collection<Object> org.turro.plugin.command.SummaryPlugin.getSummaryFor ( Application  app,
IContact  contact,
String  name 
)
static

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

83  {
84  return null; //(Collection<Object>) CommandFactory.executePlugins(app, contact, name);
85  }

◆ getSummaryFor() [2/2]

static Collection<Object> org.turro.plugin.command.SummaryPlugin.getSummaryFor ( IContact  contact,
String  name 
)
static

Definition at line 60 of file elephant/src/main/java/org/turro/plugin/command/SummaryPlugin.java.

60  {
61  Map<String, Object> args = new HashMap<>();
62  args.put("contact", contact);
63  args = Plugins.execute(name, args);
64  return args.values();
65  }
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setParams()

void org.turro.plugin.command.SummaryPlugin.setParams ( Object  params)

Implements org.turro.plugin.command.IPlugin.

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

53  {
54  if(params instanceof IContact) {
55  contact = (IContact) params;
56  }
57  }
Map< String, Object > params

◆ stopPropagating()

boolean org.turro.plugin.command.SummaryPlugin.stopPropagating ( )

Reimplemented from org.turro.action.DefaultPlugin.

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

48  {
49  return false;
50  }

◆ stopsPropagating()

boolean org.turro.plugin.command.SummaryPlugin.stopsPropagating ( )

Implements org.turro.plugin.command.IPlugin.

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

48  {
49  return false;
50  }

Member Data Documentation

◆ contact

IContact org.turro.plugin.command.SummaryPlugin.contact
protected

◆ name

String org.turro.plugin.command.SummaryPlugin.name
protected

◆ result

Collection< Object > org.turro.plugin.command.SummaryPlugin.result
protected

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