1 /*
2 * Copyright (c) 2001-2004,
3 * RedVerst Group, ISP RAS http://www.ispras.ru
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice, this
10 * list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17 * may not be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 package com.unitesk.atp.tree.tool;
33
34 import com.unitesk.atp.tree.Node;
35 import com.unitesk.atp.tool.PluginClass;
36
37 /***
38 * Plug-in is a tool functionality extention module.
39 *
40 * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
41 * @version $Id: Plugin.java,v 1.1 2004/10/09 06:40:12 all-x Exp $
42 */
43 public abstract class Plugin extends PluginClass
44 {
45 protected Tree tree;
46 public void setCurrentTree( Tree tree ) { this.tree = tree; }
47 public Tree getCurrentTree() { return tree; }
48
49 /***
50 * Performs an action with the specified name over the same tree.
51 * Calls {@link PluginManager#process(String,Tree) pm.process( name, tree )}
52 *
53 * @param name The name of an action.
54 */
55 public final void process( String name )
56 {
57 ((PluginManager)pm).process( name, tree );
58 }
59
60 /***
61 * Computes an attribute with the specified name of the specified
62 * node of the same tree.
63 * Calls {@link Tool#get(String,Tree,Node) tool.get( name, tree, node )}
64 *
65 * @param name The name of attribute.
66 * @param node The tree node.
67 * @return The value of <code>node</code> attribute <code>name</code>.
68 */
69 public final Object get( String name, Node node )
70 {
71 return ((PluginManager)pm).get( name, tree, node );
72 }
73
74 /***
75 * {@inheritDoc}
76 */
77 public void init( com.unitesk.atp.tool.PluginManager pm, String name )
78 {
79 super.init( pm, name );
80
81 if( pm instanceof PluginManager )
82 {
83 this.pm = (PluginManager)pm;
84 }
85 }
86
87 protected PluginManager pm;
88 }