LogFile.java

Go to the documentation of this file.

package cedar.jetweb.job;

import java.io.*;
import java.util.Date;
import java.util.Vector;
import java.util.Enumeration;
//import java.util.zip.GZIPInputStream;

import java.text.ParseException;

import org.apache.commons.io.FileUtils;

import cedar.jetweb.*;
import cedar.jetweb.model.*;
import cedar.jetweb.model.plots.*;
import cedar.jetweb.model.paper.*;
import cedar.jetweb.job.PendingJob;
import cedar.jetweb.generator.Generator;

import cedar.jetweb.xml.JetWebPlotReader;
import cedar.jetweb.xml.JetWebPlotReaderFactory;

import cedar.jetweb.db.DBManager;
import cedar.jetweb.db.DBJobManager;

import cedar.jetweb.util.JetWebFile;

public class LogFile implements Storeable {
    
    public static final int RESERVED  = 5;
    public static final int UNDEFINED = -1;
    public static final int SUBMITTED = 0;
    public static final int RUN = 1;
    public static final int COMPLETED = 2;
    public static final int ERROR = 3;

    // Private data
    private JetWebFile logfile;

    private String xmlFile = "";

    // Unique ID of this logfile.
    private int logId=-1;

    // A runSeries object to contain all the parameters.
    private RunSeries runSeries;
    //private Vector<RunSeries> runSeries_;

    private double lumi=0.0;
    private Double crossSection_ = -1.0;
    private boolean weighted=false;

    private boolean valid = false;
    private Vector<PredictedPlot> mcPlots;

    private int status;
    private int rsId = -1;

    private static String SCHEME_PDFLIB="PDFLIB";

    public LogFile(RunSeries lp){
    runSeries = lp;
    rsId = runSeries.getId();

    }


    public LogFile(int id){
    logId = id;
    }

    public LogFile(String name)  throws JetWebException { 

    try {
        // Initialise File.

        this.logfile = new JetWebFile(name);
                
        status = LogFile.UNDEFINED;
        
        // Fill the runSeriesId, the status and logId.
        retrieve();
        
        if (rsId>=0 && status>0) {
        // This is a finished logfile which has already been
        // added to the DB.
        valid = true;
        status = LogFile.COMPLETED;
        System.out.println("LogFile: Name already used. "+name);
        return;
        }

    } catch (NullPointerException e){
        System.out.println("Caused by "+e.getCause());
        System.out.println(e.getMessage());
        System.out.println("WARNING: LogFile not properly initialised; JetWebConfig probably not initialised");
    }
    }

    public boolean retrieve() throws JetWebException {
    if (logId>=0) {
        DBJobManager.selectFromDB(this);
    } else {
        DBJobManager.selectFromDBbyName(this);
    }
    return true;
    }

    public boolean store() throws JetWebException {

    // First check this logfile isn't already stored.
    //checkStatus();
    DBJobManager.checkStatus(this);
    
    if (status==COMPLETED) {
        System.out.println
        ("LogFile: attempt to add a LogFile for which an entry exists."
         );
        System.out.println("DB not changed, LogFile rejected.");
        return false;

    } else if (status==RUN) {

        //System.out.println("LogFile: Making plots");


        //add the log file if it isn't already in the DB.

        addLogFile();
        
        // Make MC papers associated with this logfile by building
        // & reading XML.

        makePlots();
        
        if (!valid) {
        System.out.println("LogFile: Invalid plots. Nothing added to DB.");
        return false;
        }
        
        
        // Write the logfile, the parameters (or a link to them) and the
        // updated predicted_point to the DB.       
        return toDB();

    }else if(status==SUBMITTED){
        addLogFile();
        return true;
        //  }else if(status==RESERVED){

    }else{

        System.out.println("LogFile: attempt to add a LogFile with undefined/error status");
        System.out.println("DB not changed, LogFile rejected.");

        System.out.println("Logfile: status = " + status);
        return false;

    }
    }   

    public JetWebFile getFile(){ return logfile; }

