org.jfree.xml.generator.DescriptionGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jtstand-common Show documentation
jtstand-common is a library derived from jcommon, used by jtstand-chart, which is derived from jfreechart
There is a newer version: 1.5.9
/*
 * Copyright (c) 2009 Albert Kurucz. 
 *
 * This file, DescriptionGenerator.java is part of JTStand.
 *
 * JTStand is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JTStand 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 GTStand.  If not, see .
 */

package org.jfree.xml.generator;

import java.io.BufferedInputStream;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.Writer;
import java.net.URL;
import java.util.Iterator;
import java.util.Properties;

import org.jfree.util.Log;
import org.jfree.util.PrintStreamLogTarget;
import org.jfree.util.ObjectUtilities;
import org.jfree.xml.generator.model.DescriptionModel;

/**
 * A utility application for generating class descriptions.
 */
public final class DescriptionGenerator {

    /**
     * Loads a property set from the specified URL.
     * 
     * @param propertyURL  the URL.
     * 
     * @return The properties.
     */
    private static Properties loadProperties(final URL propertyURL) {
        final Properties p = new Properties();
        try {
            final InputStream in = new BufferedInputStream(propertyURL.openStream());
            p.load(in);
            in.close();
        }
        catch (Exception e) {
            System.err.println("Unable to load properties from " + propertyURL);
        }
        return p;
    }

    /**
     * Runs the generator, using the 'generator.properties' file for configuration info.
     * 
     * @param args  command line arguments.
     * 
     * @throws Exception if something goes wrong!
     */
//    public static void main(final String[] args) throws Exception {
//
//        Log.getInstance().addTarget(new PrintStreamLogTarget());
//        
//        URL propertyURL = ObjectUtilities.getResourceRelative
//                ("generator.properties", DescriptionGenerator.class);
//        if (args.length > 0) {
//            final File f = new File(args[0]);
//            propertyURL = f.toURL();
//        }
//        final Properties p = loadProperties(propertyURL);
//
//        final String handlerSource = p.getProperty("attributedefinition");
//        if (handlerSource != null) {
//            final Properties handlers = loadProperties(new URL(propertyURL, handlerSource));
//            ModelBuilder.getInstance().addAttributeHandlers(handlers);
//        }
//
//        final String source = p.getProperty("sourcedirectory", ".");
//        final String target = p.getProperty("targetfile", "model.xml");
//        DescriptionModel model = null;
//        try {
//            model = new DefaultModelReader().load(target);
//        }
//        catch (Exception e) {
//            Log.debug("Unable to load default model. Ignoring...");
//        }
////        Log.debug (model.getModelComments());
//        model = generate(source, p, model);
//        model.prune();
//        writeMultiFile(target, model);
//        System.exit(0);
//    }

    /**
     * Generates a {@link DescriptionModel} from the specified source.
     * 
     * @param source  the source directory.
     * @param configuration  the configuration properties.
     * @param model  the model (null permitted).
     * 
     * @return A class description model.
     */
    public static DescriptionModel generate(final String source,
                                            final Properties configuration,
                                            final DescriptionModel model) {
        
        final JavaSourceCollector jsc = new JavaSourceCollector(new File(source));

        final Iterator it = configuration.keySet().iterator();
        while (it.hasNext()) {
            final String pName = (String) it.next();
            if (pName.startsWith("ignore.baseclass.")) {
                jsc.addIgnoredBaseClass(configuration.getProperty(pName));
            }
            else if (pName.startsWith("ignore.package.")) {
                jsc.addIgnoredPackage(configuration.getProperty(pName));
            }
        }

        jsc.collectFiles();
        return ModelBuilder.getInstance().buildModel(jsc, model);
    }

    /**
     * Writes the class description model to a single file.
     * 
     * @param target  the target file name.
     * @param model  the class description model.
     * 
     * @throws IOException if there is an I/O problem.
     */
    public static void writeSingleFile(final String target, final DescriptionModel model) throws IOException {
        Log.debug ("Writing ...");
        final ModelWriter writer = new ModelWriter();
        writer.setModel(model);
        final Writer w = new BufferedWriter(new FileWriter(target));
        writer.write(w);
        w.close();
    }

    /**
     * Writes the class description model to multiple files.
     * 
     * @param target  the target file name.
     * @param model  the class description model.
     * 
     * @throws IOException if there is an I/O problem.
     */
    public static void writeMultiFile(final String target, final DescriptionModel model) throws IOException {
        Log.debug ("Writing multiple files ...");
        final SplittingModelWriter writer = new SplittingModelWriter();
        writer.setModel(model);
        writer.write(target);
    }
    
}