com.github.fracpete.wekavirtualenv.command.ListPackages Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-virtualenv Show documentation
Virtual environment managment for Weka.
The newest version!
/*
 *   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 .
 */

/*
 * ListPackages.java
 * Copyright (C) 2017-2018 University of Waikato, Hamilton, NZ
 */

package com.github.fracpete.wekavirtualenv.command;

import com.github.fracpete.simpleargparse4j.ArgumentParser;
import com.github.fracpete.simpleargparse4j.Namespace;
import com.github.fracpete.wekavirtualenv.env.Environment;

/**
 * Lists Weka packages: all, installed or available ones.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 */
public class ListPackages
  extends AbstractLaunchCommand {

  public final static String CLASSNAME = "weka.core.WekaPackageManager";

  /**
   * The name of the command (used on the commandline).
   *
   * @return		the name
   */
  @Override
  public String getName() {
    return "list_pkgs";
  }

  /**
   * Returns a short help string.
   *
   * @return		the help string
   */
  public String getHelp() {
    return "Lists Weka packages: all, installed or available ones.";
  }

  /**
   * Returns the parser to use for the arguments.
   *
   * @return		always null
   */
  @Override
  public ArgumentParser getParser() {
    ArgumentParser 	result;

    result = new ArgumentParser(getName());
    result.addOption("--type")
      .dest("type")
      .help("what type of packages to list: all|installed|available")
      .required(true);

    return result;
  }

  /**
   * Returns whether the command utilizes additional arguments that get passed on.
   *
   * @return		true if additional options
   */
  @Override
  public boolean supportsAdditionalArguments() {
    return false;
  }

  /**
   * Returns whether the action is available.
   *
   * @return		true if available
   */
  @Override
  public boolean isAvailable() {
    return Environment.hasClass(getEnv().weka, CLASSNAME, true);
  }

  /**
   * Executes the command.
   *
   * @param ns		the namespace of the parsed options, null if no options to parse
   * @param options	additional command-line options
   * @return		true if successful
   */
  protected boolean doExecute(Namespace ns, String[] options) {
    if (!isAvailable()) {
      addError("Package manager command-line tool is not available in Weka " + getEnv().version() + " (" + CLASSNAME + ")!");
      return false;
    }
    return launch(build(CLASSNAME, new String[]{"-list-packages", ns.getString("type")}));
  }
}