buildframework/helium/sf/java/antdata/src/com/nokia/helium/ant/data/taskdefs/DatabaseTask.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
 * All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
 * Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
 * Description: 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.helium.ant.data.taskdefs;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.io.File;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import java.io.FileWriter;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import java.io.IOException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import java.util.ArrayList;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import java.util.List;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.tools.ant.BuildException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
import org.apache.tools.ant.DirectoryScanner;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
import org.apache.tools.ant.Project;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
import org.apache.tools.ant.Task;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
import org.apache.tools.ant.types.FileSet;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
import org.apache.tools.ant.types.ResourceCollection;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    32
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
import com.nokia.helium.ant.data.Database;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
/**
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    36
 * Reads the current Ant project and/or Ant files and generates a XML file with a summary
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    37
 * of targets, macros and properties.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
 * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    39
 * @ant.task name="database" category="Database"
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
public class DatabaseTask extends Task {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    42
    private static final String DEFAULT_SCOPE = "public";
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    43
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
    private File outputFile;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    45
    private String scope = DEFAULT_SCOPE;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    private boolean filesetonly;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
    private List<ResourceCollection> rcs = new ArrayList<ResourceCollection>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
    public DatabaseTask() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
        setTaskName("database");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * Add a set of files to copy.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
     * @param set a set of files to copy.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    public void addFileset(FileSet set) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
        add(set);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
     * Add a collection of files to copy.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
     * @param res a resource collection to copy.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
     * @since Ant 1.7
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
    public void add(ResourceCollection res) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
        rcs.add(res);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
    public void setOutput(File outputFile) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
        this.outputFile = outputFile;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
    }
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    75
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    76
    public void setFilesetOnly(boolean filesetonly) {
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    77
        this.filesetonly = filesetonly;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
    /**
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    81
     * Defines what level of visibility to display Ant objects at. Default value is "public".
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
     * @param scope The visibility level, either public, protected or private.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
    public void setScope(String scope) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
        this.scope = scope;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
    public void execute() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
        if (outputFile == null) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
            throw new BuildException("'output' must be defined.");
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
        log("Building Ant project database", Project.MSG_DEBUG);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
        // Get additional Ant file paths
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
            List<String> antFilePaths = new ArrayList<String>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
            // Only filesets are supported currently
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
            for (ResourceCollection rc : rcs) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
                if (rc instanceof FileSet) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
                    FileSet fs = (FileSet) rc;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
                    DirectoryScanner ds = fs.getDirectoryScanner(getProject());
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
                    String[] srcFiles = ds.getIncludedFiles();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
                    String basedir = ds.getBasedir().getPath();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
                    for (int i = 0; i < srcFiles.length; i++) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
                        String fileName = basedir + File.separator + srcFiles[i];
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
                        antFilePaths.add(fileName);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
                    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
                }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
            // Output the database file
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
            Database db;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   114
            if (filesetonly) {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
                db = new Database(null);
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   116
            }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   117
            else {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
                db = new Database(getProject());
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
   119
            }
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
            db.setScopeFilter(scope);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
            db.addAntFilePaths(antFilePaths);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
            FileWriter out = new FileWriter(outputFile);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
            db.toXML(out);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
            out.close();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
        catch (IOException e) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
            e.printStackTrace();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
            throw new BuildException("Not able to build the ANT project Database " + e.getMessage());
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
}