01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001 Janne Jalkanen (Janne.Jalkanen@iki.fi)
05:
06: This program is free software; you can redistribute it and/or modify
07: it under the terms of the GNU Lesser General Public License as published by
08: the Free Software Foundation; either version 2.1 of the License, or
09: (at your option) any later version.
10:
11: This program is distributed in the hope that it will be useful,
12: but WITHOUT ANY WARRANTY; without even the implied warranty of
13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: GNU Lesser General Public License for more details.
15:
16: You should have received a copy of the GNU Lesser General Public License
17: along with this program; if not, write to the Free Software
18: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20: package com.ecyrd.jspwiki;
21:
22: /**
23: * Defines a search result.
24: *
25: * @author Janne Jalkanen
26: */
27: // FIXME3.0: Move to the search-package
28: public interface SearchResult {
29: /**
30: * Return the page.
31: *
32: * @return the WikiPage object containing this result
33: */
34: public WikiPage getPage();
35:
36: /**
37: * Returns the score.
38: *
39: * @return A positive score value. Note that there is no upper limit for the score.
40: */
41:
42: public int getScore();
43:
44: /**
45: * Collection of XHTML fragments representing some contexts in which
46: * the match was made (a.k.a., "snippets").
47: *
48: * @return the search results
49: * @since 2.4
50: */
51: public String[] getContexts();
52: }
|