net.sourceforge.chessshell.plugin.api

Interface IPositionSearchIndexer

public interface IPositionSearchIndexer

A helper for optimizing searches on position in game databases. The idea is that by saving some extra supporting information about the games, it will be possible to avoid closer examination of many games.

Method Summary

Modifier and Type	Method and Description
void	addGame(PawnAndPieceCount whitePawnAndPieceCount, PawnAndPieceCount blackPawnAndPieceCount, StartPawnSeries series) Add another game.
void	finishBulkAdding() Finish bulk add mode.
long	getNextGameIndex() Used to iterate through a result set.
void	initializeSearch(PawnAndPieceCount whitePawnAndPieceCount, PawnAndPieceCount blackPawnAndPieceCount, java.util.Set<StartPawn> movedPawns) Call this before iterating through the result set.
boolean	isUpdated()
void	prepareBulkAdding() Switch to bulk add mode.
void	setUpdated(boolean b) Set the updated status.
void	updateGame(long gameIndex, PawnAndPieceCount whitePawnAndPieceCount, PawnAndPieceCount blackPawnAndPieceCount, StartPawnSeries series) Update the information about the given game.

Method Detail

initializeSearch

void initializeSearch(PawnAndPieceCount whitePawnAndPieceCount,
                      PawnAndPieceCount blackPawnAndPieceCount,
                      java.util.Set<StartPawn> movedPawns)
               throws java.io.IOException

Call this before iterating through the result set.

Throws:

java.io.IOException

See Also:

getNextGameIndex()

getNextGameIndex

long getNextGameIndex()
               throws java.io.IOException

Used to iterate through a result set.

Returns:

next game id, or -1 if there is none.

Throws:

java.io.IOException

See Also:

#initializeSearch()

addGame

void addGame(PawnAndPieceCount whitePawnAndPieceCount,
             PawnAndPieceCount blackPawnAndPieceCount,
             StartPawnSeries series)
      throws java.io.IOException

Add another game.

Parameters:

whitePawnAndPieceCount -

blackPawnAndPieceCount -

series -

Throws:

java.io.IOException

updateGame

void updateGame(long gameIndex,
                PawnAndPieceCount whitePawnAndPieceCount,
                PawnAndPieceCount blackPawnAndPieceCount,
                StartPawnSeries series)
         throws java.io.IOException

Update the information about the given game.

Parameters:

gameIndex -

parm -

Throws:

java.io.IOException

isUpdated

boolean isUpdated()

Returns:

true iff it is up to date.

See Also:

setUpdated(boolean)

setUpdated

void setUpdated(boolean b)

Set the updated status.

Parameters:

b -

See Also:

isUpdated()

prepareBulkAdding

void prepareBulkAdding()
                throws java.io.IOException

Switch to bulk add mode.

Throws:

java.io.IOException

See Also:

finishBulkAdding()

finishBulkAdding

void finishBulkAdding()
               throws java.io.IOException

Finish bulk add mode.

Throws:

java.io.IOException

See Also:

prepareBulkAdding()