1   /**
2    * Copyright (c) 2000-2009 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.kernel.util.InstancePool;
26  import com.liferay.portal.tools.sql.DBUtil;
27  
28  import java.io.IOException;
29  
30  import java.sql.SQLException;
31  
32  import javax.naming.NamingException;
33  
34  /**
35   * <a href="UpgradeProcess.java.html"><b><i>View Source</i></b></a>
36   *
37   * @author Brian Wing Shun Chan
38   * @author Alexander Chow
39   *
40   */
41  public abstract class UpgradeProcess {
42  
43      public UpgradeProcess() {
44      }
45  
46      public int getThreshold() {
47  
48          // This upgrade process will only run if the build number is larger than
49          // the returned threshold value. Return 0 to always run this upgrade
50          // process.
51  
52          return 0;
53      }
54  
55      public boolean isSupportsAlterColumnName() {
56          return DBUtil.getInstance().isSupportsAlterColumnName();
57      }
58  
59      public boolean isSupportsAlterColumnType() {
60          return DBUtil.getInstance().isSupportsAlterColumnType();
61      }
62  
63      public boolean isSupportsStringCaseSensitiveQuery() {
64          return DBUtil.getInstance().isSupportsStringCaseSensitiveQuery();
65      }
66  
67      public boolean isSupportsUpdateWithInnerJoin() {
68          return DBUtil.getInstance().isSupportsUpdateWithInnerJoin();
69      }
70  
71      public void runSQL(String template)
72          throws IOException, NamingException, SQLException {
73  
74          DBUtil.getInstance().runSQL(template);
75      }
76  
77      public void runSQL(String[] templates)
78          throws IOException, NamingException, SQLException {
79  
80          DBUtil.getInstance().runSQL(templates);
81      }
82  
83      public void runSQLTemplate(String path)
84          throws IOException, NamingException, SQLException {
85  
86          DBUtil.getInstance().runSQLTemplate(path);
87      }
88  
89      public void runSQLTemplate(String path, boolean failOnError)
90          throws IOException, NamingException, SQLException {
91  
92          DBUtil.getInstance().runSQLTemplate(path, failOnError);
93      }
94  
95      public abstract void upgrade() throws UpgradeException;
96  
97      public void upgrade(Class<?> upgradeProcessClass)
98          throws UpgradeException {
99  
100         UpgradeProcess upgradeProcess = (UpgradeProcess)InstancePool.get(
101             upgradeProcessClass.getName());
102 
103         upgradeProcess.upgrade();
104     }
105 
106     public void upgrade(UpgradeProcess upgradeProcess)
107         throws UpgradeException {
108 
109         upgradeProcess.upgrade();
110     }
111 
112 }