phat.codeproc.ExampleReportGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phat-generator Show documentation
SociAALML to PHAT generator
The newest version!
/*
 *  Copyright (C) 2002 Jorge Gomez Sanz
 *  This file is part of INGENIAS IDE, a support tool for the INGENIAS
 *  methodology, availabe at http://grasia.fdi.ucm.es/ingenias or
 *  http://ingenias.sourceforge.net
 *  INGENIAS IDE 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 2 of the License, or
 *  (at your option) any later version.
 *  INGENIAS IDE 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 INGENIAS IDE; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package phat.codeproc;

import ingenias.editor.ProjectProperty;
import ingenias.exception.NullEntity;
import ingenias.generator.browser.*;
import java.util.*;
        
/**
 *
 * @author pablo
 */
public class ExampleReportGenerator extends ingenias.editor.extension.BasicToolImp {
	
	/**
	 *  Initialises the class with a file contianing a INGENIAS specification
	 *
	 *@param  file           Path to file containing INGENIAS specification
	 *@exception  Exception  Error accessing any file or malformed XML exception
	 */
	
	public ExampleReportGenerator(String file) throws Exception {
		super(file);
	}
	
	/**
	 *  Initialises the class giving access to diagrams in run-time
	 **/
	
	public ExampleReportGenerator(Browser browser) throws Exception {
		super(browser);
	}
	
	@Override
	public String getVersion() {
		return "@modexample.ver@";
	}
	
	
	/**
	 *  Gets the description of this module
	 *
	 *@return    The description
	 */
	public String getDescription() {
		return "This module generates an stats report using the standard output. " +
		"The report indicates what entities exist in each diagram";
	}
	
	
	/**
	 *  Gets the name of this module
	 *
	 *@return    The name
	 */
	public String getName() {
		return "Example stats report";
	}
	
	
	/**
	 *  It creates stats of usage by traversing diagrams of your specification.
	 *  Resulting report appears in standard output or in the IDE
	 */
	public void run() {
		try {
			StringBuffer sb = this.generateReport();
			ingenias.editor.Log.getInstance().log("Statistics of usage of meta-model entities and relationships");
			ingenias.editor.Log.getInstance().log("Name                                    Number of times it appears");
			ingenias.editor.Log.getInstance().log("----                                    --------------------------");
			ingenias.editor.Log.getInstance().log(sb.toString());
		}
		catch (Exception ex) {
			ex.printStackTrace();
		}
	}
	
	
	/**
	 *  This module defines no properties
	 *
	 *@return    Empty properties
	 */
	public Vector defaultProperties() {
		Vector result=new Vector();
		
		return result;
	}
	
	
	/**
	 *  Generates the main report body
	 *
	 *@return                A stringbuffer with the report
	 *@exception  Exception  Sth. went wrong
	 */
	private StringBuffer generateReport() throws Exception {
		Graph[] gs = browser.getGraphs();
		StringBuffer result = new StringBuffer();
		Hashtable stats=new Hashtable();
		for (int k = 0; k < gs.length; k++) {
			Graph g = gs[k];
			this.generateADiagramReport(stats,g);
		}
		Object[] keys=new Vector(stats.keySet()).toArray();
		Arrays.sort(keys);
		StringBuffer report=new StringBuffer();
		for (int k=0;k