buildframework/helium/sf/java/metadata/src/com/nokia/helium/metadata/ant/taskdefs/MetaDataRecord.java
author wbernard
Thu, 22 Jul 2010 17:08:43 +0300
branchhelium-9.0
changeset 618 df88fead2976
parent 587 85df38eb4012
permissions -rw-r--r--
helium_9.0.5-4399343f4f50

/*
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of the License "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description:  
 *
 */

package com.nokia.helium.metadata.ant.taskdefs;

import com.nokia.helium.metadata.CustomMetaDataProvider;
import com.nokia.helium.metadata.MetaDataInput;
import com.nokia.helium.jpa.entity.metadata.Metadata;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import java.util.Vector;
import java.util.Iterator;
import org.apache.log4j.Logger;
import com.nokia.helium.metadata.db.*;
import java.util.Date;

/**
 * This task provide a way to record the data in the Database.
 * 
 * <pre>
 * Example 1:
 * &lt;metadatarecord database=&quot;compile_log.db&quot;&gt;
 *     &lt;sbsmetadatainput&gt;
 *     &lt;fileset casesensitive=&quot;false&quot; file=&quot;sbs.log.file&quot;/&gt
 *         &lt;metadatafiltelistref refid=&quot;compilation&quot;/&gt;
 *     &lt;/sbsmetadatainput&gt;
 * &lt;/metadatarecord&gt;
 * 
 * Example 2:
 * 
 * &lt;metadatarecord database=&quot;metadata.db&quot;&gt;
 *     &lt;antmetadatainput&gt;
 *     &lt;fileset casesensitive=&quot;false&quot; file=&quot;${build.id}_ant_build.log&quot;/&gt
 *         &lt;metadatafiltelistref refid=&quot;compilation&quot;/&gt;
 *     &lt;/antmetadatainput&gt;
 * &lt;/metadatarecord&gt;

 * </pre>
 * 
 * @ant.task name="metadatarecord" category="Metadata"
 */
public class MetaDataRecord extends Task {

    private static Logger log = Logger.getLogger(MetaDataRecord.class);

    private String database;
    
    private boolean failOnError = true;
    
    private Vector<MetaDataInput> metadataList = new Vector<MetaDataInput>();

    /**
     * Helper function to set the database parameter
     * 
     * @ant.required
     */
    public void setDatabase(String dbFile) {
        database = dbFile;
    }

    public void setFailOnError(String failNotify) {
        if (failNotify.equals("false")) {
            failOnError = false;
        }
    }
    /**
     * Helper function to get the database
     * 
     */
    public String getDatabase() {
        return database;
    }

    /**
     * Helper function to return the metadatalist
     *  @return build metadata object
     * 
     */
    public Vector<MetaDataInput> getMetaDataList() throws Exception {
        if (metadataList.isEmpty()) {
            throw new Exception("metadata list is empty");
        }
        return metadataList;
    }

    /**
     * Helper function to add the metadatalist
     *  @param build metadata list to add
     * 
     */
    public void add(MetaDataInput interf) {
        metadataList.add(interf);
    }

    
    @Override
    public void execute() {
        ORMMetadataDB ormDB = null;
        try {
            log.debug("Getting Contents to write to db: " + database);
            log.debug("Initializing DB: " + database);
            log.debug("initializing ORM db");
            ormDB = new ORMMetadataDB(database);
            log.debug("Parsing the input and writing to DB");
            Date before = new Date();
            log("Time before recording to db: " + before);
            for (MetaDataInput metadataInput : metadataList) {
                boolean removed = false;
                String logPath = null;
                String currentLogPath = null;
                Iterator<Metadata.LogEntry> inputIterator = metadataInput.iterator();
                while (inputIterator.hasNext()) {
                    //Todo: better way of log handling, with metadatainput
                    // metadata initialization for each logfile within 
                    //metadatainput itself would be better. this is temporary.
                    Metadata.LogEntry logEntry = inputIterator.next();
                    logPath = logEntry.getLogPath();
                    if (currentLogPath == null) {
                        currentLogPath = logPath;
                        removed = false;
                    } else if (!currentLogPath.equals(logPath)) {
                        finalizeForLogPath(currentLogPath, metadataInput, ormDB);
                        currentLogPath = logPath;
                        removed = false;
                    }
                    if (!removed ) {
                        log.debug("processing for log: " + logPath);
                        ormDB.removeEntries(logPath);
                        removed = true;
                    }
                    //initializes the metadata if none exists
                    ormDB.addLogEntry(logEntry);
                }
                finalizeForLogPath(currentLogPath, metadataInput, ormDB);
            }
            Date after = new Date();
            log("Time after recording to db: " + after);
            log("Elapsed time: " + (after.getTime() - before.getTime()) + " ms");
            log.debug("Successfully writen to DB");
        } catch (BuildException ex1) {
            log.debug("BuildException during writing to db: ", ex1);
            if (failOnError) {
                throw ex1;
            }
        } finally {
            if (ormDB != null) {
                ormDB.finalizeDB();
            }
        }
    }
    
    private void finalizeForLogPath(String currentLogPath, 
            MetaDataInput metadataInput, ORMMetadataDB ormDB) {
        if (currentLogPath != null) {
            if (metadataInput instanceof CustomMetaDataProvider) {
                CustomMetaDataProvider provider = 
                    (CustomMetaDataProvider)metadataInput;
                provider.provide(ormDB, currentLogPath);
            }
            ormDB.finalizeMetadata(currentLogPath);
        }
    }
}