    public void setFile(JetWebFile f){ logfile = f; }

    public int getId(){ return logId;}
    
    
    public int getStatus() { 
    return status;
    }

    public RunSeries getRunSeries() throws JetWebException { 

    if (rsId<0 && runSeries !=null) {

        rsId = runSeries.getId();
    } else if ( (runSeries==null && rsId>0) || 
         (runSeries!=null) && (runSeries.getId()!=rsId) &&
         rsId >= 0)  { 

        //runSeries = new RunSeries(rsId);
        runSeries = RunSeries.Maker(rsId);
    }
    return runSeries; 
    }


    public Generator getGenerator() throws JetWebException { 
    try {
        return getRunSeries().getGenerator();
    } catch (JetWebException jwe){
        return null;
    }
    }

    public void setRunSeriesId(int inew){ 
    rsId = inew;
    if (runSeries!=null){
        runSeries.setId(inew);
    }
    }

    public void setRunSeries(RunSeries newrs){ 
    runSeries = newrs;
    rsId = runSeries.getId();
    }

    public void setId(int i){ logId = i;}
    public void setStatus(int i) throws JetWebException {

    if (checkStatus(i)){
        status = i; 
        DBJobManager.updateStatus(this);
    } else {
        throw new JetWebException("Attempt to set invalid Status on logfile:"+i,"");
    }
    }

    public LogFile setStatusAsSubmitted(){
    try{
        setStatus(SUBMITTED);
    }catch(JetWebException err){
        System.out.println(err.getMessage());
    }
    return this;
    }

    private boolean checkStatus(int i){
    boolean ok = false;
    if (i==RESERVED  || 
        i==UNDEFINED || 
        i==SUBMITTED || 
        i==RUN       || 
        i==COMPLETED || 
        i==ERROR        ){
        ok = true;
    }
    return ok;
    }

    public void setGenerator(Generator gen) throws JetWebException { 
    getRunSeries().getGeneratorList().clear();
    getRunSeries().getGeneratorList().add(gen);}

    public LogFile setCrossSection(Double cs){
    crossSection_ = cs;
    return this;
    }

    public Double getCrossSection(){
    return crossSection_;
    }

    public void setLumi(double l){ lumi = l;}
    public double getLumi(){ return lumi;}

    // Methods

    //adds a new logfile row in the submitted state

    private void addLogFile()
    throws JetWebException{
       
    try{

        if(runSeries.getId()<0){
        rsId = DBManager.matchRunSeriesId(runSeries);
        runSeries.setId(rsId);
        }

        if(runSeries.getId()>0){
        //DBManager.addLumi(lumi, runSeries.getId());
        DBManager.addLumi(this);
        rsId = runSeries.getId();
        }else{
        runSeries.setLumi(lumi);
        DBManager.addRunSeries(runSeries);
        rsId = runSeries.getId();
        
        }

        DBJobManager.addLogfile(this);
    }catch(JetWebException err){
        System.out.println
        ("Logfile: This file not added - failed updating runSeries");
        valid = false;
        throw err;
    }
    return;
    }

    private synchronized boolean toDB() throws JetWebException {

    if (status!=LogFile.RUN) {return false;}

    setRunSeriesId(DBManager.matchRunSeriesId(getRunSeries()));

    int update=0;

    if (runSeries.getId()>0){
        // Add the plots from this logfile to those already in the DB.
        addPlots();
        // Add the lumi and update the timestamp.
        //DBManager.addLumi(lumi,runSeries.getId());

        //no need to add the lumi here because it was already done 
        //by the addLogFile method

        //DBManager.addLumi(this);
    } else {

        //No existing db record so add a row to the runSeries table.
        try {

        runSeries.setLumi(lumi);
        DBManager.addRunSeries(runSeries);
        } catch (JetWebException e){
        System.out.println("LogFile: This file not added.");
        valid = false;
        throw e;
        }
        update = 1;
    }
    
    // Now insert the points into the predicted_point table.
    //Enumeration<PredictedPlot> plots = mcPlots.elements();
    for (PredictedPlot plot : mcPlots){
        //while (plots.hasMoreElements()){
        //PredictedPlot plot = (PredictedPlot)plots.nextElement();
        //plot.setRunSeriesId(runSeries.getId());
        plot.setRunSeries(runSeries);
        // Only update plots which have data for this logfile.
        if (plot.hasData()){
        plot.toDB(update);
        }
    }
    
    // Finally add or update a row to the logfile table.
    setStatus(COMPLETED);
    DBJobManager.addLogfile(this); 
    return true;
    }


