scp.cli.Generator.java Source code

Introduction

Here is the source code for scp.cli.Generator.java

Source

/**
 *     Copyright (C) 2008 Benjamin Clauss, Simon Stiefel 
 * 
 *     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 scp.cli;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.Random;
import javax.xml.bind.JAXBException;

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

import scp.common.Shape;
import scp.common.xml.XMLBridge;

/**
 * Command Line Generator for XML file with random sized shapes
 * @author Simon Stiefel
 *
 */
public class Generator {

    protected int maxDimension = 100;
    protected int numOfShapes = 100;
    protected List<Shape> shapeList = null;
    protected XMLBridge bridge = null;
    protected File outputFile = null;
    protected Options options = null;

    /**
     * @throws JAXBException
     */
    public Generator() throws JAXBException {
        this.shapeList = new ArrayList<Shape>();
        this.bridge = new XMLBridge();
    }

    /**
     * Configures Generator according to command line options
     * 
     * Allowed arguments are:
     * -m or --max = maximal dimension (height and width). Default: 100
     * -n or --num = amount of shapes to generate. Default: 100
     * -h or --help = show help
     * 
     * @param args command line options
     * @throws ParseException
     * @throws NoArgumentsException
     * @throws NoFileSpecifiedException
     */
    public void configure(String[] args) throws ParseException, NoArgumentsException, NoFileSpecifiedException {
        CommandLineParser clparser = new GnuParser();
        options = generateOptions();

        CommandLine commandLine = clparser.parse(options, args);

        if (commandLine.hasOption('h')) {
            throw new NoArgumentsException("");
        }

        // Check if file is specified
        if (commandLine.getArgList().size() < 1) {
            throw new NoFileSpecifiedException("Please specify an output file");
        }

        outputFile = new File((String) commandLine.getArgList().get(0));

        if (commandLine.hasOption('n')) {
            this.numOfShapes = new Integer(commandLine.getOptionValue('n'));
        }

        if (commandLine.hasOption('m')) {
            this.maxDimension = new Integer(commandLine.getOptionValue('m'));
        }
    }

    /**
     * Starts generation of random shapes
     */
    public void generate() {
        Random generator = new Random(Calendar.getInstance().get(Calendar.SECOND));

        for (int i = 0; i < numOfShapes; i++) {
            int height = generator.nextInt(maxDimension + 1);
            if (height == 0)
                height = 1;
            int width = generator.nextInt(maxDimension + 1);
            if (width == 0)
                width = 1;
            shapeList.add(new Shape(i, height, width));
        }
    }

    /**
     * Saves generated shapes to file (specified during configure())
     * 
     * @throws JAXBException
     * @throws FileNotFoundException
     */
    public void save() throws JAXBException, FileNotFoundException {
        bridge.setShapeList(shapeList);
        bridge.saveFile(outputFile);
    }

    /**
     * Generates options usable in configure()
     * 
     * @return generated Options
     */
    private Options generateOptions() {
        Options options = new Options();
        options.addOption("m", "max", true, "maximal dimension (height and width). Default: 100");
        options.addOption("n", "num", true, "amount of shapes to generate. Default: 100");
        options.addOption("h", "help", false, "show this help");

        return options;
    }

    /**
     * Entry point (main function) for command line generator
     * 
     * @param args command line arguments
     */
    public static void main(String args[]) {
        Generator clg = null;
        try {
            clg = new Generator();
            clg.configure(args);
        } catch (JAXBException e) {
            System.out.println("Error while parsing XML: " + e.getMessage());
            return;
        } catch (ParseException e) {
            System.out.println("Error while parsing arguments: " + e.getMessage());
            return;
        } catch (NoArgumentsException e) {
            HelpFormatter formatter = new HelpFormatter();
            formatter.printHelp("java -cp scp.jar scp.cli.Generator OUTPUTFILE [options]", clg.options);
            return;
        } catch (NoFileSpecifiedException e) {
            System.out.println(e.getMessage());
            return;
        }

        clg.generate();

        try {
            clg.save();
        } catch (FileNotFoundException e) {
            System.out.println("Error while saving file: " + e.getMessage());
            return;
        } catch (JAXBException e) {
            System.out.println("Error while generating XML: " + e.getMessage());
            return;
        }
    }
}