net.sourceforge.chessshell.plugin.simplepdb.sqlite4java

Class SimplePositionDatabaseSqlite4Java

java.lang.Object

net.sourceforge.chessshell.plugin.simplepdb.sqlite4java.SimplePositionDatabaseSqlite4Java

All Implemented Interfaces:

net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

public final class SimplePositionDatabaseSqlite4Java
extends java.lang.Object
implements net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

A simple implementation of a position database, based on sqlite4java. Fancy things like mirroring/rotation of positions are not handled here. A client can take care of these advanced features if it wants to.

Field Summary

Fields

Modifier and Type	Field and Description
private com.almworks.sqlite4java.SQLiteConnection	itsConnection
private java.lang.String	itsCurrentPosition
private java.lang.String	itsFileName
private byte	itsFromSquare
private java.util.Stack<java.lang.String>	itsHistory
private int	itsLastReadBookmarkIndex
private java.util.Properties	itsProperties
private byte	itsToSquare
private long	positionCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimplePositionDatabaseSqlite4Java(java.lang.String fileName) Open a SQLite database connection to the given file.

Method Summary

Modifier and Type	Method and Description
void	addBookmark(java.lang.String description) Precondition: Current position is NOT bookmark'ed, AND current position != null (position count > 0).
void	addMove(byte fromSquare, byte toSquare, java.lang.String positionAfterMove) Add move and position after it (unless null).
void	addPosition(java.lang.String fen) Add position from a FEN string.
void	addPositionAnnotationSymbol(int nagCode) Add NAG symbol for current position.
boolean	canGoBack()
void	clearAll() Empty all of the database.
void	clearAllBookmarks() Delete all bookmarks.
private void	clearBookmarks()
private void	clearMovesAndRelations()
private void	clearPositions()
void	close() Always call this when the database is not to be used anymore.
void	compact() SQLite VACUUM operation.
boolean	containsMove(byte fromSquare, byte toSquare)
boolean	containsPosition(java.lang.String fen)
boolean	containsPositionAnnotationSymbol(int nagCode)
void	deleteBookmark() Precondition: Current position is bookmark'ed.
void	deleteBookmark(int index) Delete bookmark by index.
void	deleteMove(int index) Delete move.
int	getBookmarkCount()
java.lang.String	getBookmarkDescription(int index)
java.lang.String	getCurrentPosition()
private long	getCurrentPositionId()
int	getDefaultMoveRating()
java.lang.String	getFileName()
private byte[]	getHistoryBytes()
int	getIndexOfMove(byte fromSquare, byte toSquare)
private long	getMaxBookmarkId()
int	getMaxMoveRating()
void	getMove(int index) Read move from database.
int	getMoveCount()
private int	getMoveCount(long positionId)
byte	getMoveFrom()
int	getMoveRating(int moveIndex)
private long	getMoveRowid(int moveIndex)
java.lang.String	getMoveTextCommentAfter(int moveIndex)
java.lang.String	getMoveTextCommentBefore(int moveIndex)
byte	getMoveTo()
net.sourceforge.chessshell.common.MoveValueAnnotation	getMoveValueAnnotation(int moveIndex)
int	getPositionAnnotationSymbol(int nagCodeIndex)
int	getPositionAnnotationSymbolCount()
private java.lang.String	getPositionById(long positionId)
long	getPositionCount()
java.lang.String	getPositionTextComment()
java.util.Properties	getProperties()
void	goBackOneMove() When we have previously selected (played) a move, or added a move, it is possible to go back.
void	goForwardByMove(int i) Select the i'th move (0-based index).
boolean	hasMoveRating(int moveIndex)
private void	insertMoveRating(int moveIndex, int rating) Insert move rating.
private void	insertMoveValueAnnotation(int moveIndex, net.sourceforge.chessshell.common.MoveValueAnnotation value)
private void	insertOnlyMoveAnnotation(int moveIndex)
private void	insertPositionAnnotationSymbol(int nagCode) Insert position annotation symbol.
boolean	isClosed()
boolean	isCurrentPositionBookmarked()
boolean	isOnlyMove(int moveIndex)
private boolean	isPositionBookmarked(long positionId)
void	promoteVariation(int fromMoveIndex, int toMoveIndex) Promote move.
private java.lang.Object	readFromBytes(byte[] yourBytes)
private long	readPositionCount()
private void	removeOnlyMoveAnnotation(int moveIndex)
void	selectBookmark(int index) Navigate to bookmark by index.
void	selectNextBookmark() Navigate to next bookmark.
void	selectPreviousBookmark() Navigate to previous bookmark.
void	setBookmarkDescription(int index, java.lang.String description) Set description for i'th bookmark.
void	setDefaultMoveRating(int rating) Set default move rating value.
void	setMaxMoveRating(int rating) Set maximal move rating.
void	setMoveRating(int moveIndex, int rating) Set move rating.
void	setMoveTextCommentAfter(int moveIndex, java.lang.String commentText) Set move text comment 'after'.
void	setMoveTextCommentBefore(int moveIndex, java.lang.String commentText) Set move text comment 'before'.
void	setMoveValueAnnotation(int moveIndex, net.sourceforge.chessshell.common.MoveValueAnnotation value) Move value annotations (!,?,...) - only one per move.
void	setOnlyMoveAnnotation(int moveIndex, boolean isOnlyMove) Update only-move annotation for move.
void	setPositionTextComment(java.lang.String txt) Set text comment on current position.
private void	updateMoveRating(int moveIndex, int rating) Update move rating.
private void	updateMoveValueAnnotation(int moveIndex, net.sourceforge.chessshell.common.MoveValueAnnotation value)

