QueryBuilder.java revision 1416
986N/A * The contents of this file are subject to the terms of the 986N/A * Common Development and Distribution License (the "License"). 986N/A * You may not use this file except in compliance with the License. 986N/A * language governing permissions and limitations under the License. 986N/A * When distributing Covered Code, include this CDDL HEADER in each 986N/A * If applicable, add the following below this CDDL HEADER, with the 986N/A * fields enclosed by brackets "[]" replaced with your own identifying 986N/A * information: Portions Copyright [yyyy] [name of copyright owner] 986N/A * Copyright 2010 Sun Micosystems. All rights reserved. 986N/A * Use is subject to license terms. 1185N/A * Portions Copyright 2011 Jens Elkner. 1185N/A * Helper class that builds a Lucene query based on provided search terms for 1416N/A * Fields we use in lucene public ones 1416N/A * Fields we use in lucene internal ones 1185N/A * A map containing the query text for each field. (We use a sorted map here 1185N/A * only because we have tests that check the generated query string. If we 1185N/A * had used a hash map, the order of the terms could have varied between 1185N/A * platforms and it would be harder to test.) 1185N/A * Set search string for the "full" field. 1185N/A * @param freetext query string to set 1185N/A * Get search string for the "full" field. 1185N/A * @return {@code null} if not set, the query string otherwise. 1190N/A * Set search string for the "defs" field. 1185N/A * @param defs query string to set 1185N/A * Get search string for the "full" field. 1185N/A * @return {@code null} if not set, the query string otherwise. 1190N/A * Set search string for the "refs" field. 1185N/A * @param refs query string to set 1185N/A * Get search string for the "refs" field. 1185N/A * @return {@code null} if not set, the query string otherwise. 1416N/A * Set search string for the "path" field. 1185N/A * @param path query string to set 1185N/A * Get search string for the "path" field. 1185N/A * @return {@code null} if not set, the query string otherwise. 1185N/A * Set search string for the "hist" field. 1185N/A * @param hist query string to set 1185N/A * Get search string for the "hist" field. 1185N/A * @return {@code null} if not set, the query string otherwise. 1416N/A * Get a map containing the query text for each of the fields that have been 1185N/A * @return a possible empty map. 1185N/A * Get the number of query fields set. 1185N/A * @return the current number of fields with a none-empty query string. 1185N/A * Build a new query based on the query text that has been passed in to this 1185N/A * @return a query, or {@code null} if no query text is available. 1416N/A * @throws ParseException if the query text cannot be parsed 986N/A // We don't have any text to parse 986N/A // Parse each of the query texts separately 986N/A // If we only have one sub-query, return it directly 986N/A // We have multiple subqueries, so let's combine them into a 986N/A // If the subquery is a BooleanQuery, we pull out each clause and 986N/A // add it to the outer BooleanQuery so that any negations work on 986N/A // the query as a whole. One exception to this rule: If the query 986N/A // contains one or more Occur.SHOULD clauses and no Occur.MUST 986N/A // clauses, we keep it in a subquery so that the requirement that 986N/A // at least one of the Occur.SHOULD clauses must match (pulling them 986N/A // out would make all of them optional). 986N/A // All other types of subqueries are added directly to the outer 986N/A // query with Occur.MUST. 986N/A * Add query text for the specified field. 986N/A * @param field the field to add query text for 1185N/A * @param query the query text to set 986N/A * Escape special characters in a query string. 986N/A * @param field the field for which the query string is provided 1185N/A * @param query the query string to escape 986N/A * @return the escaped query string 1416N/A // The free text field may contain terms qualified with other 1416N/A // field names, so we don't escape single colons. 1416N/A // Other fields shouldn't use qualified terms, so escape colons 1416N/A // so that we can search for them. 986N/A * Build a subquery against one of the fields. 986N/A * @param field the field to build the query against 986N/A * @param queryText the query text 986N/A * @return a parsed query 1416N/A * @throws ParseException if the query text cannot be parsed 986N/A * Check if a BooleanQuery contains a clause of a given occur type. 986N/A * @param query the query to check 986N/A * @param occur the occur type to check for 986N/A * @return whether or not the query contains a clause of the specified type