    public void doChecks() throws JetWebException {
    valid=true;

    RunSeries runSeries = getRunSeries();
    Generator gen = runSeries.getGenerator();

    // Check we have RunSeries and Generator. 
    if ( (runSeries==null) || (getGenerator()==null) ) { 
        System.out.println("LogFile: Null runseries or generator");
        valid=false;
        return;
    }
    
    // Check the consistency etc of the process name.
    //runSeries.checkMCProcessType();

    MCProcessType proc = runSeries.getMCProcessType();

    // Check the MCProcessType is one we know about.


    // Check we have RunSeries and Generator. 
    if ( (proc==null) ) { 
        System.out.println("LogFile: Null MCProcessType");
        valid=false;
        return;
    }


    if (proc.getId()<=0) {
        System.out.println("LogFile: Unknown ProcessType");
        valid=false;
        return;
    }


    // Remove any irrelevant parameters.
    runSeries.removeIrrelevantParameters();

    // Perform any generator specific consistency checks.
    valid = gen.checkParameters();
    return;
    }

    public String getStem(){

    return logfile.directory() + logfile.toString();
    }
    public String getXmlFileName() throws JetWebException {

    String path;

    if (!xmlFile.equals("")){
        if(xmlFile.endsWith(JetWebFile.XML)||
           xmlFile.endsWith(JetWebFile.XML + ".gz")){
        path = xmlFile;
        }else{
        path = xmlFile + JetWebFile.XML;
        }
    } else {
        path = logfile + logfile.XML;
    }
    //either .xml or .xml.gz SHOULD exist
    //JetWebFile test = new JetWebFile(xmlFile);
    JetWebFile test = new JetWebFile(path);

    if(!test.isXML() || !test.exists()){
        throw new JetWebException
        ("Logfile Error: Attempt to open XML file which does not exist"
         ,test + " in directory " + test.directory());
    }

    test.Zip();

        setXmlFile(path);

    return  test.fullPath();
    }
    public void setXmlFile(String path){
    xmlFile= path;
    logfile = new JetWebFile(path);
    }
    public boolean hasAidaFile(){
    boolean exists = false;
    String path = getStem();
    //.aida SHOULD exist
    JetWebFile test = new JetWebFile(path, JetWebFile.AIDA);
    if (!test.exists()){
        System.out.println
        ("Logfile: AIDA File does not exist :"+test.fullPath());
    } else {
        System.out.println
        ("LogFile: Found matching AIDA file");
        exists = true;
    }
    return  exists;
    }

    public boolean isArchived(){
    boolean archived = false;
    String path = getStem();

    JetWebFile test = new JetWebFile(path, JetWebFile.AIDA);

    if(test.exists()){
        if(test.isArchived()){
        archived = true;
        }
    }
    return archived;
    }



    public boolean isValid(){return valid;}
    public void setValid(boolean b){ valid = b;}