Methods inherited from class java.lang.Object

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

Field Detail

itsConnection

private com.almworks.sqlite4java.SQLiteConnection itsConnection

positionCount

private long positionCount

itsFileName

private final java.lang.String itsFileName

itsCurrentPosition

private java.lang.String itsCurrentPosition

itsHistory

private final java.util.Stack<java.lang.String> itsHistory

itsProperties

private final java.util.Properties itsProperties

itsLastReadBookmarkIndex

private int itsLastReadBookmarkIndex

itsFromSquare

private byte itsFromSquare

itsToSquare

private byte itsToSquare

Constructor Detail

SimplePositionDatabaseSqlite4Java

protected SimplePositionDatabaseSqlite4Java(java.lang.String fileName)
                                     throws net.sourceforge.chessshell.common.DatabaseException

Open a SQLite database connection to the given file. If the file does not exist before, it will be created.

Parameters:

fileName -

Throws:

net.sourceforge.chessshell.common.DatabaseException

Method Detail

readFromBytes

private java.lang.Object readFromBytes(byte[] yourBytes)
                                throws java.lang.ClassNotFoundException,
                                       java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

readPositionCount

private long readPositionCount()
                        throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMaxBookmarkId

private long getMaxBookmarkId()
                       throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionCount

public long getPositionCount()

Specified by:

getPositionCount in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

number of positions.

close

public void close()
           throws net.sourceforge.chessshell.common.DatabaseException

Always call this when the database is not to be used anymore. Failure to do so will likely result in lock-errors on the next attempt to open the database.

Specified by:

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

Throws:

net.sourceforge.chessshell.common.DatabaseException

getHistoryBytes

private byte[] getHistoryBytes()
                        throws java.io.IOException

Throws:

java.io.IOException

getFileName

public java.lang.String getFileName()

Specified by:

getFileName in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

the canonical file name of the database.

addPosition

public void addPosition(java.lang.String fen)
                 throws net.sourceforge.chessshell.common.DatabaseException

Add position from a FEN string. The caller is responsible for ensuring that the string is a valid FEN. The behavior is unspecified otherwise. The position is not bookmark'ed. After this call, getCurrentPosition() will return 'fen'.

Specified by:

addPosition in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

fen -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getCurrentPosition

public java.lang.String getCurrentPosition()

Specified by:

getCurrentPosition in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

the current position, as a FEN string.

containsPosition

public boolean containsPosition(java.lang.String fen)
                         throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

containsPosition in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

fen -

Returns:

