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.search;
043:
044: import java.util.List;
045: import org.netbeans.api.progress.ProgressHandle;
046: import org.netbeans.api.progress.ProgressHandleFactory;
047: import org.openide.LifecycleManager;
048: import org.openide.util.Cancellable;
049: import org.openide.util.NbBundle;
050: import org.openidex.search.SearchType;
051:
052: /**
053: * Task performing search.
054: *
055: * @author Peter Zavadsky
056: * @author Marian Petras
057: */
058: final class SearchTask implements Runnable, Cancellable {
059:
060: /** nodes to search */
061: private final SearchScope searchScope;
062: /** */
063: private final List<SearchType> customizedSearchTypes;
064: /** */
065: private final BasicSearchCriteria basicSearchCriteria;
066: /** ResultModel result model. */
067: private ResultModel resultModel;
068: /** <code>SearchGroup</code> to search on. */
069: private SpecialSearchGroup searchGroup;
070: /** attribute used by class <code>Manager</code> */
071: private boolean notifyWhenFinished = true;
072: /** */
073: private volatile boolean interrupted = false;
074: /** */
075: private volatile boolean finished = false;
076: /** */
077: private final String replaceString;
078:
079: /**
080: * Creates a new <code>SearchTask</code>.
081: *
082: * @param searchScope defines scope of the search task
083: * @param basicSearchCriteria basic search criteria
084: * @param customizedSearchTypes search types
085: */
086: public SearchTask(final SearchScope searchScope,
087: final BasicSearchCriteria basicSearchCriteria,
088: final List<SearchType> customizedSearchTypes) {
089: this .searchScope = searchScope;
090: this .basicSearchCriteria = basicSearchCriteria;
091: this .customizedSearchTypes = customizedSearchTypes;
092:
093: this .replaceString = (basicSearchCriteria != null) ? basicSearchCriteria
094: .getReplaceExpr()
095: : null;
096: }
097:
098: /**
099: */
100: private boolean isSearchAndReplace() {
101: return (replaceString != null);
102: }
103:
104: /** Runs the search task. */
105: public void run() {
106: if (isSearchAndReplace()) {
107: LifecycleManager.getDefault().saveAll();
108: }
109:
110: ProgressHandle progressHandle = ProgressHandleFactory
111: .createHandle(NbBundle.getMessage(ResultView.class,
112: "TEXT_SEARCHING___"), this );
113: progressHandle.start();
114:
115: /* Start the actual search: */
116: ensureResultModelExists();
117: if (searchGroup == null) {
118: return;
119: }
120:
121: searchGroup.setListeningSearchTask(this );
122: try {
123: searchGroup.search();
124: } catch (RuntimeException ex) {
125: resultModel.searchException(ex);
126: ex.printStackTrace();
127: } finally {
128: searchGroup.setListeningSearchTask(null);
129: finished = true;
130: progressHandle.finish();
131: }
132: }
133:
134: SearchTask createNewGeneration() {
135: return new SearchTask(searchScope, basicSearchCriteria,
136: customizedSearchTypes);
137: }
138:
139: /**
140: */
141: ResultModel getResultModel() {
142: ensureResultModelExists();
143: return resultModel;
144: }
145:
146: /**
147: */
148: private void ensureResultModelExists() {
149: if (resultModel == null) {
150: searchGroup = new SpecialSearchGroup(basicSearchCriteria,
151: customizedSearchTypes, searchScope);
152: resultModel = new ResultModel(searchGroup, replaceString);
153: }
154: }
155:
156: /**
157: * Called when a matching object is found by the <code>SearchGroup</code>.
158: * Notifies the result model of the found object and stops searching
159: * if number of the found objects reached the limit.
160: *
161: * @param object found matching object
162: */
163: void matchingObjectFound(Object object) {
164: boolean canContinue = resultModel.objectFound(object);
165: if (!canContinue) {
166: searchGroup.stopSearch();
167: }
168: }
169:
170: /**
171: * Stops this search task.
172: * This method also sets a value of attribute
173: * <code>notifyWhenFinished</code>. This method may be called multiple
174: * times (even if this task is already stopped) to change the value
175: * of the attribute.
176: *
177: * @param notifyWhenFinished new value of attribute
178: * <code>notifyWhenFinished</code>
179: */
180: void stop(boolean notifyWhenFinished) {
181: if (notifyWhenFinished == false) { //allow only change true -> false
182: this .notifyWhenFinished = notifyWhenFinished;
183: }
184: stop();
185: }
186:
187: /**
188: * Stops this search task.
189: *
190: * @see #stop(boolean)
191: */
192: void stop() {
193: if (!finished) {
194: interrupted = true;
195: }
196: if (searchGroup != null) {
197: searchGroup.stopSearch();
198: }
199: }
200:
201: /**
202: * Cancel processing of the task.
203: *
204: * @return true if the task was succesfully cancelled, false if job
205: * can't be cancelled for some reason
206: * @see org.openide.util.Cancellable#cancel
207: */
208: public boolean cancel() {
209: stop();
210: return true;
211: }
212:
213: /**
214: * Returns value of attribute <code>notifyWhenFinished</code>.
215: *
216: * @return current value of the attribute
217: */
218: boolean notifyWhenFinished() {
219: return notifyWhenFinished;
220: }
221:
222: /**
223: * Was this search task interrupted?
224: *
225: * @return <code>true</code> if this method has been interrupted
226: * by calling {@link #stop()} or {@link #stop(boolean)}
227: * during the search; <code>false</code> otherwise
228: */
229: boolean wasInterrupted() {
230: return interrupted;
231: }
232:
233: }
|