1 /*
2 * db2sa: DB2 Syntax Assistant
3 * Copyright (C) Andres Gomez Casanova
4 *
5 * This file is part of db2sa.
6 *
7 * db2sa 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 * db2sa 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: 2009-04-12 13:54:19 +0200 (Sun, 12 Apr 2009) $:
26 * Revision: $LastChangedRevision: 44 $:
27 * URL: $HeadURL: https://db2sa.svn.sourceforge.net/svnroot/db2sa/branches/db2sa_beta/source-code/src/main/java/name/angoca/db2sa/core/lexical/AbstractLexicalAnalyzer.java $:
28 */
29 package name.angoca.db2sa.core.lexical;
30
31 import name.angoca.db2sa.core.ReturnOptions;
32 import name.angoca.db2sa.core.syntax.graph.exception.InvalidGraphException;
33
34 /**
35 * This objects makes the analyzes over the phrase that the user is writing, and
36 * decomposes it in several tokens, that describe words or symbols. Some of them
37 * can be between quotation marks.<br/>
38 * <b>Control Version</b><br />
39 * <ul>
40 * <li>0.0.1 Class creation.</li>
41 * <li>0.1.0</li>
42 * <li>0.2.0</li>
43 * <li>1.0.0 Moved to version 1.</li>
44 * </ul>
45 *
46 * @author Andres Gomez Casanova <a
47 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
48 * @version 1.0.0 2009-07-19
49 */
50 public abstract class AbstractLexicalAnalyzer {
51
52 /**
53 * Process a given phrase that represents a command and sends the options in
54 * the screen printer.
55 *
56 * @param phrase
57 * Phrase to process.
58 * @return Set of options for the current phrase and the phrase to print.
59 * @throws InvalidGraphException
60 * When the graph that represents the grammar is invalid.
61 */
62 public abstract ReturnOptions/* ! */processPhrase(final String/* ! */phrase)
63 throws InvalidGraphException;
64
65 }