UpgradeProcess.java |
1 /** 2 * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved. 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a copy 5 * of this software and associated documentation files (the "Software"), to deal 6 * in the Software without restriction, including without limitation the rights 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 * copies of the Software, and to permit persons to whom the Software is 9 * furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included in 12 * all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20 * SOFTWARE. 21 */ 22 23 package com.liferay.portal.upgrade; 24 25 import com.liferay.portal.tools.sql.DBUtil; 26 27 import java.io.IOException; 28 29 import java.sql.SQLException; 30 31 /** 32 * <a href="UpgradeProcess.java.html"><b><i>View Source</i></b></a> 33 * 34 * @author Brian Wing Shun Chan 35 * @author Alexander Chow 36 * 37 */ 38 public abstract class UpgradeProcess { 39 40 public UpgradeProcess() { 41 } 42 43 public int getThreshold() { 44 45 // This upgrade process will only run if the build number is larger than 46 // the returned threshold value. Return 0 to always run this upgrade 47 // process. 48 49 return 0; 50 } 51 52 public void runSQL(String template) throws IOException, SQLException { 53 DBUtil.getInstance().runSQL(template); 54 } 55 56 public void runSQL(String[] templates) 57 throws IOException, SQLException { 58 59 DBUtil.getInstance().runSQL(templates); 60 } 61 62 public void runSQLTemplate(String path) throws IOException, SQLException { 63 DBUtil.getInstance().runSQLTemplate(path); 64 } 65 66 public void runSQLTemplate(String path, boolean failOnError) 67 throws IOException, SQLException { 68 69 DBUtil.getInstance().runSQLTemplate(path, failOnError); 70 } 71 72 public abstract void upgrade() throws UpgradeException; 73 74 public void upgrade(UpgradeProcess upgradeProgress) 75 throws UpgradeException { 76 77 upgradeProgress.upgrade(); 78 } 79 80 }