com.aspc.DBObj.Internal

Class DBIndex

java.lang.Object

com.aspc.DBObj.Internal.DBIndex

public final class DBIndex
extends java.lang.Object

DBIndex is a THREAD MODE: MULTI-THREADED shared

Since:

23 May 2001, 21:27

Author:

Nigel Leck

Method Summary

Modifier and Type	Method and Description
static DBIndex	create(DBClassConcrete dbClassConcrete, VirtualDB layer)
static DBIndex	find(DBClassConcrete dbClassConcrete, VirtualDB layer) Finds the index for this layer/class
VirtualDB	getDataBase()
java.lang.String	getKey()
java.lang.String	getRequiredVersionList()
DBClassConcrete	getRootClassConcrete()
java.lang.String	getVersionList()
boolean	isBad()
boolean	isDirty() If the layer has any rows for this class and the index is not clean then the index is marked as dirty.
boolean	isDirty(boolean enableIndexer) If the layer has any rows for this class and the index is not clean then the index is marked as dirty.
void	reload() Reload the index version
static void	reloadIndexes(VirtualDB layer) reload ALL indexes.
void	setBad(boolean bad) If an index could not be created then set as bad.
static void	storeVersionList(VirtualDB layer, DBClassConcrete rootClassConcrete, java.lang.String targetVersionList) THREAD MODE: moved the store of the version number into a separate thread to prevent the silent rollback of a transaction if a race condition occurs on the initial insert.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

storeVersionList

public static void storeVersionList(@Nonnull
                                    VirtualDB layer,
                                    @Nonnull
                                    DBClassConcrete rootClassConcrete,
                                    @Nonnull
                                    java.lang.String targetVersionList)
                             throws java.lang.Exception

THREAD MODE: moved the store of the version number into a separate thread to prevent the silent rollback of a transaction if a race condition occurs on the initial insert.

Parameters:

layer - the layer

rootClassConcrete - the root class

targetVersionList - the target version list

Throws:

java.lang.Exception - a serious problem

reloadIndexes

public static void reloadIndexes(@Nonnull
                                 VirtualDB layer)

reload ALL indexes.

Parameters:

layer - the layer.

reload

public void reload()
            throws java.lang.Exception

Reload the index version

Throws:

java.lang.Exception - a serious problem

getDataBase

@CheckReturnValue
 @Nonnull
public VirtualDB getDataBase()

Returns:

the layer

getRootClassConcrete

@CheckReturnValue
 @Nonnull
public DBClassConcrete getRootClassConcrete()

Returns:

the root class

getVersionList

@CheckReturnValue
 @Nonnull
public java.lang.String getVersionList()

Returns:

the version list

getRequiredVersionList

@CheckReturnValue
 @Nonnull
public java.lang.String getRequiredVersionList()
                                                                    throws java.lang.Exception

Returns:

the required list

Throws:

java.lang.Exception - a serious problem

getKey

@CheckReturnValue
 @Nonnull
public java.lang.String getKey()

Returns:

the key

setBad

public void setBad(boolean bad)

If an index could not be created then set as bad. This is caused if the objects we are indexing have validation errors

Parameters:

bad - flag as bad

isBad

@CheckReturnValue
public boolean isBad()

Returns:

is bad

isDirty

@CheckReturnValue
public boolean isDirty()
                                  throws java.lang.Exception

If the layer has any rows for this class and the index is not clean then the index is marked as dirty.

Returns:

true if dirty

Throws:

java.lang.Exception - a serious problem

isDirty

@CheckReturnValue
public boolean isDirty(boolean enableIndexer)
                                  throws java.lang.Exception

If the layer has any rows for this class and the index is not clean then the index is marked as dirty.

Parameters:

enableIndexer - enable the indexer

Returns:

true if dirty

Throws:

java.lang.Exception - a serious problem

create

@CheckReturnValue
 @Nonnull
public static DBIndex create(@Nonnull
                                                         DBClassConcrete dbClassConcrete,
                                                         @Nonnull
                                                         VirtualDB layer)
                                                  throws java.lang.Exception

Parameters:

dbClassConcrete - the class

layer - the layer

Returns:

create the index

Throws:

java.lang.Exception - a serious problem

find

@CheckReturnValue
 @Nonnull
public static DBIndex find(@Nonnull
                                                       DBClassConcrete dbClassConcrete,
                                                       @Nonnull
                                                       VirtualDB layer)
                                                throws java.lang.Exception

Finds the index for this layer/class

Parameters:

dbClassConcrete - the class

layer - the layer

Returns:

the index.

Throws:

java.lang.Exception - a serious problem