001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.xml.xam.ui.search;
043:
044: /**
045: * Encapsulates the search query and its parameters.
046: *
047: * @author Nathan Fiedler
048: */
049: public class Query {
050: /** The query string, possibly a regular expression. */
051: private String query;
052: /** Indicates if search is rooted at selected component, or the
053: * XAM model root component. */
054: private boolean selected;
055: /** Indicates if the query is a regular expression or a plain string. */
056: private boolean regex;
057:
058: /**
059: * Creates a new instance of Query.
060: *
061: * @param query phrase to search for.
062: * @param selected if true, limit search to selected subtree.
063: * @param regex if true, query is a regular expression.
064: */
065: public Query(String query, boolean selected, boolean regex) {
066: this .query = query;
067: this .selected = selected;
068: this .regex = regex;
069: }
070:
071: /**
072: * Returns the query string entered by the user.
073: *
074: * @return search phrase.
075: */
076: public String getQuery() {
077: return query;
078: }
079:
080: /**
081: * Returns true if the query string is a Perl-like regular expression,
082: * false if it is a plain string.
083: *
084: * @return true if regex, false otherwise.
085: */
086: public boolean isRegularExpression() {
087: return regex;
088: }
089:
090: /**
091: * Returns true if this query should be rooted at the selected component,
092: * or if the search should begin at the root component.
093: *
094: * @return true if searching from selected component, false if root.
095: * @see #getSelectedComponent
096: */
097: public boolean useSelected() {
098: return selected;
099: }
100: }
|