opengrok/configuration/Project.java

	Project.java revision 830
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
package org.opensolaris.opengrok.configuration;

import java.io.File;

/**
 * Placeholder for the information that builds up a project
 */
public class Project {
    private String path;
    private String description;

    /**
     * Get a textual description of this project
     * @return a textual description of the project
     */
    public String getDescription() {
        return description;
    }

    /**
     * Get the path (relative from source root) where this project is located
     * @return the relative path
     */
    public String getPath() {
        return path;
    }

    /**
     * Get the project id
     * @return the id of the project
     */
    public String getId() {
        return path;
    }

    /**
     * Set a textual description of this project
     * @param description a textual description of the project
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Set the path (relative from source root) this project is located
     * @param path the relative path from source sroot where this project is
     *             located.
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * Get the project for a specific file
     * @param path the file to lookup (relative from source root)
     * @return the project that this file belongs to (or null if the file
     *         doesn't belong to a project)
     */
    public static Project getProject(String path) {
        Project ret = null;
        RuntimeEnvironment env = RuntimeEnvironment.getInstance();
        if (env.hasProjects()) {
            for (Project proj : env.getProjects()) {
                //TODO below is buggy, since on Windows the path separator is not "/", hence mast.jsp:192 will not show the searchbox
                if (path.indexOf(proj.getPath()) == 0) {
                    ret = proj;
                }
            }
        }
        return ret;
    }

    /**
     * Get the project for a specific file
     * @param file the file to lookup
     * @return the project that this file belongs to (or null if the file
     *         doesn't belong to a project)
     */
    public static Project getProject(File file) {
        Project ret = null;
        String root = RuntimeEnvironment.getInstance().getSourceRootFile().getAbsolutePath();
        String me = file.getAbsolutePath();
        if (me.startsWith(root)) {
            ret = getProject(me.substring(root.length()));
        }
        return ret;
    }
}