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/syntax/AbstractSyntacticalAnalyzer.java $:
28 */
29 package name.angoca.db2sa.core.syntax;
30
31 import java.util.List;
32
33 import name.angoca.db2sa.core.lexical.Token;
34 import name.angoca.db2sa.core.syntax.graph.exception.InvalidGraphException;
35
36 /**
37 * This object has methods to scan the structure and to find the possibilities
38 * of next tokens, that provide the possible ways that the user can take when
39 * writing a command.<br/>
40 * A phrase is a set of words that can or can't have a meaning for DB2.<br/>
41 * <b>Control Version</b><br />
42 * <ul>
43 * <li>0.0.1 Class creation.</li>
44 * <li>0.1.0</li>
45 * <li>1.0.0 Moved to version 1.</li>
46 * </ul>
47 *
48 * @author Andres Gomez Casanova <a
49 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
50 * @version 1.0.0 2009-07-19
51 */
52 public abstract class AbstractSyntacticalAnalyzer {
53
54 /**
55 * Returns the possible options that a given phrase can have. When no option
56 * is found, the returned array is empty (not null).
57 *
58 * @param phrase
59 * Phrase to analyze. This is an ensemble of tokens that are
60 * sorted in the same way that words were written by the user.
61 * @return The possible answers: the command completed or the options.
62 * @throws InvalidGraphException
63 * When the graph has an invalid structure.
64 */
65 public abstract GraphAnswer/* <!>! */getOptions(
66 final List<Token>/* <!>! */phrase) throws InvalidGraphException;
67 }