~sword-devel/jsword/trunk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
package org.crosswire.jsword.control.search;

import org.crosswire.jsword.passage.Passage;

/**
 * The Search Word for a Word to search for. The default
 * if no other SearchWords match.
 * 
 * <p><table border='1' cellPadding='3' cellSpacing='0'>
 * <tr><td bgColor='white' class='TableRowColor'><font size='-7'>
 *
 * Distribution Licence:<br />
 * JSword is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General Public License,
 * version 2 as published by the Free Software Foundation.<br />
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.<br />
 * The License is available on the internet
 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, or by writing to:
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA<br />
 * The copyright to this program is held by it's authors.
 * </font></td></tr></table>
 * @see docs.Licence
 * @author Joe Walker [joe at eireneh dot com]
 * @version $Id$
 */
public class DefaultParamWord implements ParamWord
{
    /**
    * Create a the default rule with the (presumably) Bible
    * word that formed part of the original search string
    * @param text The word to search (or otherwise) for
    */
    public DefaultParamWord(String text)
    {
        this.text = text;
    }

    /**
    * Get a word for something else to word on.
    * @return The word to search for
    */
    public String getWord(Engine engine)
    {
        return text;
    }

    /**
    * To help error reporting.
    * @return The word to search for
    */
    public String toString()
    {
        return text;
    }

    /**
    * Get a Passage for something else to word on.
    * @param word_stack The set of words in the command line
    * @param current The Passage to alter (if necessary)
    * @param bible The Bible to use to search against
    * @return An array of alternative words
    */
    public Passage getPassage(Engine engine) throws SearchException
    {
        try
        {
            return engine.getBible().findPassage(text);
        }
        catch (Exception ex)
        {
            throw new SearchException("search_default_other", ex, new Object[] { text });
        }
    }

    /** The word that we represent */
    private String text = null;
}