true iff the given FEN string is a position in the database.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getCurrentPositionId

private long getCurrentPositionId()
                           throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveCount

private int getMoveCount(long positionId)
                  throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveCount

public int getMoveCount()
                 throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMoveCount in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

the number of moves stored from the current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

goBackOneMove

public void goBackOneMove()

When we have previously selected (played) a move, or added a move, it is possible to go back. If the client is not sure that this should be possible, he can first call canGoBack().

Specified by:

goBackOneMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

See Also:

canGoBack()

getProperties

public java.util.Properties getProperties()

Specified by:

getProperties in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

properties and settings for this database.

containsMove

public boolean containsMove(byte fromSquare,
                            byte toSquare)
                     throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

containsMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

fromSquare -

toSquare -

Returns:

true iff current position contains the given move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getIndexOfMove

public int getIndexOfMove(byte fromSquare,
                          byte toSquare)
                   throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getIndexOfMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

canGoBack

public boolean canGoBack()

Specified by:

canGoBack in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

true iff it is possible to go back on the previous move.

See Also:

goBackOneMove()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

true iff database connection is closed/disposed.

addMove

public void addMove(byte fromSquare,
                    byte toSquare,
                    java.lang.String positionAfterMove)
             throws net.sourceforge.chessshell.common.DatabaseException

Add move and position after it (unless null). If the position is not null, it will be the current position after call.

Specified by:

addMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

fromSquare -

toSquare -

positionAfterMove -

Throws:

net.sourceforge.chessshell.common.DatabaseException

goForwardByMove

public void goForwardByMove(int i)
                     throws net.sourceforge.chessshell.common.DatabaseException

Select the i'th move (0-based index).

Specified by:

goForwardByMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

i -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionById

private java.lang.String getPositionById(long positionId)
                                  throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getBookmarkCount

public int getBookmarkCount()
                     throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getBookmarkCount in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

number of bookmark positions.

Throws:

net.sourceforge.chessshell.common.DatabaseException

isCurrentPositionBookmarked

public boolean isCurrentPositionBookmarked()
                                    throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

isCurrentPositionBookmarked in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

true iff current position is bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

isPositionBookmarked

private boolean isPositionBookmarked(long positionId)
                              throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectBookmark

public void selectBookmark(int index)
                    throws net.sourceforge.chessshell.common.DatabaseException

Navigate to bookmark by index.

Specified by:

selectBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectNextBookmark

public void selectNextBookmark()
                        throws net.sourceforge.chessshell.common.DatabaseException

Navigate to next bookmark.

Specified by:

selectNextBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectPreviousBookmark

public void selectPreviousBookmark()
                            throws net.sourceforge.chessshell.common.DatabaseException

Navigate to previous bookmark.

Specified by:

selectPreviousBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearAllBookmarks

public void clearAllBookmarks()
                       throws net.sourceforge.chessshell.common.DatabaseException

Delete all bookmarks.

Specified by:

clearAllBookmarks in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteBookmark

public void deleteBookmark(int index)
                    throws net.sourceforge.chessshell.common.DatabaseException

Delete bookmark by index. If there is no BM with index, calling it has no effect.

Specified by:

deleteBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

compact

public void compact()
             throws net.sourceforge.chessshell.common.DatabaseException

SQLite VACUUM operation.

Specified by:

compact in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteBookmark

public void deleteBookmark()
                    throws net.sourceforge.chessshell.common.DatabaseException

Precondition: Current position is bookmark'ed. Call isCurrentPositionBookmarked() first, and ONLY call this if it returns TRUE. The bookmark collection may be corrupted otherwise.

Specified by:

deleteBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

addBookmark

public void addBookmark(java.lang.String description)
                 throws net.sourceforge.chessshell.common.DatabaseException

Precondition: Current position is NOT bookmark'ed, AND current position != null (position count > 0). Call isCurrentPositionBookmarked() first, and ONLY call this if it returns FALSE - AND if getPositionCount() > 0. The bookmark collection may be corrupted otherwise.

Specified by:

addBookmark in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

setBookmarkDescription

