eve.database

Interface IRemoteSynchronizer

All Known Implementing Classes:

Synchronizer

public interface IRemoteSynchronizer

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTION_SYNCHRONIZE_ALL_ENTRIES An option for getSetOptions() - it specifies that all entries should be considered unsynchronized.

Method Summary

Modifier and Type	Method and Description
void	addEntries(Vector entries) Add entries to the database.
int	countDeletedEntries() Returns the number of deleted entries.
int	countUnsynchronizedEntries()
void	eraseDeleted(int[] indexesToDelete, int offset, int length) Erase the entries at the specified indexes.
void	eraseEntries(long[] oids, int offset, int length) Erases the entries as specified by the OID values.
long[]	getDeletedEntries(int startIndex, int count) Returns an array of OID values for the specified deleted entries.
int	getSetOptions(int optionsToSet, int optionsToClear) This will set the optionsToSet bits and clear the optionsToClear bits and return the state of the options after the operation is done.
Vector	getUnsynchronizedEntries(int startIndex, int count) Return a Vector containing byte[] values for each database entry requested.
void	markAsSynchronized(int[] indexes, int offset, int length) Mark the entries in the unsynchronized list as being synchronized.

Field Detail

OPTION_SYNCHRONIZE_ALL_ENTRIES

static final int OPTION_SYNCHRONIZE_ALL_ENTRIES

An option for getSetOptions() - it specifies that all entries should be considered unsynchronized. Useful when synchronizing a database with a new database.

See Also:

Constant Field Values

Method Detail

getSetOptions

int getSetOptions(int optionsToSet,
                  int optionsToClear)

This will set the optionsToSet bits and clear the optionsToClear bits and return the state of the options after the operation is done.

Parameters:

optionsToSet - any or none of the OPTION_XXX bits OR'ed together.

optionsToClear - any or none of the OPTION_XXX bits OR'ed together.

Returns:

the state of the options after the operation is done.

countUnsynchronizedEntries

int countUnsynchronizedEntries()
                        throws IOException

Throws:

IOException

getUnsynchronizedEntries

Vector getUnsynchronizedEntries(int startIndex,
                                int count)
                         throws IOException

Return a Vector containing byte[] values for each database entry requested. The indexes here are based on the value returned by countUnsynchronizedEntries();

Parameters:

startIndex - the first index in the unsynchronized list to get.

count - the number of database entries to get.

Returns:

a Vector containing a byte[] for each database entry. The DatabaseEntry.decode() method should be used to decode the entry.

Throws:

IOException

markAsSynchronized

void markAsSynchronized(int[] indexes,
                        int offset,
                        int length)
                 throws IOException

Mark the entries in the unsynchronized list as being synchronized.

Parameters:

indexes - the indexes to mark as synchronized.

offset - the start of the indexes in the array.

length - the number of indexes to delete.

Throws:

IOException

addEntries

void addEntries(Vector entries)
         throws IOException

Add entries to the database.

Parameters:

entries - the list of entries, each one of which is a byte[]. Each of these is convereted to a DatabaseEntry using the decode() method.

Throws:

IOException

eraseEntries

void eraseEntries(long[] oids,
                  int offset,
                  int length)
           throws IOException

Erases the entries as specified by the OID values. If an entry does not exist on the database it is ignored.

Parameters:

oids - the list entries to erase.

offset - the start of the OIDs in the array.

length - the number of OIDs to delete.

Throws:

IOException

countDeletedEntries

int countDeletedEntries()
                 throws IOException

Returns the number of deleted entries.

Throws:

IOException

getDeletedEntries

long[] getDeletedEntries(int startIndex,
                         int count)
                  throws IOException

Returns an array of OID values for the specified deleted entries. The index is relative to the value returned by countDeletedEntries().

Parameters:

startIndex - the index of the first deleted entry.

count - the number of deleted entries to get.

Returns:

an array of OID values for each deleted entry.

Throws:

IOException

eraseDeleted

void eraseDeleted(int[] indexesToDelete,
                  int offset,
                  int length)
           throws IOException

Erase the entries at the specified indexes. Note that this should not change the indexes.

Parameters:

indexesToDelete - the list of deleted intries to delete.

offset - the start of the indexes in the array.

length - the number of indexes to delete.

Throws:

IOException