| ConvertProcess.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 *
5 *
6 *
7 * The contents of this file are subject to the terms of the Liferay Enterprise
8 * Subscription License ("License"). You may not use this file except in
9 * compliance with the License. You can obtain a copy of the License by
10 * contacting Liferay, Inc. See the License for the specific language governing
11 * permissions and limitations under the License, including but not limited to
12 * distribution rights 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.convert;
24
25 import com.liferay.portal.kernel.log.Log;
26 import com.liferay.portal.kernel.log.LogFactoryUtil;
27 import com.liferay.portal.util.MaintenanceUtil;
28
29 /**
30 * <a href="ConvertProcess.java.html"><b><i>View Source</i></b></a>
31 *
32 * @author Alexander Chow
33 */
34 public abstract class ConvertProcess {
35
36 public void convert() throws ConvertException {
37 try {
38 if (getPath() != null) {
39 return;
40 }
41
42 _log.info("Converting");
43
44 doConvert();
45
46 _log.info("Conversion complete");
47 }
48 catch (Exception e) {
49 throw new ConvertException(e);
50 }
51 finally {
52 setParameterValues(null);
53
54 MaintenanceUtil.cancel();
55 }
56 }
57
58 public abstract String getDescription();
59
60 public String getParameterDescription() {
61 return null;
62 }
63
64 public String[] getParameterNames() {
65 return null;
66 }
67
68 public String[] getParameterValues() {
69 return _paramValues;
70 }
71
72 public String getPath() {
73 return null;
74 }
75
76 public abstract boolean isEnabled();
77
78 public void setParameterValues(String[] values) {
79 _paramValues = values;
80 }
81
82 protected abstract void doConvert() throws Exception;
83
84 private static Log _log = LogFactoryUtil.getLog(ConvertProcess.class);
85
86 private String[] _paramValues = null;
87
88 }