Changeset 2106


Ignore:
Timestamp:
08/16/12 13:01:11 (12 years ago)
Author:
oschonef
Message:
  • improve Java docs
File:
1 edited

Legend:

Unmodified
Added
Removed

  • SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRUSearchEngine.java

    r1990 r2106  
    1818
    1919/**
    20  * Interface for connecting the SRU protocol implementation to an actual
    21  * search engine.
    22  * <p>Implementing the
     20 * Interface for connecting the SRU protocol implementation to an actual search
     21 * engine.
     22 * <p>
     23 * Implementing the
    2324 * {@link #explain(SRUServerConfig, SRURequest, SRUDiagnosticList)} and
    2425 * {@link #scan(SRUServerConfig, SRURequest, SRUDiagnosticList)} is optional,
    2526 * but implementing
    26  * {@link #search(SRUServerConfig, SRURequest, SRUDiagnosticList)} is
    27  * mandatory.</p>
    28  * <p>The implementation of these methods is required to be thread-safe.</p>
     27 * {@link #search(SRUServerConfig, SRURequest, SRUDiagnosticList)} is mandatory.
     28 * </p>
     29 * <p>
     30 * The implementation of these methods <em>must</em> be thread-safe.
     31 * </p>
    2932 */
    3033public interface SRUSearchEngine {
    3134
    3235    /**
    33      * Handle a <em>explain</em> operation. Implementing this method is
    34      * optional, but is required, if the <em>writeExtraResponseData</em>
    35      * block of the SRU response needs to be filled.
     36     * Handle an <em>explain</em> operation. Implementing this method is
     37     * optional, but is required, if the <em>writeExtraResponseData</em> block
     38     * of the SRU response needs to be filled. The arguments for this operation
     39     * are provides by the {@link SRURequest} object.
     40     * <p>
     41     * The implementation of this method <em>must</em> be thread-safe.
     42     * </p>
    3643     *
    3744     * @param config
    … …  
    5865    /**
    5966     * Handle a <em>searchRetrieve</em> operation. Implementing this method is
    60      * mandatory. The query arguments are available trough the request object.
     67     * mandatory. The arguments for this operation are provides by the
     68     * {@link SRURequest} object.
     69     * <p>
     70     * The implementation of this method <em>must</em> be thread-safe.
     71     * </p>
    6172     *
    6273     * @param config
    … …  
    7990            throws SRUException;
    8091
     92
    8193    /**
    8294     * Handle a <em>scan</em> operation. Implementing this method is optional.
     95     * If you don't need to handle the <em>scan</em> operation, just return
     96     * <code>null</code> and the SRU server will return the appropiate
     97     * diagnostic to the client. The arguments for this operation are provides
     98     * by the {@link SRURequest} object.
     99     * <p>
     100     * The implementation of this method <em>must</em> be thread-safe.
     101     * </p>
    83102     *
    84103     * @param config
    … …  
    92111     *            non-fatal diagnostics
    93112     * @return a <code>SRUScanResultSet</code> object or <code>null</code> if
    94      *         this operation is not supported by this serach engine
     113     *         this operation is not supported by this search engine
    95114     * @throws SRUException
    96115     *             if an fatal error occurred
Note: See TracChangeset for help on using the changeset viewer.