0.5.3/java/ResultDocument.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 document in result set.
 */
public interface ResultDocument {
  //----------------------------------------------------------------
  // public methods
  //----------------------------------------------------------------
  /**
   * Get the URI.
   * @return the URI.
   */
  String uri();
  /**
   * Get a list of attribute names.
   * @return a list object of attribute names.
   */
  java.util.List attr_names();
  /**
   * Get the value of an attribute.
   * @param name the name of an attribute.
   * @return the value of the attribute or null if it does not exist.
   */
  String attr(String name);
  /**
   * Get the snippet.
   * @return the snippet of the result document object.  There are tab separated values.  Each
   * line is a string to be shown.  Though most lines have only one field, some lines have two
   * fields.  If the second field exists, the first field is to be shown with highlighted, and
   * the second field means its normalized form.
   */
  String snippet();
};


/* 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 document in result set.
36	*/
37	public interface ResultDocument {
38	//----------------------------------------------------------------
39	// public methods
40	//----------------------------------------------------------------
41	/**
42	* Get the URI.
43	* @return the URI.
44	*/
45	String uri();
46	/**
47	* Get a list of attribute names.
48	* @return a list object of attribute names.
49	*/
50	java.util.List attr_names();
51	/**
52	* Get the value of an attribute.
53	* @param name the name of an attribute.
54	* @return the value of the attribute or null if it does not exist.
55	*/
56	String attr(String name);
57	/**
58	* Get the snippet.
59	* @return the snippet of the result document object. There are tab separated values. Each
60	* line is a string to be shown. Though most lines have only one field, some lines have two
61	* fields. If the second field exists, the first field is to be shown with highlighted, and
62	* the second field means its normalized form.
63	*/
64	String snippet();
65	};
66
67
68
69	/* END OF FILE */