    /*
     * Instantiate MC plot objects from xml file.
     */
    private void makePlots() throws JetWebException {

    if (!valid) {
        System.out.println("Warning: attempt to make paper for invalid log "+logfile.getPath());
        return;
    }

    // mcPlots will be a Vector containing all plots which
    // are predicted by this LogFile.
    mcPlots = new Vector<PredictedPlot>();

    // first make a plot reader.
    String xfname = getStem()+".aida";

    try {
        if ( (new JetWebFile(xfname)).exists() ){
        System.out.println("LogFile: found file "+xfname);
        JetWebPlotReader reader = 
            JetWebPlotReaderFactory.getNewPlotReader(xfname);

        for (Paper paper : PaperBank.getPapers()){

            reader.setDirectory(paper.getDirName());

            for (DataPlot dplot : paper.getPlots()){

            RealPlot rplot = (RealPlot)dplot;

            PredictedPlot plot = new PredictedPlot(rplot,runSeries);

            //Only fill and write the plot if this 
            //logfile generated the correct process in the 
            //correct region of phase space

            if (runSeries.getMCProcessType().getId()==
                plot.getProcIdWanted() && 
                plot.getCutCollection().isWithin
                (getGenerator().getCutCollection())){
            
                // Read the xml file for the plot.
                try {
                reader.fillPlot(plot);
                
                // Now, various fixes to plots to account for bugs
                // and features in HZTOOL.
                if (weighted) {
                    // No more weighted runs.
                    plot.zero();
                } else {
                    // Set errors on zero points to upper limits.
                    if (plot.getYLabel().indexOf("pb")>0){
                    plot.fixZeroErrors(lumi/1000.);
                    } else { 
                    plot.fixZeroErrors(lumi);
                    }
                }
                // Remove points with known bug (run list
                // lookup table).
                //JobUtils.removeBadPoints(plot,this);
                
                // Add this plot to the MC plots Vector.
                mcPlots.add(plot);

                } catch (JetWebException e) {
                // not found this histogram. try the next.
                System.out.println("Not found");
                }
                        
            }
            }
        }
        
        }
    } catch (JetWebException je) {
        System.out.println("LogFile: no data for "+xfname);
        System.out.println(je);
        je.printStackTrace(System.out);
    }

    if (mcPlots.size()==0) {
        System.out.println("LogFile: no valid plots found");
        valid=false;
    }
    }




    // Add these plots to any matching ones in the DB.
    private void addPlots() throws JetWebException {

    // Add the plots for this logfile to those already associated with 
    // this row of runSeries.
        
    for (PredictedPlot mcPlot : mcPlots){
        
        // Get the plots associated with this runSeries table.
        // Create a DataPlot object from this record and the DataPlot.
        PredictedPlot plot2 = null;
        plot2 = new PredictedPlot(mcPlot.getCompPlot(),runSeries);
        System.out.println(mcPlot.getNumber()+","+plot2.getNumber());
        if (plot2.hasData()){
        mcPlot.add(plot2);
        }
    }
    }

 
    private void dumpStream(InputStream in) throws IOException {
    BufferedReader br = new BufferedReader(new InputStreamReader(in));
    String line;
    while ((line = br.readLine()) != null) {
    }
    }

    public String toString() {

    try {
        StringBuffer b = new StringBuffer("Logfile: "+logfile.getPath()+"\n");
        b.append("Generator:");b.append(getGenerator());b.append("\n");
        b.append("Luminosity:");b.append(getLumi());b.append("\n");
        
        b.append("Process:");
        b.append(getRunSeries().getMCProcessType().getMCProcessName());
        b.append("\n");

        if (isValid()){
        b.append("Logfile is valid, ");
        } else {
        b.append("Logfile is invalid, ");
        }
        String statusString = "UNDEFINED";
        if (status==RUN) { 
        statusString="RUN";
        } else if (status==COMPLETED){
        statusString="COMPLETED";       
        } else if (status==SUBMITTED){
        statusString="SUBMITTED";       
        }
        b.append("Status is "+statusString);

        
        return b.toString();

    } catch (Exception e){
        return e.getMessage();

    }

    
    }

    public void checkStatus() throws JetWebException {
    if (isValid() && status!=ERROR){
        //setStatus(RUN);
        status=RUN;
        DBJobManager.checkStatus(this);
    } else {
        setStatus(UNDEFINED);
    }
    }

}

Generated Wed Jan 17 09:14:27 GMT 2007