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/grammarReaderApi/src/main/java/name/angoca/zemucan/grammarReader/api/InterfaceGrammarReaderController.java $:
28 */
29 package name.angoca.zemucan.grammarReader.api;
30
31 import name.angoca.zemucan.AbstractZemucanException;
32 import name.angoca.zemucan.core.graph.model.StartingNode;
33
34 /**
35 * This interface describes the methods of the grammar reader controller.
36 * <p>
37 * <b>Control Version</b>
38 * <p>
39 * <ul>
40 * <li>1.0.0 Class creation.</li>
41 * <li>1.3.0 Interface.</li>
42 * </ul>
43 *
44 * @author Andres Gomez Casanova <a
45 * href="mailto:a n g o c a at y a h o o dot c o m" >(AngocA)</a>
46 * @version 1.3.0 2010-05-04
47 * @since 1.0
48 */
49 public interface InterfaceGrammarReaderController {
50
51 /**
52 * Retrieves the globalDelimiters for the tokens.
53 *
54 * @return The globalDelimiters of the grammar.
55 * @throws AbstractInvalidGrammarException
56 * If the grammar is invalid.
57 */
58 public String/* ! */getDelimiters() throws AbstractInvalidGrammarException;
59
60 /**
61 * Retrieves the entry point of the graph.
62 *
63 * @return The StartingNode.
64 * @throws AbstractZemucanException
65 * If the grammar is invalid. If the graph is invalid. If there
66 * is a null parameter.
67 */
68 public StartingNode/* ! */getStartingNode() throws AbstractZemucanException;
69
70 }