net.samuelcmace.utk.logic.DatabaseReadConnection Class Reference

The DatabaseConnection child class associated with reading data from the database. More...

Inheritance diagram for net.samuelcmace.utk.logic.DatabaseReadConnection:

Collaboration diagram for net.samuelcmace.utk.logic.DatabaseReadConnection:

Public Member Functions
	DatabaseReadConnection (String m_dbConnectionString)
	Initializes a new instance of DatabaseReadConnection.
void	RunActiveQuery () throws SQLException
	Runs the currently-stored query which was set using the getCardBy* methods.
void	getCardByKanji (String m_kanji)
	Sets the currently active query string based on the passed-in parameters.
void	getCardBy5thEditionIndex (int m_heisigIndex)
	Sets the currently active query string based on the passed-in parameters.
void	getCardBy6thEditionIndex (int m_heisigIndex)
	Sets the currently active query string based on the passed-in parameters.
void	getCardBy5thEditionKeyword (String m_keyword)
	Sets the currently active query string based on the passed-in parameters.
void	getCardBy6thEditionKeyword (String m_keyword)
	Sets the currently active query string based on the passed-in parameters.
Public Member Functions inherited from net.samuelcmace.utk.logic.DatabaseConnection
	DatabaseConnection (String m_dbConnectionString)
	Initializes a new instance of DatabaseConnection.

Public Attributes
Statement	ActiveStatement
	The statement object associated with reading data from the database.
ResultSet	ActiveResultSet
	The active result set associated with reading data from the database.
Public Attributes inherited from net.samuelcmace.utk.logic.DatabaseConnection
Connection	ActiveConnection
	The connection object associated with the instance of DatabaseConnection.

Protected Member Functions
void	finalize ()
	Method called by the Java garbage collector before the object is destroyed.
void	finalize ()
	Method called by the Java garbage collector before the object is destroyed.

Additional Inherited Members
Protected Attributes inherited from net.samuelcmace.utk.logic.DatabaseConnection
String	dbConnectionString
	The JDBC connection string that corresponds to the database.
String	activeQuery
	The currently active query string used to generate the ActiveResultSet.

Detailed Description

The DatabaseConnection child class associated with reading data from the database.

Constructor & Destructor Documentation

DatabaseReadConnection()

net.samuelcmace.utk.logic.DatabaseReadConnection.DatabaseReadConnection

(

String

m_dbConnectionString

)

Initializes a new instance of DatabaseReadConnection.

Parameters

m_dbConnectionString

The JDBC connection string.

Member Function Documentation

finalize()

void net.samuelcmace.utk.logic.DatabaseReadConnection.finalize ( )

protected

Method called by the Java garbage collector before the object is destroyed.

Although this method is not needed in most java programming, it is needed here to ensure that the database connections are closed before the program exists.

Reimplemented from net.samuelcmace.utk.logic.DatabaseConnection.

getCardBy5thEditionIndex()

void net.samuelcmace.utk.logic.DatabaseReadConnection.getCardBy5thEditionIndex

(

int

m_heisigIndex

)

Sets the currently active query string based on the passed-in parameters.

The query still needs to be executed by calling the RunActiveQuery() method.

Parameters

m_heisigIndex

The Heisig Index that corresponds to the Kanji character in question.

getCardBy5thEditionKeyword()

void net.samuelcmace.utk.logic.DatabaseReadConnection.getCardBy5thEditionKeyword

(

String

m_keyword

)

Sets the currently active query string based on the passed-in parameters.

The query still needs to be executed by calling the RunActiveQuery() method.

Parameters

m_keyword

The keyword that corresponds to the Kanji character in question.

getCardBy6thEditionIndex()

void net.samuelcmace.utk.logic.DatabaseReadConnection.getCardBy6thEditionIndex

(

int

m_heisigIndex

)

Sets the currently active query string based on the passed-in parameters.

The query still needs to be executed by calling the RunActiveQuery() method.

Parameters

m_heisigIndex

The Heisig Index that corresponds to the Kanji character in question.

getCardBy6thEditionKeyword()

void net.samuelcmace.utk.logic.DatabaseReadConnection.getCardBy6thEditionKeyword

(

String

m_keyword

)

Sets the currently active query string based on the passed-in parameters.

The query still needs to be executed by calling the RunActiveQuery() method.

Parameters

m_keyword

The keyword that corresponds to the Kanji character in question.

getCardByKanji()

void net.samuelcmace.utk.logic.DatabaseReadConnection.getCardByKanji

(

String

m_kanji

)

Sets the currently active query string based on the passed-in parameters.

The query still needs to be executed by calling the RunActiveQuery() method.

Parameters

m_kanji

The Kanji character in question.

RunActiveQuery()

void net.samuelcmace.utk.logic.DatabaseReadConnection.RunActiveQuery

(

)

throws SQLException

Runs the currently-stored query which was set using the getCardBy* methods.

Exceptions

SQLException

Thrown if there was a database query-related error.

---

The documentation for this class was generated from the following file:

• /github/workspace/src/main/java/net/samuelcmace/utk/logic/DatabaseReadConnection.java