PluginInfo.java

/*
 * Copyright (C) 2012 Dr. John Lindsay <jlindsay@uoguelph.ca>
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package whiteboxgis;

import java.util.Date;

/**
 *
 * @author Dr. John Lindsay email: jlindsay@uoguelph.ca
 */
public class PluginInfo implements Comparable<PluginInfo> {
    private String name = null;
    private String descriptiveName = null;
    private String description;
    private String[] toolboxes = null;
    private int numTimesUsed = 0;
    private Date lastUsed = new Date(Long.MIN_VALUE);
    private byte sortMode = 0;
    private boolean script = false;
    private String scriptFile;
    
    public static final byte SORT_MODE_USAGE = 0;
    public static final byte SORT_MODE_RECENT = 1;
    public static final byte SORT_MODE_NAMES = 2;
    
    public PluginInfo(String name, byte sortMode) {
        this.name = name;
        this.sortMode = sortMode;
    }
    
    public PluginInfo(String name, String descriptiveName, String description, String[] toolboxes, byte sortMode) {
        this.name = name;
        this.descriptiveName = descriptiveName;
        this.description = description;
        this.sortMode = sortMode;
        this.toolboxes = toolboxes;
    }
    
    public String getName() {
        return name;
    }
    
    public String getDescriptiveName() {
        return descriptiveName;
    }
    
    public void setDescriptiveName(String descriptiveName) {
        this.descriptiveName = descriptiveName;
    }
    
    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
    
    public int getNumTimesUsed() {
        return numTimesUsed;
    }
    
    public void setNumTimesUsed(int numTimesUsed) {
        this.numTimesUsed = numTimesUsed;
    }
    
    public void incrementNumTimesUsed() {
        numTimesUsed++;
    }
    
    public Date getLastUsed() {
        return lastUsed;
    }
    
    public void setLastUsed(Date lastUsed) {
        this.lastUsed = lastUsed;
    }
    
    public void setLastUsedToNow() {
        lastUsed = new Date();
    }
    
    public byte getSortMode() {
        return sortMode;
    }
    
    public void setSortMode(byte sortMode) {
        this.sortMode = sortMode;
    }
    
    public void setScript(boolean isScript) {
        this.script = isScript;
    }
    
    public boolean isScript() {
        return this.script;
    }
    
    public void setScriptFile(String file) {
        this.scriptFile = file;
    }
    
    public String getScriptFile() {
        return this.scriptFile;
    }
    
    public void setToolboxes(String[] toolboxes) {
        this.toolboxes = toolboxes;
    }
    
    public String[] getToolboxes() {
        return this.toolboxes;
    }
    
    @Override
    public int compareTo(PluginInfo other) {
        final int BEFORE = 1;
        final int EQUAL = 0;
        final int AFTER = -1;
        
        // make sure that you're comparing the two PluginInfos based on the same criterion.
        if (this.sortMode != other.getSortMode()) {
            other.setSortMode(this.sortMode);
        }
        
        if (this.sortMode == SORT_MODE_USAGE) {
            if (this.numTimesUsed < other.numTimesUsed) {
                return BEFORE;
            } else if (this.numTimesUsed > other.numTimesUsed) {
                return AFTER;
            }
            
        } else if (this.sortMode == SORT_MODE_RECENT) {
            if (this.lastUsed == null || other.lastUsed == null) {
                return 0;
            }
//            return this.lastUsed.compareTo(other.lastUsed);
            return other.lastUsed.compareTo(this.lastUsed);
        }
        
        // else compare them based on their names.
        String str1 = this.descriptiveName.toLowerCase();
        String str2 = other.descriptiveName.toLowerCase();
        
        if (str1.compareTo(str2) < 0) {
            return AFTER;
        } else if (str1.compareTo(str2) > 0) {
            return BEFORE;
        }

        return EQUAL;
    }
    
}