1 /*
2 * Zemucan: A Syntax Assistant for DB2
3 * Copyright (C) 2009, 2010 Andres Gomez Casanova
4 *
5 * This file is part of Zemucan.
6 *
7 * Zemucan is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * Zemucan is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Contact:
21 * a n g o c a at y a h o o dot c o m
22 * Cra. 45 No 61 - 31, Bogota, Colombia.
23 *
24 * Author: $LastChangedBy: angoca $:
25 * Date: $LastChangedDate: 2011-03-06 10:15:32 -0500 (dom, 06 mar 2011) $:
26 * Revision: $LastChangedRevision: 1913 $:
27 * URL: $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/interfaze/src/main/java/name/angoca/zemucan/interfaze/InterfaceCore.java $:
28 */
29 package name.angoca.zemucan.interfaze;
30
31 import name.angoca.zemucan.AbstractZemucanException;
32 import name.angoca.zemucan.ParameterNullException;
33 import name.angoca.zemucan.core.lexical.impl.ImplementationLexicalAnalyzer;
34 import name.angoca.zemucan.interfaze.model.ReturnOptions;
35
36 /**
37 * This class is the interface with other upper layers. This is the only class
38 * that the other layers have to use.
39 * <p>
40 * <b>Control Version</b>
41 * <p>
42 * <ul>
43 * <li>0.0.1 Class creation.</li>
44 * <li>0.0.2</li>
45 * <li>0.1.0 Organized.</li>
46 * <li>0.1.1 Executer as a singleton.</li>
47 * <li>0.2.0 Execution state.</li>
48 * <li>0.2.1 Enum.</li>
49 * <li>1.0.0 Moved to version 1.</li>
50 * <li>1.0.1 Validate parameters.</li>
51 * <li>1.0.2 Fix a problem when raising exception.</li>
52 * <li>1.0.3 Executer modified.</li>
53 * <li>1.0.4 Strings externalized.</li>
54 * <li>1.0.5 Assert.</li>
55 * <li>1.1.0 Execute method deleted.</li>
56 * <li>1.2.0 Initialize.</li>
57 * <li>1.2.1 Method renamed.</li>
58 * </ul>
59 *
60 * @author Andres Gomez Casanova <a
61 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
62 * @version 1.2.1 2010-04-18
63 * @since 1.0
64 */
65 public final class InterfaceCore {
66
67 /**
68 * Process the phrase written by the user and prints its result.
69 *
70 * @param phrase
71 * Phrase to analyze.
72 * @return An object that represents the command completed or the options
73 * for the current command.
74 * @throws AbstractZemucanException
75 * There is a problem in the application.
76 */
77 public static ReturnOptions/* ! */analyzePhrase(final String/* ! */phrase)
78 throws AbstractZemucanException {
79 if (phrase == null) {
80 throw new ParameterNullException("phrase"); //$NON-NLS-1$
81 }
82 final ReturnOptions ret = ImplementationLexicalAnalyzer.getInstance()
83 .analyzePhrase(phrase);
84
85 assert ret != null;
86 return ret;
87 }
88
89 /**
90 * Loads the grammar in memory, in order to release the control to the user.
91 * <p>
92 * This method should be called as soon as possible when using the
93 * application, because it loads the grammar before the user asks for help.
94 * This method also permits to detect grammar loading error before the user
95 * asks for help. It is also recommended to call this method in another
96 * thread to release the control to the user rapidly.
97 *
98 * @throws AbstractZemucanException
99 * If there is a problem initializing the graph.
100 */
101 public static void initializeGraph() throws AbstractZemucanException {
102 ImplementationLexicalAnalyzer.getInstance();
103 }
104
105 /**
106 * Hidden default constructor.
107 */
108 private InterfaceCore() {
109 // Nothing to do. No tests.
110 }
111 }