KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > daffodilwoods > fulltext > common > _FullTextDML


1 package com.daffodilwoods.fulltext.common;
2
3 import com.daffodilwoods.database.resource.DException;
4 import com.daffodilwoods.daffodildb.server.datasystem.interfaces._DatabaseUser;
5 import com.daffodilwoods.daffodildb.server.sql99.fulltext.dml._FullTextIndexInformation;
6
7 /**
8  * <p>Title: _FullTextDML </p>
9  * <p>Description: This interfaces provides insert, update and delete methods
10  * that performs the corresponding effect on internal tables created so far
11  * full-text search.</p>
12  * <p>Copyright: Copyright (c) 2003</p>
13  * <p>Company: </p>
14  * @author not attributable
15  * @version 1.0
16  */
17 public interface _FullTextDML {
18
19   /**
20    * Inserts passed value of the full-text enabled column for a particular
21    * user. (Value is tokenised and populates the token/location tables
22    * that are created for full-text handling.)
23    * @param user name of the user
24    * @param columnValue parsed clob or varchar column value to be tokenised
25    * @param pk document id
26    * @throws DException
27    */
28   void insert(_DatabaseUser user,Object JavaDoc columnValue,Object JavaDoc pk) throws DException;
29   /**
30    * Deletes the old version of record corresponding to the document-id to be
31    * updated and inserts new version of updated record..
32    * @param user name of the user
33    * @param oldColumnValue old value of column
34    * @param newColumnValue new value of column
35    * @param pk documentid
36    * @throws DException
37    */
38   void update(_DatabaseUser user,Object JavaDoc oldColumnValue,Object JavaDoc newColumnValue,Object JavaDoc pk) throws DException;
39   /**
40    * Deletes the corresponding records to the document id passed from the internal tables.
41    * @param user name of user
42    * @param pk document id corresponding to whcih records to delete
43    * @throws DException
44    */
45   void delete(_DatabaseUser user,Object JavaDoc pk) throws DException;
46   /**
47    * Determines the full-text enabled column Index
48    * @return index of full-text enabled column
49    */
50   int[] getColumnIndex();
51   /**
52    * This method is required to store index information of
53    * token/location table.
54    * @param fullTextIndexInformation0
55    */
56    void setFullTextIndexInformation(_FullTextIndexInformation fullTextIndexInformation0);
57    /**
58     * Determines the indexes information creted for token table/location table
59     * @return
60     */
61     _FullTextIndexInformation getFullTextIndexInformation( );
62 }
63
Popular Tags