net.sourceforge.chessshell.plugin.pgnfileaccessor.sqlite4java

Class SqLitePgnFileIndexerSqlite4java

java.lang.Object

net.sourceforge.chessshell.plugin.pgnfileaccessor.sqlite4java.SqLitePgnFileIndexerSqlite4java

All Implemented Interfaces:

net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

public final class SqLitePgnFileIndexerSqlite4java
extends java.lang.Object
implements net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

Based on sqlite4java.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	databaseVersion See readDb() (and/or search for versionStr).
private java.util.List<java.lang.Long>	gameBytePosition
private long	gameCount
private java.lang.String	indexFileName
private com.almworks.sqlite4java.SQLiteConnection	itsConnection
private boolean	newBase
private java.lang.String	pgnFileName
private long	pgnModifiedAt
private net.sourceforge.chessshell.plugin.api.IProgressReporter	progressReporter
private net.sourceforge.chessshell.plugin.api.IPgnSymbolGetter	psg
private boolean	wasCreatedAnew

Constructor Summary

Constructors

Constructor and Description
SqLitePgnFileIndexerSqlite4java(net.sourceforge.chessshell.plugin.api.IPgnSymbolGetter psg, java.lang.String pgnFileName, net.sourceforge.chessshell.plugin.api.IProgressReporter reporter) Set up the pgn file indexer.

Method Summary

Modifier and Type	Method and Description
private void	addBookmark(int currentGameIdx, java.lang.String gameTrack, java.lang.String description)
void	bookmark(int currentGameIdx, java.lang.String gameTrack, boolean bookmark)
void	bookmark(int currentGameIdx, java.lang.String gameTrack, boolean bookmark, java.lang.String description)
boolean	canBookmarkPosition()
boolean	canClassifyPosition()
void	classifyPosition(int mainType, int subType)
void	clearBookmarks()
void	close()
private void	createDb() create the database tables and populate them.
private void	createTables()
private void	dropTables(boolean acceptError)
private long	fetchGameCount()
int	getBookmarkedPositionCount()
java.lang.String	getBookmarkedPositionDescription(int i)
net.sourceforge.chessshell.plugin.api.GameIndexAndTrack	getBookmarkedPositionIndexes(int i) Fetching the 'game track' of the i'th bookmark.
java.util.List<java.lang.String>	getBookmarkGameTracks(int gameIndex) Get the game-tracks for the game.
long	getGameBytePosition(int i)
long	getGameCount()
int	getIndexInBookmarks(int gameIndex, java.lang.String gameTrack)
void	indexate() callback to allow complicated setup outside ctor
boolean	isPositionBookmarked(int gameIndex, java.lang.String gameTrack)
private long	openDbFile() When opening an existing file, we have to validate several things.
private void	populateTables()
private void	readDb()
void	removeBookmark(int i)
private void	removeBookmark(int currentGameIdx, java.lang.String gameTrack)
void	setBookmarkedPositionDescription(int i, java.lang.String description)
private void	updateDb(boolean acceptError)
boolean	wasCreatedAnew()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

databaseVersion

private static final java.lang.String databaseVersion

See readDb() (and/or search for versionStr). Changes in schema should be accompanied by a new value here, which will force the database to update its schema.

See Also:

Constant Field Values

newBase

private final boolean newBase

psg

private final net.sourceforge.chessshell.plugin.api.IPgnSymbolGetter psg

pgnModifiedAt

private long pgnModifiedAt

pgnFileName

private final java.lang.String pgnFileName

indexFileName

private final java.lang.String indexFileName

itsConnection

private com.almworks.sqlite4java.SQLiteConnection itsConnection

gameCount

private long gameCount

gameBytePosition

private java.util.List<java.lang.Long> gameBytePosition

wasCreatedAnew

private boolean wasCreatedAnew

progressReporter

private final net.sourceforge.chessshell.plugin.api.IProgressReporter progressReporter

Constructor Detail

SqLitePgnFileIndexerSqlite4java

