0.5.2/java/NodeResult.java

/*************************************************************************************************
 * Java interface of Hyper Estraier
 *                                                      Copyright (C) 2004-2005 Mikio Hirabayashi
 *                                                                           All rights reserved.
 * This file is part of Hyper Estraier.
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice, this list of
 *     conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright notice, this list of
 *     conditions and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *   * Neither the name of Mikio Hirabayashi nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific prior written
 *     permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *************************************************************************************************/


package estraier;


/**
 * Abstraction of result set from P2P node.
 */
public interface NodeResult {
  //----------------------------------------------------------------
  // public methods
  //----------------------------------------------------------------
  /**
   * Get the number of documents.
   * @return the number of documents.
   */
  public int doc_num();
  /**
   * Get a result document object
   * @param index the index of a document.
   * @return a result document object or null if the index is out of bounds.
   */
  public ResultDocument get_doc(int index);
  /**
   * Get the value of hint information.
   * @param key the key of a hint.  "VERSION", "NODE", "HIT", "HINT#n", "DOCNUM", "WORDNUM",
   * "TIME", "LINK#n", and "VIEW" are provided for keys.
   * @return the value of the hint or null if the key does not exist.
   */
  public String hint(String key);
};


/* END OF FILE */
1	/*************************************************************************************************
2	* Java interface of Hyper Estraier
3	* Copyright (C) 2004-2005 Mikio Hirabayashi
4	* All rights reserved.
5	* This file is part of Hyper Estraier.
6	* Redistribution and use in source and binary forms, with or without modification, are
7	* permitted provided that the following conditions are met:
8	*
9	* * Redistributions of source code must retain the above copyright notice, this list of
10	* conditions and the following disclaimer.
11	* * Redistributions in binary form must reproduce the above copyright notice, this list of
12	* conditions and the following disclaimer in the documentation and/or other materials
13	* provided with the distribution.
14	* * Neither the name of Mikio Hirabayashi nor the names of its contributors may be used to
15	* endorse or promote products derived from this software without specific prior written
16	* permission.
17	*
18	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
19	* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21	* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23	* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26	* OF THE POSSIBILITY OF SUCH DAMAGE.
27	*************************************************************************************************/
28
29
30	package estraier;
31
32
33
34	/**
35	* Abstraction of result set from P2P node.
36	*/
37	public interface NodeResult {
38	//----------------------------------------------------------------
39	// public methods
40	//----------------------------------------------------------------
41	/**
42	* Get the number of documents.
43	* @return the number of documents.
44	*/
45	public int doc_num();
46	/**
47	* Get a result document object
48	* @param index the index of a document.
49	* @return a result document object or null if the index is out of bounds.
50	*/
51	public ResultDocument get_doc(int index);
52	/**
53	* Get the value of hint information.
54	* @param key the key of a hint. "VERSION", "NODE", "HIT", "HINT#n", "DOCNUM", "WORDNUM",
55	* "TIME", "LINK#n", and "VIEW" are provided for keys.
56	* @return the value of the hint or null if the key does not exist.
57	*/
58	public String hint(String key);
59	};
60
61
62
63	/* END OF FILE */