KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > daffodilwoods > daffodildb > server > sql99 > fulltext > dql > condition > _FullTextPredicate


1 package com.daffodilwoods.daffodildb.server.sql99.fulltext.dql.condition;
2
3 import com.daffodilwoods.daffodildb.server.sql99.dql.plan.table._IndexPredicateInterface;
4 import com.daffodilwoods.database.resource.DException;
5 import com.daffodilwoods.daffodildb.server.sql99.dql.iterator._Iterator;
6
7 /**
8  * It represents plan for optimal execution of serach expression present in
9  * 'Contains clause'.
10  * <p>Title: </p>
11  * <p>Description: </p>
12  * <p>Copyright: Copyright (c) 2003</p>
13  * <p>Company: </p>
14  * @author not attributable
15  * @version 1.0
16  */
17
18 public interface _FullTextPredicate extends _IndexPredicateInterface {
19   /**
20    * this method is used to get type of plan.Type of plan are required when we
21    * merged two plan either with Logical AND or OR.
22    * plan can be of following type
23    * 1.singleword
24    * 2.AndWords
25    * 3.OrWords
26    * 4.notFullTextPredicate
27    * 5.andFullTextPredicate
28    * 6.orfullTextPredicate
29    * 7.notFullTextPredicate
30    * 8.optimizedFullTextPredicate
31    * 9.AndFulltext
32    * 10. AllKeywordSortedPredicate
33    * 11. AnyKeywordSortedPredicate
34    * @return
35    * @throws DException
36    */
37   public int getType() throws DException;
38   /**
39    * It is required to get columnName of column against which search pattern is searched
40    * @return columnName
41    * @throws DException
42    */
43   public String JavaDoc getColumn() throws DException;
44   /**
45    * setColumn is used to set columnName of column against which search pattern is searched.
46    * @param column
47    * @throws DException
48    */
49   public void setColumn(String JavaDoc column) throws DException;
50   /**
51    * It provides functionality of plan execution and generate resultset which is
52    * used for navigation of records. It returns documents in sorted order.
53    * It is different from execute method of parent interface. Execute method
54    * returns the document according to rank algorithm which is not sorted on
55    * document id. But this method returns the documents sorted on documentid.
56    * This sorting is required for set operator's resultset which is returned from
57    * this method.
58    * @param indexTable
59    * @return _Iterator
60    * @throws DException
61    */
62   public _Iterator executeForSortedResult(Object JavaDoc indexTable) throws DException;
63 }
64
Popular Tags