summary.AbstractSummary.java Source code

Introduction

Here is the source code for summary.AbstractSummary.java

Source

/*
 * ----- BEGIN LICENSE BLOCK -----
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The Original Code is PharmGen.
 *
 * The Initial Developer of the Original Code is PharmGKB (The Pharmacogenetics
 * and Pharmacogenetics Knowledge Base, supported by NIH U01GM61374). Portions
 * created by the Initial Developer are Copyright (C) 2013 the Initial Developer.
 * All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or the
 * GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in
 * which case the provisions of the GPL or the LGPL are applicable instead of
 * those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ----- END LICENSE BLOCK -----
 */

package summary;

import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.pharmgkb.Subject;

/**
 * Created by IntelliJ IDEA.
 * User: whaleyr
 * Date: Aug 25, 2010
 */
public abstract class AbstractSummary {

    public abstract String getSheetTitle();

    public abstract void addSubject(Subject subject);

    public abstract void writeToWorkbook(Workbook wb);

    /**
     * If the Sheet doesn't already exist in the Workbook, create it.  Otherwise this method
     * will delete the existing one and create a new one
     * @param wb an Excel workbook
     * @return a new, blank Sheet in the given Workbook
     */
    public Sheet getSheet(Workbook wb) {
        Sheet sheet;

        int sheetIdx = wb.getSheetIndex(getSheetTitle());
        if (sheetIdx >= 0) {
            wb.removeSheetAt(sheetIdx);
        }
        sheet = wb.createSheet(getSheetTitle());

        return sheet;
    }
}