uk.ac.shef.dcs.oak.jate.io
Class HSQLDBUtil

java.lang.Object
  extended by uk.ac.shef.dcs.oak.jate.io.HSQLDBUtil

public class HSQLDBUtil
extends java.lang.Object

An utility class for reading and writing data in a GlobalIndex object into HSQL persistence


Field Summary
static java.lang.String VALUE_SEPARATOR
           
 
Constructor Summary
HSQLDBUtil()
           
 
Method Summary
static void addDoc2Id(Document doc, int id, java.sql.Connection conn)
           
static void addDocId2TermIds(java.sql.Connection conn, int docid, int... termids)
           
static void addTermId2DocId(java.sql.Connection conn, int termid, int... docids)
           
static void addTermId2VariantIds(java.sql.Connection conn, int termid, int... varids)
           
static void addTermString2Id(java.lang.String termString, int id, java.sql.Connection conn)
           
static void addTermVarString2Id(java.lang.String termVarString, int id, java.sql.Connection conn)
           
static void addVariantId2TermId(java.sql.Connection conn, int varid, int termid)
           
static void closeHSQLDBConnection(java.sql.Connection conn)
           
static java.sql.Connection createHSQLDBConnection(java.lang.String hsqldbName)
          Establish a database connection to a HSQL database (file system)
static void createJATRGlobalIndexDB(java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getAllDocIds(java.sql.Connection conn)
           
static java.util.Set<Document> getAllDocs(java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getAllTermIds(java.sql.Connection conn)
           
static java.util.Set<java.lang.String> getAllTermStrings(java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getAllTermVariantIds(java.sql.Connection conn)
           
static java.util.Set<java.lang.String> getAllTermVariantStrings(java.sql.Connection conn)
           
static int getCanonicalTermId4VarId(java.sql.Connection conn, int varid)
           
static Document getDoc4DocId(int docId, java.sql.Connection conn)
           
static int getDocId4Doc(Document doc, java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getDocIdsContainTermId(int termId, java.sql.Connection conn)
           
static int getTermId4Term(java.lang.String termString, java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getTermIdsInDocId(int docId, java.sql.Connection conn)
           
static java.lang.String getTermString4TermId(int termId, java.sql.Connection conn)
           
static int getTermVarId4TermVar(java.lang.String termVarString, java.sql.Connection conn)
           
static java.util.Set<java.lang.Integer> getTermVarIds4TermId(int termId, java.sql.Connection conn)
           
static java.lang.String getTermVarString4TermVarId(int termVarId, java.sql.Connection conn)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VALUE_SEPARATOR

public static final java.lang.String VALUE_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

HSQLDBUtil

public HSQLDBUtil()
Method Detail

createHSQLDBConnection

public static java.sql.Connection createHSQLDBConnection(java.lang.String hsqldbName)
Establish a database connection to a HSQL database (file system)

Parameters:
hsqldbName - the file path to the HSQL database (file system). See HSQL documentation at http://hsqldb.org/doc/2.0/guide/running-chapt.html
Returns:
a database connection

closeHSQLDBConnection

public static void closeHSQLDBConnection(java.sql.Connection conn)

createJATRGlobalIndexDB

public static void createJATRGlobalIndexDB(java.sql.Connection conn)
                                    throws java.sql.SQLException
Throws:
java.sql.SQLException

addTermString2Id

public static void addTermString2Id(java.lang.String termString,
                                    int id,
                                    java.sql.Connection conn)
                             throws java.sql.SQLException
Throws:
java.sql.SQLException

addDoc2Id

public static void addDoc2Id(Document doc,
                             int id,
                             java.sql.Connection conn)
                      throws java.sql.SQLException
Throws:
java.sql.SQLException

addTermVarString2Id

public static void addTermVarString2Id(java.lang.String termVarString,
                                       int id,
                                       java.sql.Connection conn)
                                throws java.sql.SQLException
Throws:
java.sql.SQLException

addTermId2DocId

public static void addTermId2DocId(java.sql.Connection conn,
                                   int termid,
                                   int... docids)
                            throws java.sql.SQLException
Throws:
java.sql.SQLException

addTermId2VariantIds

public static void addTermId2VariantIds(java.sql.Connection conn,
                                        int termid,
                                        int... varids)
                                 throws java.sql.SQLException
Throws:
java.sql.SQLException

addVariantId2TermId

public static void addVariantId2TermId(java.sql.Connection conn,
                                       int varid,
                                       int termid)
                                throws java.sql.SQLException
Throws:
java.sql.SQLException

addDocId2TermIds

public static void addDocId2TermIds(java.sql.Connection conn,
                                    int docid,
                                    int... termids)
                             throws java.sql.SQLException
Throws:
java.sql.SQLException

getCanonicalTermId4VarId

public static int getCanonicalTermId4VarId(java.sql.Connection conn,
                                           int varid)
                                    throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermId4Term

public static int getTermId4Term(java.lang.String termString,
                                 java.sql.Connection conn)
                          throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermString4TermId

public static java.lang.String getTermString4TermId(int termId,
                                                    java.sql.Connection conn)
                                             throws java.sql.SQLException
Throws:
java.sql.SQLException

getDocId4Doc

public static int getDocId4Doc(Document doc,
                               java.sql.Connection conn)
                        throws java.sql.SQLException
Throws:
java.sql.SQLException

getDoc4DocId

public static Document getDoc4DocId(int docId,
                                    java.sql.Connection conn)
                             throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermVarId4TermVar

public static int getTermVarId4TermVar(java.lang.String termVarString,
                                       java.sql.Connection conn)
                                throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermVarString4TermVarId

public static java.lang.String getTermVarString4TermVarId(int termVarId,
                                                          java.sql.Connection conn)
                                                   throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermIdsInDocId

public static java.util.Set<java.lang.Integer> getTermIdsInDocId(int docId,
                                                                 java.sql.Connection conn)
                                                          throws java.sql.SQLException
Throws:
java.sql.SQLException

getDocIdsContainTermId

public static java.util.Set<java.lang.Integer> getDocIdsContainTermId(int termId,
                                                                      java.sql.Connection conn)
                                                               throws java.sql.SQLException
Throws:
java.sql.SQLException

getTermVarIds4TermId

public static java.util.Set<java.lang.Integer> getTermVarIds4TermId(int termId,
                                                                    java.sql.Connection conn)
                                                             throws java.sql.SQLException
Throws:
java.sql.SQLException

getAllTermIds

public static java.util.Set<java.lang.Integer> getAllTermIds(java.sql.Connection conn)

getAllTermStrings

public static java.util.Set<java.lang.String> getAllTermStrings(java.sql.Connection conn)

getAllTermVariantIds

public static java.util.Set<java.lang.Integer> getAllTermVariantIds(java.sql.Connection conn)

getAllTermVariantStrings

public static java.util.Set<java.lang.String> getAllTermVariantStrings(java.sql.Connection conn)

getAllDocIds

public static java.util.Set<java.lang.Integer> getAllDocIds(java.sql.Connection conn)

getAllDocs

public static java.util.Set<Document> getAllDocs(java.sql.Connection conn)