public void setBookmarkDescription(int index,
                                   java.lang.String description)
                            throws net.sourceforge.chessshell.common.DatabaseException

Set description for i'th bookmark.

Specified by:

setBookmarkDescription in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

description -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getBookmarkDescription

public java.lang.String getBookmarkDescription(int index)
                                        throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getBookmarkDescription in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

Returns:

description for i'th bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setPositionTextComment

public void setPositionTextComment(java.lang.String txt)
                            throws net.sourceforge.chessshell.common.DatabaseException

Set text comment on current position.

Specified by:

setPositionTextComment in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

txt -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionTextComment

public java.lang.String getPositionTextComment()
                                        throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getPositionTextComment in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

text comment on current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveTextCommentAfter

public void setMoveTextCommentAfter(int moveIndex,
                                    java.lang.String commentText)
                             throws net.sourceforge.chessshell.common.DatabaseException

Set move text comment 'after'.

Specified by:

setMoveTextCommentAfter in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex - - 0-based

commentText -

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveTextCommentBefore

public void setMoveTextCommentBefore(int moveIndex,
                                     java.lang.String commentText)
                              throws net.sourceforge.chessshell.common.DatabaseException

Set move text comment 'before'.

Specified by:

setMoveTextCommentBefore in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

commentText -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveTextCommentAfter

public java.lang.String getMoveTextCommentAfter(int moveIndex)
                                         throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMoveTextCommentAfter in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

text comment 'after' move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveTextCommentBefore

public java.lang.String getMoveTextCommentBefore(int moveIndex)
                                          throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMoveTextCommentBefore in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

text comment 'before' move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteMove

public void deleteMove(int index)
                throws net.sourceforge.chessshell.common.DatabaseException

Delete move.

Specified by:

deleteMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMove

public void getMove(int index)
             throws net.sourceforge.chessshell.common.DatabaseException

Read move from database. Call getMoveFrom() and getMoveTo() to get from/to squares.

Specified by:

getMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveFrom

public byte getMoveFrom()

Specified by:

getMoveFrom in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

from-square of move read previously with getMove(int)

getMoveTo

public byte getMoveTo()

Specified by:

getMoveTo in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

to-square of move read previously with getMove(int)

setMoveValueAnnotation

public void setMoveValueAnnotation(int moveIndex,
                                   net.sourceforge.chessshell.common.MoveValueAnnotation value)
                            throws net.sourceforge.chessshell.common.DatabaseException

Move value annotations (!,?,...) - only one per move.

Specified by:

setMoveValueAnnotation in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

value -

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

getMoveValueAnnotation(int)

updateMoveValueAnnotation

private void updateMoveValueAnnotation(int moveIndex,
                                       net.sourceforge.chessshell.common.MoveValueAnnotation value)
                                throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

insertMoveValueAnnotation

private void insertMoveValueAnnotation(int moveIndex,
                                       net.sourceforge.chessshell.common.MoveValueAnnotation value)
                                throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveValueAnnotation

public net.sourceforge.chessshell.common.MoveValueAnnotation getMoveValueAnnotation(int moveIndex)
                                                                             throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMoveValueAnnotation in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

move value annotation for given move, null if there is no annotation.

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

setMoveValueAnnotation(int, MoveValueAnnotation)

getMoveRowid

private long getMoveRowid(int moveIndex)
                   throws net.sourceforge.chessshell.common.DatabaseException

Parameters:

moveIndex -

Returns:

the row id for move(index) from current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setOnlyMoveAnnotation

public void setOnlyMoveAnnotation(int moveIndex,
                                  boolean isOnlyMove)
                           throws net.sourceforge.chessshell.common.DatabaseException

Update only-move annotation for move. Logically only one move in a position can be the only move - but here this is not hindered. It could be left to the end-user, or the API client could validate it.

Specified by:

setOnlyMoveAnnotation in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

isOnlyMove -

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

isOnlyMove(int)

removeOnlyMoveAnnotation

private void removeOnlyMoveAnnotation(int moveIndex)
                               throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

insertOnlyMoveAnnotation

