com.progressiveaccess.cmlspeech.base.Cli.java Source code

Introduction

Here is the source code for com.progressiveaccess.cmlspeech.base.Cli.java

Source

// Copyright 2015 Volker Sorge
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @file   Cli.java
 * @author Volker Sorge
 *         <a href="mailto:V.Sorge@progressiveaccess.com">Volker Sorge</a>
 * @date   Sat Feb 14 12:06:05 2015
 *
 * @brief  Command line interface.
 *
 *
 */

//

package com.progressiveaccess.cmlspeech.base;

import org.apache.commons.cli.BasicParser;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

/**
 * Command line interface for enricher app.
 */
public final class Cli {

    private static CommandLine cl;
    private static List<String> files = new ArrayList<String>();

    /** Dummy constructor. */
    private Cli() {
        throw new AssertionError("Instantiating utility class...");
    }

    /**
     * Initialises the command line interpreter.
     *
     * @param args
     *          The command line argument list.
     */
    public static void init(final String[] args) {
        Cli.parse(args);
    }

    /**
     * Parses the command line arguments.
     *
     * @param args
     *          The command line argument list.
     */
    private static void parse(final String[] args) {
        final Options options = new Options();
        // Basic Options
        options.addOption("help", false, "Print this message");
        options.addOption("d", "debug", false, "Debug mode");
        options.addOption("v", "verbose", false, "Verbose mode");
        // File Handling
        // options.addOption("i", "input", true, "Input File");
        options.addOption("o", "output", true, "Output file addition");
        options.addOption("l", "log", true, "Log File");
        options.addOption("x", "error", true, "Debug File");
        // Processing Options
        options.addOption("c", "cml", false, "Also write a CML file without annotations: adds -simple to name");
        options.addOption("a", "ann", false, "Include annotations in CML output");
        options.addOption("ao", "annonly", false, "Annotations only output. Omits the original CML output");
        options.addOption("r", "descr", false, "Include speech descriptions in CML output");
        options.addOption("nonih", "nonih", false, "Do not use the NIH naming service");
        options.addOption("s", "subrings", false, "Do not compute subrings");
        options.addOption("sssr", "sssr", false, "Do not use SSSR method for sub-ring computation");
        options.addOption("vis", "visualize", false, "Visualize the abstraction graph");
        options.addOption("vr", "vis_recursive", false, "Visualize sub graphs recursively");
        options.addOption("vb", "vis_bw", false, "Visualize graph black and white; default colour");
        options.addOption("vs", "vis_short", false, "Visualize bonds short");
        options.addOption("sf", "structuralformula", false, "Print the structural formula");
        options.addOption("sub", "subscript", false, "Use subscripts with structural formula");
        options.addOption("m", "molcom", true, "Comparison heuristics for molecules given as a comma"
                + "separated list. Currently available heuristics:" + " type, weight, size");

        final CommandLineParser parser = new BasicParser();
        try {
            Cli.cl = parser.parse(options, args);
        } catch (final ParseException e) {
            usage(options, 1);
        }
        if (Cli.cl.hasOption("help")) {
            usage(options, 0);
        }

        for (int i = 0; i < Cli.cl.getArgList().size(); i++) {
            final String fileName = Cli.cl.getArgList().get(i).toString();
            final File file = new File(fileName);
            if (file.exists() && !file.isDirectory()) {
                Cli.files.add(fileName);
            } else {
                Cli.warning(fileName);
            }
        }

    }

    /**
     * Prints the usage information.
     *
     * @param options
     *          The options of the cli.
     * @param exitValue
     *          The exit value.
     */
    private static void usage(final Options options, final int exitValue) {

        final HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp("enrich.sh", options);
        System.exit(exitValue);
    }

    /**
     * Prints warnings for missing file names.
     *
     * @param fileName
     *          The filename.
     */
    private static void warning(final String fileName) {
        System.err.println("Warning: File " + fileName + " does not exist. Ignored!");
    }

    /**
     * Checks if the command line has a particular option.
     *
     * @param option
     *          The option in question.
     *
     * @return True if the option is available.
     */
    public static boolean hasOption(final String option) {
        return Cli.cl.hasOption(option);
    }

    /**
     * Retrieves the value for a particular option.
     *
     * @param option
     *          The option in question.
     *
     * @return The value of that option.
     */
    public static String getOptionValue(final String option) {
        return Cli.cl.getOptionValue(option);
    }

    /**
     * @return The file list given on the command line.
     */
    public static List<String> getFiles() {
        return Cli.files;
    }

}