com.unitesk.atp.tree.tool
Class Plugin

java.lang.Object
  com.unitesk.atp.tool.PluginClass
      com.unitesk.atp.tree.tool.Plugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

Action, Attribute

public abstract class Plugin
extends PluginClass

Plug-in is a tool functionality extention module.

Version:

$Id: Plugin.java,v 1.1 2004/10/09 06:40:12 all-x Exp $

Author:

Alexey Demakov

Field Summary

protected PluginManager	pm
protected Tree	tree

Fields inherited from class com.unitesk.atp.tool.PluginClass

mbox, name

Constructor Summary

Plugin()

Method Summary

Object	get(String name, Node node) Computes an attribute with the specified name of the specified node of the same tree.
Tree	getCurrentTree()
void	init(PluginManager pm, String name) Links this plugin to the specified plugin manager. Must be called before plugin usage.
void	process(String name) Performs an action with the specified name over the same tree.
void	setCurrentTree(Tree tree)

Methods inherited from class com.unitesk.atp.tool.PluginClass

getName, getPlugin, getPluginManager, getProperty, getProperty, getPropertyName, getRevision

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.unitesk.atp.tool.Plugin

getKind, getVersion

Field Detail

tree

protected Tree tree

pm

protected PluginManager pm

Constructor Detail

Plugin

public Plugin()

Method Detail

setCurrentTree

public void setCurrentTree(Tree tree)

getCurrentTree

public Tree getCurrentTree()

process

public final void process(String name)

Performs an action with the specified name over the same tree. Calls pm.process( name, tree )

Parameters:

name - The name of an action.

get

public final Object get(String name,
                        Node node)

Computes an attribute with the specified name of the specified node of the same tree. Calls tool.get( name, tree, node )

Parameters:

name - The name of attribute.

node - The tree node.

Returns:

The value of node attribute name.

init

public void init(PluginManager pm,
                 String name)

Links this plugin to the specified plugin manager. Must be called before plugin usage.

Specified by:

init in interface Plugin

Overrides:

init in class PluginClass

Parameters:

pm - The plugin manager to link plugin to.

name - The name of plugin.