001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.sqlParser;
034:
035: import com.flexive.shared.FxArrayUtils;
036: import com.flexive.shared.search.query.VersionFilter;
037:
038: import java.util.StringTokenizer;
039:
040: /**
041: * Filter
042: *
043: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
044: */
045: public class Filter {
046: public enum TYPE {
047: VERSION, IGNORE_CASE, MAX_RESULTROWS, SEARCH_LANGUAGES,
048: /*RESULT_LANGUAGES,*/
049: BRIEFCASE
050: }
051:
052: private TYPE type;
053: private String value;
054: private Table table;
055:
056: /**
057: * Constructor.
058: *
059: * @param stmt the statement the filter belongs to
060: * @param type the type of the filter, case insensitive
061: * @param value the value of the filter
062: * @throws SqlParserException if a error occured
063: */
064: protected Filter(FxStatement stmt, String type, String value)
065: throws SqlParserException {
066:
067: // Trim away any whitespaces.
068: // The parser uses '|' as list separator, but in most cases we want ','.
069: value = value.trim().replace('|', ',');
070: this .value = value;
071:
072: if (type.indexOf(".") > 0) {
073: StringTokenizer st = new StringTokenizer(type, ".", false);
074: String sTable = st.nextToken().toUpperCase();
075: this .table = stmt.getTableByAlias(sTable);
076: type = st.nextToken();
077: type = type.toUpperCase();
078: if (this .table == null) {
079: throw new SqlParserException(
080: "ex.sqlSearch.filter.unknownTable", sTable,
081: type);
082: }
083: // ----------- VERSION -------------------------------------------------------------------------------------
084: if (type.equalsIgnoreCase(String.valueOf(TYPE.VERSION))) {
085: _processVersionFilter(stmt);
086: }
087: // ----------- CONTENT -------------------------------------------------------------------------------------
088: else if (type.equalsIgnoreCase("TYPE")) {
089: stmt.setContentTypeFilter(value);
090: }
091: // ----------- LANGUAGES -----------------------------------------------------------------------------------
092: else if (type.equalsIgnoreCase(String
093: .valueOf(TYPE.SEARCH_LANGUAGES))) {
094: this .type = TYPE.SEARCH_LANGUAGES;
095: table.setSearchLanguages(value.split(","));
096: }
097: // ----------- INVALID -------------------------------------------------------------------------------------
098: else {
099: throw new SqlParserException(
100: "ex.sqlSearch.filter.unknownTableFilter", type,
101: String.valueOf(TYPE.SEARCH_LANGUAGES));
102: }
103: this .table.addFilter(this );
104: } else {
105: type = type.toUpperCase();
106: if (type.equalsIgnoreCase(String.valueOf(TYPE.BRIEFCASE))) {
107: try {
108: stmt.setBriefcaseFilter(FxArrayUtils.toLongArray(
109: value, ','));
110: } catch (Throwable t) {
111: throw new SqlParserException(
112: "ex.sqlSearch.filter.invalidNumber", type,
113: String.valueOf(TYPE.MAX_RESULTROWS));
114: }
115: } else if (type.equalsIgnoreCase(String
116: .valueOf(TYPE.IGNORE_CASE))) {
117: stmt.setIgnoreCase(getValueAsBoolean());
118: } else if (type.equalsIgnoreCase(String
119: .valueOf(TYPE.MAX_RESULTROWS))) {
120: this .type = TYPE.MAX_RESULTROWS;
121: try {
122: final int maxResultRows = Integer.valueOf(value);
123: if (maxResultRows < 0) {
124: throw new SqlParserException(
125: "ex.sqlSearch.filter.negativeNumber",
126: TYPE.MAX_RESULTROWS);
127: }
128: stmt.setMaxResultRows(maxResultRows);
129: } catch (Exception exc) {
130: throw new SqlParserException(
131: "ex.sqlSearch.filter.invalidNumber", type,
132: String.valueOf(TYPE.MAX_RESULTROWS));
133: }
134: } else {
135: throw new SqlParserException(
136: "ex.sqlSearch.filter.unknownGlobalFilter",
137: type, String.valueOf(TYPE.MAX_RESULTROWS) + ","
138: + String.valueOf(TYPE.IGNORE_CASE));
139: }
140: stmt.addFilter(this );
141: }
142:
143: }
144:
145: /**
146: * Processes the VERSION filter.
147: *
148: * @param stmt the statement
149: * @throws SqlParserException if the version filter value is invalid
150: */
151: private void _processVersionFilter(FxStatement stmt)
152: throws SqlParserException {
153: this .type = TYPE.VERSION;
154: VersionFilter ver;
155: value = value.toUpperCase();
156: if (value.equals(VersionFilter.AUTO.toString())) {
157: // TODO: AUTO depends on the user/session setting
158: value = VersionFilter.MAX.toString();
159: }
160: if (value.equals(VersionFilter.MAX.toString())) {
161: ver = VersionFilter.MAX;
162: } else if (value.equals(VersionFilter.LIVE.toString())) {
163: ver = VersionFilter.LIVE;
164: } else if (value.equals(VersionFilter.ALL.toString())) {
165: ver = VersionFilter.ALL;
166: } else {
167: throw new SqlParserException(
168: "ex.sqlSearch.filter.unknownVersionFilter", value);
169: }
170: stmt.setVersionFilter(ver);
171: }
172:
173: /**
174: * Returns the type of the filter.
175: *
176: * @return the type of the filter
177: */
178: public TYPE getType() {
179: return type;
180: }
181:
182: /**
183: * The value of the filter.
184: *
185: * @return the value
186: */
187: public String getValue() {
188: return value;
189: }
190:
191: /**
192: * The value of the filter as integer.
193: *
194: * @return the valuee
195: */
196: public int getValueAsInt() {
197: return Integer.valueOf(value);
198: }
199:
200: /**
201: * The value of the filter as integer.
202: *
203: * @return the valuee
204: */
205: public boolean getValueAsBoolean() {
206: return (value != null && (value.equalsIgnoreCase("T") || value
207: .equalsIgnoreCase("TRUE")));
208: }
209:
210: /**
211: * The table the filter is assigned to, or null if it is a general filter.
212: *
213: * @return the table
214: */
215: public Table getTable() {
216: return table;
217: }
218:
219: }
|