KickJava   Java API By Example, From Geeks To Geeks.

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


1 package com.daffodilwoods.fulltext.common;
2
3 import com.daffodilwoods.database.resource.DException;
4 import com.daffodilwoods.daffodildb.server.datasystem.interfaces._DatabaseUser;
5
6 /**
7  * <p>Title: _FullTextModifications </p>
8  * <p>Description: This interface performs as interface between internal tables
9  * (token/location tables) created to enable full-text search and corresponding
10  * affect of insert, update and delete methods on the disk for a particular user.
11  * </p>
12  * <p>Copyright: Copyright (c) 2003</p>
13  * <p>Company: </p>
14  * @author not attributable
15  * @version 1.0
16  */

17 public interface _FullTextModifications {
18
19   /**
20    * Inserts values of token/location tables into disk/file for a particular user.
21    * @param user name of the user
22    * @param values to insert
23    * @throws DException
24    */

25   void insert(_DatabaseUser user,Object JavaDoc[] values) throws DException;
26   /**
27    * Updates values of token/location tables into disk/file for a particular user.
28    * @param user name of the user
29    * @param oldColumnValue old values
30    * @param newColumnValue new values
31    * @param documentId documentid corresponding to updated row
32    * @throws DException
33    */

34   void update(_DatabaseUser user,Object JavaDoc oldColumnValue,Object JavaDoc newColumnValue,Object JavaDoc documentId) throws DException;
35   /**
36    * Deletes records from internal tables from disk/file for a particular user.
37    * @param user name of the user
38    * @param documentId documentid corresponding to deleted row
39    * @throws DException
40    */

41   void delete(_DatabaseUser user,Object JavaDoc documentId) throws DException;
42
43   /**
44    * This method is specifically required for TOKEN table.
45    * Token table is created for storing terms corresponding to one document.
46    * This method finds out the last row-id of the token table.
47    * and calculates the rowId (i.e. lastrowid+1) to be used as PK for token
48    * table.
49    * @return pk value to be inserted into token table
50    * @throws DException
51    */

52   Object JavaDoc getLastPK() throws DException;
53 }
54
Popular Tags