KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > daffodilwoods > daffodildb > server > sql99 > fulltext > dml > _FullTextIndexInformation


1 package com.daffodilwoods.daffodildb.server.sql99.fulltext.dml;
2
3 import com.daffodilwoods.database.resource.DException;
4 import com.daffodilwoods.database.general.QualifiedIdentifier;
5
6 /**
7  * <p>Title: _FullTextIndexInformation </p>
8  * <p>Description: This interface provides the neccessary methods to retrive
9  * names of indexes required to enable full-text search, full-text enabled
10  * column(s), table and corresponding token and location table names. </p>
11  * <p>Copyright: Copyright (c) 2003</p>
12  * <p>Company: </p>
13  * @author not attributable
14  * @version 1.0
15  */
16
17 public interface _FullTextIndexInformation {
18
19   /**
20    * The method is required to retrieve the full-text enabled column name.
21    * @return name on column on which full-text is enabled.
22    * @throws DException
23    */
24   public String JavaDoc[] getColumnName() throws DException;
25   /**
26    * The method is required to retrieve the token table name.
27    * @return name of token table.
28    * @throws DException
29    */
30   public QualifiedIdentifier getTokenTableName() throws DException;
31   /**
32    * The method is required to retrieve the location table name.
33    * @return name of location table.
34    * @throws DException
35    */
36   public QualifiedIdentifier getLocationTableName() throws DException;
37   /**
38    * The method is required to retrieve the index of full-text enabled column.
39    * @return index of full text indexed column
40    * @throws DException
41    */
42   public int[] getColumnIndex() throws DException;
43   /**
44    * The method is required to retrieve the table name having full-text
45    * enabled column.
46    * @return name of table on which full-text is applied.
47    * @throws DException
48    */
49   public QualifiedIdentifier getTableName() throws DException;
50   /**
51    * The method is required to retrieve the corresponding index created for
52    * full-text enabled column (created on token table or location table correspondingly) .
53    * @return name of index created on token/location table.
54    * @throws DException
55    */
56   public String JavaDoc getIndexName() throws DException;
57
58 }
59
Popular Tags