private void insertOnlyMoveAnnotation(int moveIndex)
                               throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

isOnlyMove

public boolean isOnlyMove(int moveIndex)
                   throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

isOnlyMove in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

true iff move is annotated as 'only move'.

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

setOnlyMoveAnnotation(int, boolean)

setMaxMoveRating

public void setMaxMoveRating(int rating)
                      throws net.sourceforge.chessshell.common.DatabaseException

Set maximal move rating.

Specified by:

setMaxMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMaxMoveRating

public int getMaxMoveRating()
                     throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMaxMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

maximal move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setDefaultMoveRating

public void setDefaultMoveRating(int rating)
                          throws net.sourceforge.chessshell.common.DatabaseException

Set default move rating value.

Specified by:

setDefaultMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getDefaultMoveRating

public int getDefaultMoveRating()
                         throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getDefaultMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

default move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveRating

public void setMoveRating(int moveIndex,
                          int rating)
                   throws net.sourceforge.chessshell.common.DatabaseException

Set move rating. This is a flexible way of annotating a move - for example, it would support the 'better was' annotation. It can also be used for various other purposes in a position database context.

Specified by:

setMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

updateMoveRating

private void updateMoveRating(int moveIndex,
                              int rating)
                       throws net.sourceforge.chessshell.common.DatabaseException

Update move rating.

Parameters:

moveIndex -

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

insertMoveRating

private void insertMoveRating(int moveIndex,
                              int rating)
                       throws net.sourceforge.chessshell.common.DatabaseException

Insert move rating.

Parameters:

moveIndex -

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

hasMoveRating

public boolean hasMoveRating(int moveIndex)
                      throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

hasMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

true iff move has a rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveRating

public int getMoveRating(int moveIndex)
                  throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getMoveRating in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

moveIndex -

Returns:

move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

addPositionAnnotationSymbol

public void addPositionAnnotationSymbol(int nagCode)
                                 throws net.sourceforge.chessshell.common.DatabaseException

Add NAG symbol for current position. Precondition: There is at least one position in the database. If current position already has that symbol, it has no effect.

Specified by:

addPositionAnnotationSymbol in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

nagCode -

Throws:

net.sourceforge.chessshell.common.DatabaseException

insertPositionAnnotationSymbol

private void insertPositionAnnotationSymbol(int nagCode)
                                     throws net.sourceforge.chessshell.common.DatabaseException

Insert position annotation symbol.

Parameters:

nagCode -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionAnnotationSymbol

public int getPositionAnnotationSymbol(int nagCodeIndex)
                                throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getPositionAnnotationSymbol in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

nagCodeIndex -

Returns:

the i'th annotation symbol code for current position

Throws:

net.sourceforge.chessshell.common.DatabaseException

java.lang.ArrayIndexOutOfBoundsException

See Also:

getCurrentPosition()

containsPositionAnnotationSymbol

public boolean containsPositionAnnotationSymbol(int nagCode)
                                         throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

containsPositionAnnotationSymbol in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

nagCode -

Returns:

true iff current position contains symbolic annotation code.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionAnnotationSymbolCount

public int getPositionAnnotationSymbolCount()
                                     throws net.sourceforge.chessshell.common.DatabaseException

Specified by:

getPositionAnnotationSymbolCount in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Returns:

number of NAG annotations for current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearAll

public void clearAll()
              throws net.sourceforge.chessshell.common.DatabaseException

Empty all of the database.

Specified by:

clearAll in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearPositions

private void clearPositions()
                     throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearBookmarks

private void clearBookmarks()
                     throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearMovesAndRelations

private void clearMovesAndRelations()
                             throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

promoteVariation

public void promoteVariation(int fromMoveIndex,
                             int toMoveIndex)
                      throws net.sourceforge.chessshell.common.DatabaseException

Promote move. TODO - clarify what this means - look at testing for other database implementations.

Specified by:

promoteVariation in interface net.sourceforge.chessshell.plugin.api.ISimplePositionDatabase

Parameters:

fromMoveIndex -

toMoveIndex -

Throws:

net.sourceforge.chessshell.common.DatabaseException