net.sourceforge.chessshell.plugin.api

Interface ISimplePositionDatabase

public interface ISimplePositionDatabase

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.
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()
int	getDefaultMoveRating()
java.lang.String	getFileName()
int	getIndexOfMove(byte fromSquare, byte toSquare)
int	getMaxMoveRating()
void	getMove(int index) Read move from database.
int	getMoveCount()
byte	getMoveFrom()
int	getMoveRating(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()
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)
boolean	isClosed()
boolean	isCurrentPositionBookmarked()
boolean	isOnlyMove(int moveIndex)
void	promoteVariation(int fromMoveIndex, int toMoveIndex) Promote move.
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.

Method Detail

getPositionCount

long getPositionCount()

Returns:

number of positions.

close

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.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getFileName

java.lang.String getFileName()

Returns:

the canonical file name of the database.

addPosition

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 behaviour is unspecified otherwise. After this call, getCurrentPosition() will return 'fen'.

Parameters:

fen -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getCurrentPosition

java.lang.String getCurrentPosition()

Returns:

the current position, as a FEN string.

containsPosition

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

Parameters:

fen -

Returns:

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

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveCount

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

Returns:

the number of moves stored from the current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

goBackOneMove

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().

See Also:

canGoBack()

getProperties

java.util.Properties getProperties()

Returns:

properties and settings for this database.

containsMove

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

Parameters:

fromSquare -

toSquare -

Returns:

true iff current position contains the given move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getIndexOfMove

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

Parameters:

fromSquare -

toSquare -

Returns:

index (0-based) of move, or -1 if it doesn't exist.

Throws:

net.sourceforge.chessshell.common.DatabaseException

canGoBack

boolean canGoBack()

Returns:

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

See Also:

goBackOneMove()

isClosed

boolean isClosed()

Returns:

true iff database connection is closed/disposed.

addMove

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.

Parameters:

fromSquare -

toSquare -

positionAfterMove -

Throws:

net.sourceforge.chessshell.common.DatabaseException

goForwardByMove

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

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

Parameters:

i -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getBookmarkCount

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

Returns:

number of bookmark positions.

Throws:

net.sourceforge.chessshell.common.DatabaseException

isCurrentPositionBookmarked

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

Returns:

true iff current position is bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectBookmark

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

Navigate to bookmark by index.

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectNextBookmark

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

Navigate to next bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectPreviousBookmark

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

Navigate to previous bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteBookmark

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.

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearAllBookmarks

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

Delete all bookmarks.

Throws:

net.sourceforge.chessshell.common.DatabaseException

compact

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

SQLite VACUUM operation.

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteBookmark

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.

Throws:

net.sourceforge.chessshell.common.DatabaseException

addBookmark

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.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setBookmarkDescription

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

Set description for i'th bookmark.

Parameters:

index -

description -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getBookmarkDescription

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

Parameters:

index -

Returns:

description for i'th bookmark.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setPositionTextComment

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

Set text comment on current position.

Parameters:

txt -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionTextComment

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

Returns:

text comment on current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveTextCommentAfter

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

Set move text comment 'after'.

Parameters:

moveIndex - - 0-based

commentText -

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveTextCommentBefore

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

Set move text comment 'before'.

Parameters:

moveIndex -

commentText -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveTextCommentAfter

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

Parameters:

moveIndex -

Returns:

text comment 'after' move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveTextCommentBefore

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

Parameters:

moveIndex -

Returns:

text comment 'before' move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteMove

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

Delete move.

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMove

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

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

Parameters:

index -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveFrom

byte getMoveFrom()

Returns:

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

getMoveTo

byte getMoveTo()

Returns:

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

setMoveValueAnnotation

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

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

Parameters:

value -

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

getMoveValueAnnotation(int)

getMoveValueAnnotation

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

Parameters:

moveIndex -

Returns:

move value annotation for given move.

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

setMoveValueAnnotation(int, MoveValueAnnotation)

setOnlyMoveAnnotation

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.

Parameters:

moveIndex -

isOnlyMove -

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

isOnlyMove(int)

isOnlyMove

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

Parameters:

moveIndex -

Returns:

true iff move is annotated as 'only move'.

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

setOnlyMoveAnnotation(int, boolean)

setMaxMoveRating

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

Set maximal move rating.

Parameters:

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMaxMoveRating

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

Returns:

maximal move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setDefaultMoveRating

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

Set default move rating value.

Parameters:

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getDefaultMoveRating

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

Returns:

default move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

setMoveRating

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.

Parameters:

moveIndex -

rating -

Throws:

net.sourceforge.chessshell.common.DatabaseException

hasMoveRating

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

Parameters:

moveIndex -

Returns:

true iff move has a rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getMoveRating

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

Parameters:

moveIndex -

Returns:

move rating.

Throws:

net.sourceforge.chessshell.common.DatabaseException

addPositionAnnotationSymbol

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.

Parameters:

nagCode -

Throws:

net.sourceforge.chessshell.common.DatabaseException

containsPositionAnnotationSymbol

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

Parameters:

nagCode -

Returns:

true iff current position contains symbolic annotation code.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionAnnotationSymbolCount

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

Returns:

number of NAG annotations for current position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getPositionAnnotationSymbol

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

Parameters:

nagCodeIndex -

Returns:

the i'th annotation symbol for position.

Throws:

net.sourceforge.chessshell.common.DatabaseException

clearAll

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

Empty all of the database.

Throws:

net.sourceforge.chessshell.common.DatabaseException

promoteVariation

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.

Parameters:

fromMoveIndex -

toMoveIndex -

Throws:

net.sourceforge.chessshell.common.DatabaseException