com.aspc.DBObj.Internal

Class DBIndexField

java.lang.Object

com.aspc.DBObj.Internal.DBIndexField

public final class DBIndexField
extends java.lang.Object

The field index. THREAD MODE: MULTI-THREADED shared

Since:

7 April 2008

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
DBField	field field
DBClass	rootClass root class

Method Summary

Modifier and Type	Method and Description
java.lang.String	classKey()
static DBIndexField	find(DBClass dbClass, DBField baseField, VirtualDB layer) Finds the index for this layer/class
VirtualDB	getDataBase()
java.lang.String	getKey()
java.lang.String	getRequiredVersionList()
java.lang.String	getVersionList()
static void	increment(DBField dbField)
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.
void	reload() Reload the index version
static void	reloadIndexes(VirtualDB layer) reload ALL indexes.
static void	reloadIndexes(VirtualDB layer, DBField field) reload ALL indexes.
void	setBad(boolean v) If an index could not be created then set as bad.
static void	storeVersionList(VirtualDB layer, DBClass dbClass, DBField field, java.lang.String targetVersionList)

Methods inherited from class java.lang.Object

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

Field Detail

rootClass

public final DBClass rootClass

root class

field

public final DBField field

field

Method Detail

reloadIndexes

public static void reloadIndexes(@Nonnull
                                 VirtualDB layer)

reload ALL indexes.

Parameters:

layer - the layer.

reloadIndexes

public static void reloadIndexes(@Nonnull
                                 VirtualDB layer,
                                 @Nonnull
                                 DBField field)

reload ALL indexes.

Parameters:

layer - the layer.

field - the field

storeVersionList

public static void storeVersionList(VirtualDB layer,
                                    DBClass dbClass,
                                    DBField field,
                                    java.lang.String targetVersionList)
                             throws java.lang.Exception

Parameters:

dbClass - the class

layer - the layer

field - the field

targetVersionList - the target version

Throws:

java.lang.Exception - a serious problem

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

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 version list

Throws:

java.lang.Exception - a serious problem

getKey

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

Returns:

the key

classKey

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

Returns:

the key

setBad

public void setBad(boolean v)

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

Parameters:

v - true if bad

isBad

@CheckReturnValue
public boolean isBad()

Returns:

if 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:

is dirty

Throws:

java.lang.Exception - a serious problem

increment

public static void increment(@Nonnull
                             DBField dbField)
                      throws java.lang.Exception

Parameters:

dbField - the field

Throws:

java.lang.Exception - a serious problem

find

@Nonnull
 @CheckReturnValue
public static DBIndexField find(@Nonnull
                                                            DBClass dbClass,
                                                            @Nonnull
                                                            DBField baseField,
                                                            @Nonnull
                                                            VirtualDB layer)
                                                     throws java.lang.Exception

Finds the index for this layer/class

Parameters:

baseField - the field

dbClass - the class

layer - the layer

Returns:

the index field

Throws:

java.lang.Exception - a serious problem