net.sourceforge.chessshell.plugin.api

Interface IPgnFileIndexer

public interface IPgnFileIndexer

Method Summary

Modifier and Type	Method and Description
void	bookmark(int currentGameIdx, java.lang.String gameTrack, boolean b)
void	bookmark(int currentGameIdx, java.lang.String gameTrack, boolean b, java.lang.String description)
boolean	canBookmarkPosition()
boolean	canClassifyPosition()
void	classifyPosition(int mainType, int subType)
void	clearBookmarks() Remove all bookmarks.
void	close()
int	getBookmarkedPositionCount()
java.lang.String	getBookmarkedPositionDescription(int i)
GameIndexAndTrack	getBookmarkedPositionIndexes(int i)
java.util.List<java.lang.String>	getBookmarkGameTracks(int gameIndex) Return the 'game tracks' of the bookmarked positions of the given game.
long	getGameBytePosition(int i)
long	getGameCount()
int	getIndexInBookmarks(int gameIndex, java.lang.String gameTrack)
void	indexate()
boolean	isPositionBookmarked(int gameIndex, java.lang.String gameTrack)
void	removeBookmark(int i) Remove i'th bookmark.
void	setBookmarkedPositionDescription(int i, java.lang.String description) Update description of given bookmark.

Method Detail

getGameCount

long getGameCount()

getGameBytePosition

long getGameBytePosition(int i)

indexate

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

Throws:

net.sourceforge.chessshell.common.DatabaseFormatException

close

void close()

canBookmarkPosition

boolean canBookmarkPosition()

bookmark

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

bookmark

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

isPositionBookmarked

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

getIndexInBookmarks

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

getBookmarkedPositionCount

int getBookmarkedPositionCount()

getBookmarkedPositionIndexes

GameIndexAndTrack getBookmarkedPositionIndexes(int i)

Parameters:

i - - index of the bookmark in collection

Returns:

- pair, with game index + gameTrack (as a string)

See Also:

GameTrack.toString(), GameTrack.fromString()

getBookmarkedPositionDescription

java.lang.String getBookmarkedPositionDescription(int i)

Parameters:

i - - index of the bookmark in collection

Returns:

- description for the i-th bookmark

setBookmarkedPositionDescription

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

Update description of given bookmark.

Parameters:

i -

description -

getBookmarkGameTracks

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

Return the 'game tracks' of the bookmarked positions of the given game.

Parameters:

gameIndex -

clearBookmarks

void clearBookmarks()

Remove all bookmarks.

removeBookmark

void removeBookmark(int i)

Remove i'th bookmark.

Parameters:

i -

canClassifyPosition

boolean canClassifyPosition()

classifyPosition

void classifyPosition(int mainType,
                      int subType)