1 package org.synchronoss.cpo.core.parser;
2
3 /*-
4 * [[
5 * core
6 * ==
7 * Copyright (C) 2003 - 2026 Exaxis LLC, Synchronoss Technologies Inc
8 * ==
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ]]
23 */
24
25 import java.text.ParseException;
26 import java.util.List;
27
28 /**
29 * {@code ExpressionParser} extracts bind-marker information from a native (SQL/CQL) function
30 * expression, letting CPO figure out which bean attribute each positional bind marker in the
31 * expression corresponds to.
32 *
33 * @author Michael Bellomo
34 */
35 public interface ExpressionParser {
36
37 /**
38 * Returns the expression used by this parser
39 *
40 * @return The expression
41 */
42 String getExpression();
43
44 /**
45 * Sets the expression to be used for this parser
46 *
47 * @param expression The expression
48 */
49 void setExpression(String expression);
50
51 /**
52 * Returns the count of the bind markers in the expression
53 *
54 * @return the number of bind markers
55 */
56 int countArguments();
57
58 /**
59 * Returns a list of columns from the expression for each bind marker
60 *
61 * @return List of Strings for the columns for the bind markers
62 * @throws ParseException thrown if the expression cannot be parsed
63 */
64 List<String> parse() throws ParseException;
65 }