com.ibm.mashups.livetext
Interface LivetextBatchModel

public LivetextBatchModel

This is the tag processor API. When a match tag is found by the livetext service according to the configuration, the service will hand the all DOM nodes to the tag processor which matches the criteria. Each tag processor must implement this interface. Each processor must also provide a non-parameter constructor in addition to the processTag method. The non-parameter constructor is to ensure that the livetext service can create an instance of the implementation class without providing any more information.

Method Summary

void	processTag(DOMNode[] nodes, ConfigEntry configEntry) The entry point of a tag processor.
void	unprocessTag(DOMNode[] nodes) The entry point of a tag processor (unchanging).

Method Detail

processTag

void processTag(DOMNode[] nodes,
                ConfigEntry configEntry)

The entry point of a tag processor. When a tag is found, the service will dynamically load the module which was designed to process that type of tags, then create an instance of that tag module class if it has not been created, then call this method and hand the control to the tag module.

Parameters:

nodes - The livetext DOM nodes to be processed. Must not be null.

configEntry - The configuration enrty for the handler. This will be required in case we have one hanlder for multiple matching criteria null.

unprocessTag

void unprocessTag(DOMNode[] nodes)

The entry point of a tag processor (unchanging). When a tag is found, the service will dynamically load the module which was designed to process that type of tags, then create an instance of that tag module class if it has not been created, then call this method and hand the control to the tag module.

Parameters:

nodes - The livetext DOM node to be "unprocessed". Must not be null.