public SqLitePgnFileIndexerSqlite4java(net.sourceforge.chessshell.plugin.api.IPgnSymbolGetter psg,
                                       java.lang.String pgnFileName,
                                       net.sourceforge.chessshell.plugin.api.IProgressReporter reporter)
                                throws net.sourceforge.chessshell.common.DatabaseException

Set up the pgn file indexer.

Parameters:

psg -

pgnFileName -

reporter -

Throws:

net.sourceforge.chessshell.common.DatabaseException

Method Detail

indexate

public void indexate()
              throws net.sourceforge.chessshell.common.DatabaseFormatException

callback to allow complicated setup outside ctor

Specified by:

indexate in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

Throws:

net.sourceforge.chessshell.common.DatabaseFormatException

readDb

private void readDb()

wasCreatedAnew

public boolean wasCreatedAnew()

updateDb

private void updateDb(boolean acceptError)

dropTables

private void dropTables(boolean acceptError)

createDb

private void createDb()

create the database tables and populate them.

createTables

private void createTables()

populateTables

private void populateTables()

openDbFile

private long openDbFile()
                 throws net.sourceforge.chessshell.common.DatabaseFormatException

When opening an existing file, we have to validate several things. At this level, we have to check that the file was created with a format version that is known to us at the moment.

Returns:

time in milliseconds of the databases creation.

Throws:

net.sourceforge.chessshell.common.DatabaseFormatException - - thrown if the file is not a valid database file, ie. contains incorrect (not SQLite) content, wrong tables/schema, or is of a newer database format, not known to us at the moment.

getGameBytePosition

public long getGameBytePosition(int i)

Specified by:

getGameBytePosition in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getGameCount

public long getGameCount()

Specified by:

getGameCount in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

fetchGameCount

private long fetchGameCount()

close

public void close()

Specified by:

close in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

canBookmarkPosition

public boolean canBookmarkPosition()

Specified by:

canBookmarkPosition in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

bookmark

public void bookmark(int currentGameIdx,
                     java.lang.String gameTrack,
                     boolean bookmark)

Specified by:

bookmark in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

bookmark

public void bookmark(int currentGameIdx,
                     java.lang.String gameTrack,
                     boolean bookmark,
                     java.lang.String description)

Specified by:

bookmark in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

removeBookmark

private void removeBookmark(int currentGameIdx,
                            java.lang.String gameTrack)

addBookmark

private void addBookmark(int currentGameIdx,
                         java.lang.String gameTrack,
                         java.lang.String description)

isPositionBookmarked

public boolean isPositionBookmarked(int gameIndex,
                                    java.lang.String gameTrack)

Specified by:

isPositionBookmarked in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getIndexInBookmarks

public int getIndexInBookmarks(int gameIndex,
                               java.lang.String gameTrack)

Specified by:

getIndexInBookmarks in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getBookmarkedPositionCount

public int getBookmarkedPositionCount()

Specified by:

getBookmarkedPositionCount in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getBookmarkedPositionIndexes

public net.sourceforge.chessshell.plugin.api.GameIndexAndTrack getBookmarkedPositionIndexes(int i)

Fetching the 'game track' of the i'th bookmark.

Specified by:

getBookmarkedPositionIndexes in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

setBookmarkedPositionDescription

public void setBookmarkedPositionDescription(int i,
                                             java.lang.String description)

Specified by:

setBookmarkedPositionDescription in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getBookmarkedPositionDescription

public java.lang.String getBookmarkedPositionDescription(int i)

Specified by:

getBookmarkedPositionDescription in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

clearBookmarks

public void clearBookmarks()

Specified by:

clearBookmarks in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

removeBookmark

public void removeBookmark(int i)

Specified by:

removeBookmark in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

canClassifyPosition

public boolean canClassifyPosition()

Specified by:

canClassifyPosition in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

classifyPosition

public void classifyPosition(int mainType,
                             int subType)

Specified by:

classifyPosition in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer

getBookmarkGameTracks

public java.util.List<java.lang.String> getBookmarkGameTracks(int gameIndex)

Get the game-tracks for the game.

Specified by:

getBookmarkGameTracks in interface net.sourceforge.chessshell.plugin.api.IPgnFileIndexer