/**
 * AnalyzerBeans
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.eobjects.analyzer.cli;

import java.io.PrintWriter;
import java.util.Map;

import org.kohsuke.args4j.CmdLineException;
import org.kohsuke.args4j.CmdLineParser;
import org.kohsuke.args4j.Option;

/**
 * Defines the Command-line arguments. These are populated by the CLI parser.
 */
public class CliArguments {

    private static final String[] USAGE_TOKENS = new String[] { "-usage", "--usage", "-help", "--help", "-?" };

    /**
     * Parses the CLI arguments and creates a CliArguments instance
     * 
     * @param args
     *            the arguments as a string array
     * @return
     * @throws CmdLineException
     */
    public static CliArguments parse(String[] args) {
        CliArguments arguments = new CliArguments();
        if (args != null) {
            CmdLineParser parser = new CmdLineParser(arguments);
            try {
                parser.parseArgument(args);
            } catch (CmdLineException e) {
                // ignore
            }

            arguments.usageMode = false;
            for (String arg : args) {
                for (int i = 0; i < USAGE_TOKENS.length; i++) {
                    String usageToken = USAGE_TOKENS[i];
                    if (usageToken.equalsIgnoreCase(arg)) {
                        arguments.usageMode = true;
                        break;
                    }
                }
            }
        }
        return arguments;
    }

    /**
     * Prints the usage information for the CLI
     * 
     * @param out
     */
    public static void printUsage(PrintWriter out) {
        CliArguments arguments = new CliArguments();
        CmdLineParser parser = new CmdLineParser(arguments);
        parser.setUsageWidth(120);
        parser.printUsage(out, null);
    }

    @Option(name = "-conf", aliases = { "-configuration", "--configuration-file" }, metaVar = "PATH", usage = "Path to an XML file describing the configuration of AnalyzerBeans")
    private String configurationFile;

    @Option(name = "-job", aliases = { "--job-file" }, metaVar = "PATH", usage = "Path to an analysis job XML file to execute")
    private String jobFile;

    @Option(name = "-list", usage = "Used to print a list of various elements available in the configuration")
    private CliListType listType;

    @Option(name = "-ds", aliases = { "-datastore", "--datastore-name" }, usage = "Name of datastore when printing a list of schemas, tables or columns")
    private String datastoreName;

    @Option(name = "-s", aliases = { "-schema", "--schema-name" }, usage = "Name of schema when printing a list of tables or columns")
    private String schemaName;

    @Option(name = "-t", aliases = { "-table", "--table-name" }, usage = "Name of table when printing a list of columns")
    private String tableName;

    @Option(name = "-ot", aliases = { "--output-type" }, usage = "How to represent the result of the job")
    private CliOutputType outputType;

    @Option(name = "-of", aliases = { "--output-file" }, metaVar = "PATH", usage = "Path to file in which to save the result of the job", required = false)
    private String outputFile;

    @Option(name = "-v", aliases = { "-var", "--variable" }, multiValued = true)
    private Map<String, String> variableOverrides;

    private boolean usageMode;

    private CliArguments() {
        // instantiation only allowed by factory (parse(...)) method.
    }

    public String getConfigurationFile() {
        return configurationFile;
    }

    public String getJobFile() {
        return jobFile;
    }

    public CliListType getListType() {
        return listType;
    }

    public String getDatastoreName() {
        return datastoreName;
    }

    public String getSchemaName() {
        return schemaName;
    }

    public String getTableName() {
        return tableName;
    }

    public boolean isUsageMode() {
        return usageMode;
    }

    public Map<String, String> getVariableOverrides() {
        return variableOverrides;
    }

    public String getOutputFile() {
        return outputFile;
    }

    public CliOutputType getOutputType() {
        if (outputType == null) {
            return CliOutputType.TEXT;
        }
        return outputType;
    }

    /**
     * Gets whether the arguments have been sufficiently set to execute a CLI
     * task.
     * 
     * @return true if the CLI arguments have been sufficiently set.
     */
    public boolean isSet() {
        if (isUsageMode()) {
            return true;
        }
        if (getJobFile() != null) {
            return true;
        }
        if (getListType() != null) {
            return true;
        }
        return false;
    }
}