01: /*
02: * $Id: Searchable.java,v 1.4 2005/11/14 15:23:55 kizune Exp $
03: *
04: * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
05: * Santa Clara, California 95054, U.S.A. All rights reserved.
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation; either
10: * version 2.1 of the License, or (at your option) any later version.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this library; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20: */
21:
22: package org.jdesktop.swingx;
23:
24: import java.util.regex.Pattern;
25:
26: /**
27: * Interface that used to implement search logic in all the search capable
28: * components.
29: *
30: * @author Ramesh Gupta
31: */
32: public interface Searchable {
33:
34: /**
35: * Search <code>searchString</code> from the beginning of a document.
36: *
37: * @param searchString <code>String</code> we should find in a document.
38: *
39: * @return index of matched <code>String</code> or -1 if a match cannot be found.
40: */
41: public int search(String searchString);
42:
43: /**
44: * Search <code>searchString</code> from the given position in a document.
45: *
46: * @param searchString <code>String</code> we should find in a document.
47: * @param startIndex Start position in a document or -1 if we want to search from the beginning.
48: *
49: * @return index of matched <code>String</code> or -1 if a match cannot be found.
50: */
51: public int search(String searchString, int startIndex);
52:
53: /**
54: * Search <code>searchString</code> in the given direction from the some position in a document.
55: *
56: * @param searchString <code>String</code> we should find in a document.
57: * @param startIndex Start position in a document or -1 if we want to search from the beginning.
58: * @param backward Indicates search direction, will search from the given position towards the
59: * beginning of a document if this parameter is <code>true</code>.
60: *
61: * @return index of matched <code>String</code> or -1 if a match cannot be found.
62: */
63: public int search(String searchString, int startIndex,
64: boolean backward);
65:
66: /**
67: * Search for the pattern from the beginning of the document.
68: *
69: * @param pattern Pattern for search
70: *
71: * @return index of matched <code>Pattern</code> or -1 if a match cannot be found.
72: */
73: public int search(Pattern pattern);
74:
75: /**
76: * Search for the pattern from the start index.
77: * @param pattern Pattern for search
78: * @param startIndex starting index of search. If -1 then start from the beginning
79: * @return index of matched pattern or -1 if a match cannot be found.
80: */
81: public int search(Pattern pattern, int startIndex);
82:
83: /**
84: * Search for the pattern from the start index.
85: * @param pattern Pattern for search
86: * @param startIndex starting index of search. If -1 then start from the beginning
87: * @param backward indicates the direction if true then search is backwards
88: * @return index of matched pattern or -1 if a match cannot be found.
89: */
90: public int search(Pattern pattern, int startIndex, boolean backward);
91: }
|