01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.core.search;
34:
35: import com.flexive.shared.exceptions.FxSqlSearchException;
36: import com.flexive.sqlParser.Property;
37:
38: /**
39: * Helper to generate select statements on queries
40: *
41: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
42: * @version $Rev: 256 $
43: */
44: public interface FieldSelector {
45:
46: /**
47: * This function applies the select logic on the statement.
48: * <p/>
49: * The statement parameter holds a single value (or subselect that will result in a single value).
50: * This value is the reference that should be used for any further lookups.<br />
51: * Example: <br/>
52: * statement = "(select created_by from ... where ... limit 1)"<br/>
53: * We can now apply another select logic on this value:<br/>
54: * select username from FX_ACCOUNTS where id={statement}<br/>
55: * The result is the updated statement StringBuffer.
56: *
57: * @param prop the property that is beeing selected
58: * @param entry the property resolver entry
59: * @param statement the statement to modify
60: * @throws FxSqlSearchException if the function fails
61: */
62: void apply(Property prop, PropertyEntry entry,
63: StringBuffer statement) throws FxSqlSearchException;
64:
65: /**
66: * Returns all spported fields.
67: * <p/>
68: * For the FX_ACCOUNT table this fields would be: username, loginname, ...
69: *
70: * @return the fields.
71: */
72: String getAllowedFields();
73: }
|