org.imixs.workflow.plugins
Class AbstractPlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

Direct Known Subclasses:

AbstractPlugin, AccessPlugin, ApplicationPlugin, BusinessRulePlugin, HistoryPlugin, LogPlugin, LucenePlugin, OwnerPlugin, ResultPlugin, RulePlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements org.imixs.workflow.Plugin

This abstract class implements different helper methods used by subclasses

Version:

1.1

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

org.imixs.workflow.WorkflowContext

ctx

Fields inherited from interface org.imixs.workflow.Plugin

PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

Constructor Summary

AbstractPlugin()

Method Summary

java.lang.String	formatItemValues(java.util.Collection aItem, java.lang.String aSeparator, java.lang.String sFormat) this method formats a string object depending of an attribute type.
void	init(org.imixs.workflow.WorkflowContext actx)
void	mergeMappedFieldValues(org.imixs.workflow.ItemCollection documentContext, java.util.List p_VectorDestination, java.util.List<java.lang.String> p_VectorFieldList) this method merges the values of p_VectorFieldList into p_VectorDestination and test for duplicates
void	mergeVectors(java.util.List p_VectorDestination, java.util.List p_VectorSource) This method merges the values from p_VectorSource into vectorDest and removes duplicates
java.lang.String	replaceDynamicValues(java.lang.String aString, org.imixs.workflow.ItemCollection documentContext) this method parses a string for xml tag .
java.util.List	uniqueList(java.util.List p_Vector) this method removes duplicate and null values from a vector object The method is called by the run method after build new read and write access elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.imixs.workflow.Plugin

close, run

Field Detail

ctx

public org.imixs.workflow.WorkflowContext ctx

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

init

public void init(org.imixs.workflow.WorkflowContext actx)
          throws org.imixs.workflow.exceptions.PluginException

Specified by:

init in interface org.imixs.workflow.Plugin

Throws:

org.imixs.workflow.exceptions.PluginException

replaceDynamicValues

public java.lang.String replaceDynamicValues(java.lang.String aString,
                                             org.imixs.workflow.ItemCollection documentContext)

this method parses a string for xml tag . Those tags will be replaced with the corresponding item value. hello namCreator Item values can also be formated. e.g. for date/time values Last access Time= $created If the itemValue is a multiValue object the single values can be spearated by a separator Phone List: txtPhones

formatItemValues

public java.lang.String formatItemValues(java.util.Collection aItem,
                                         java.lang.String aSeparator,
                                         java.lang.String sFormat)

this method formats a string object depending of an attribute type. MultiValues will be separated by the provided separator

mergeVectors

public void mergeVectors(java.util.List p_VectorDestination,
                         java.util.List p_VectorSource)

This method merges the values from p_VectorSource into vectorDest and removes duplicates

Parameters:

p_VectorDestination -

p_VectorSource -

mergeMappedFieldValues

public void mergeMappedFieldValues(org.imixs.workflow.ItemCollection documentContext,
                                   java.util.List p_VectorDestination,
                                   java.util.List<java.lang.String> p_VectorFieldList)

this method merges the values of p_VectorFieldList into p_VectorDestination and test for duplicates

Parameters:

p_VectorDestination -

p_VectorFieldList -

uniqueList

public java.util.List uniqueList(java.util.List p_Vector)

this method removes duplicate and null values from a vector object The method is called by the run method after build new read and write access elements.

Parameters:

p_Vector -