source: trunk/gli/src/org/greenstone/gatherer/cdm/PlugIn.java@ 4675

/**
 *#########################################################################
 *
 * A component of the Gatherer application, part of the Greenstone digital
 * library suite from the New Zealand Digital Library Project at the
 * University of Waikato, New Zealand.
 *
 * <BR><BR>
 *
 * Author: John Thompson, Greenstone Digital Library, University of Waikato
 *
 * <BR><BR>
 *
 * Copyright (C) 1999 New Zealand Digital Library Project
 *
 * <BR><BR>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * <BR><BR>
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * <BR><BR>
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *########################################################################
 */

 




package org.greenstone.gatherer.cdm;
/**
 * Title:        The Gatherer<br>
 * Description:  The Gatherer: a tool for gathering and enriching digital collections.<br>
 * Copyright:    Copyright (c) 2001<br>
 * Company:      The University of Waikato<br>
 * First Coded:  01/05/02
 * @author John Thompson, Greenstone Digital Libraries
 * @version 2.1
 */
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import org.greenstone.gatherer.cdm.Argument;
import org.greenstone.gatherer.cdm.ArgumentContainer;
/** This class is responsible for storing information from a parsed pluginfo call in such a way that it allows easy access to parsed details for the purposes of user design and specification of plugins. */
// ####################################################################################
// Optimization                          Saving
// ####################################################################################
// Vector -> ArrayList                   + Memory, + Processor (pos. - Processor)
// ####################################################################################
public class PlugIn 
    extends ArrayList 
    implements ArgumentContainer, Comparable, Serializable {
    /** A reference to the plugin that this one inherits from. */
    private PlugIn super_plugin = null;
    /** A string of custom arguments to pass to the plugin. */
    private String custom = null;
    /** A description of this plugin. */
    private String desc = null;
    /** The name of the plugin as it would appear in the collect.cfg file. */
    private String name = null;
    /** Default Constructor.
     */
    public PlugIn() {
    super();
    }
    /** Constructor.
      * @param name The name of this plugin as a <strong>String</strong>.
      * @param desc A description of this plugin as a <strong>String</strong>.
      * @param super_plugin The super class of this plugin, as a <strong>PlugIn</strong>.
      */
    public PlugIn(String name, String desc, PlugIn super_plugin) {
    super();
    this.desc = desc;
    this.name = name;
    this.super_plugin = super_plugin;
    }
    /** Method to add an argument to this plugin. Only adds the argument if it isn't already present. 
      * @param argument The <strong>Argument</strong> to add.
      */
    public void addArgument(Argument argument) {
    if(!contains(argument)) {
        add(argument);
        argument.setOwner(name);
    }
    }
    /** Method to compare two plugins for ordering.
      * @param object The plugin we are comparing to, as an <strong>Object</strong>.
      * @return An <i>int</i> specifying the plugin order, using values as set out in <strong>String</strong>.
      * @see java.lang.String#compareTo
      */
    public int compareTo(Object object) {
    if(object != null && object instanceof PlugIn) {
        PlugIn plugin = (PlugIn) object;
        return name.compareTo(plugin.getName());
    }
    return -1;
    }
    /** This method produces a deep copy of this plugin. Note that this also creates a new copy of each of the super classes of plugins as well. This is the way it should be, as each assigned plugin may have different values for the higher plugins (such as BasPlug).
      * @return A newly created <strong>PlugIn</strong> with the same details and <strong>Argument</strong>s as this one.
      */
    public PlugIn copy() {
    PlugIn copy = null;
    if(super_plugin == null) {
        copy = new PlugIn(name, desc, null);
    }
    else {
        copy = new PlugIn(name, desc, super_plugin.copy());
    }
    for(int i = 0; i < size(); i++) {
        copy.addArgument(((Argument)get(i)).copy());
    }
    return copy;
    }
    /** Method to determine if two plugins are equal.
      * @param object The plugin to test against, as an <strong>Object</strong>.
      * @return <i>true</i> if the plugin names match, <i>false</i> otherwise.
      */
    public boolean equals(Object object) {
    if(object != null && compareTo(object) == 0) {
        return true;
    }
    return false;
    }
    /** Method to retrieve an argument by its name.
      * @param name The name of the argument as a <strong>String</strong>.
      * @return The <strong>Argument</strong> requested, or <i>null</i> if no such argument.
      */
    public Argument getArgument(String name) {
    // The name given may still include the '-'
    if(name.startsWith("-")) {
        name = name.substring(1);
    }
    ArrayList arguments = getArguments();
    for(int i = 0; i < arguments.size(); i++) {
        Argument argument = (Argument)arguments.get(i);
        if(argument.getName().equals(name)) {
        return argument;
        }
    }
    return null;
    }
    /** Method to retrieve all of the arguments available to a plugin, including both specific and general ones.
      * @return A <strong>Hashtable</strong> of arguments, with <name> -> <argument> entries.
      */
    public ArrayList getArguments() {
    ArrayList all_arguments = new ArrayList(this);
    Collections.sort(all_arguments);
    if(super_plugin != null) {
        ArrayList super_arguments = super_plugin.getArguments();
        for(int i = 0; i < super_arguments.size(); i++) {
        Object argument = super_arguments.get(i);
        if(!all_arguments.contains(argument)) {
            all_arguments.add(argument);
        }
        }
    }
    return all_arguments;
    }
    /** Method to retrieve a plugins custom argument information.
      * @return The custom arguments as a <strong>String</strong>.
      */
    public String getCustom() {
    return custom;
    }
    /** Method to retrieve a plugins name.
      * @return A <strong>String</strong> containing the plugins name.
      */
    public String getName() {
    return name;
    }
    public void setCustom(String custom) {
    this.custom = custom;
    }
    /** Method to set the value of desc. 
      * @param desc The new value of desc as a <strong>String</strong>.
      */
    public void setDesc(String desc) {
    this.desc = desc;
    }
    /** Method to set the value of name. 
      * @param name The new value of name as a <strong>String</strong>.
      */
    public void setName(String name) {
    this.name = name;
    }
    /** Method to set the value of the super_plugin.
      * @param super_plugin The new value of super_plugin as a <strong>PlugIn</strong>, or <i>null</i> if this class has no inheritance. 
      */
    public void setSuper(PlugIn super_plugin) {
    this.super_plugin = super_plugin;
    }
    /** Method to print out this plugin as it would appear as a command within the collection configuration file.
      * @return A <strong>String</strong> containing a single plugin command.
      */
    public String toString() {
    String text = "plugin " + name + " ";
    ArrayList arguments = getArguments();
    for(int i = 0; i < arguments.size(); i++) {
        Argument argument = (Argument)arguments.get(i);
        if(argument.isAssigned()) {
        text = text + argument.toString();
        if(i < arguments.size() - 1) {
            text = text + " ";
        }
        }
    }
    // Now print custom arguments if any.
    if(custom != null) {
        text = text + " " + custom;
    } 
    return text;
    }         
}