VirtualDB (stSoftware API)

java.lang.Object
- com.aspc.DBObj.VirtualDB

All Implemented Interfaces:

DataSource, MemoryHandler
```
@ParametersAreNonnullByDefault
public final class VirtualDB
extends java.lang.Object
implements DataSource, MemoryHandler
```
VirtualDB is a READ ONLY DataSource no access restrictions are applied.

THREAD MODE: MULTI-THREADED

Since:

February 14, 2001, 4:36 PM

Author:

Jason McGrath

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VirtualDB.SignatureValidationResult` http://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_host_names We can't have hyphens either.

Nested classes/interfaces inherited from interface com.aspc.remote.memory.MemoryHandler
MemoryHandler.Cost

Field Summary

Fields
Modifier and Type	Field and Description
`LayerData`	`BLANK_FINAL_LAYER` a common final blank layer
`LayerData`	`BLANK_LAYER` the blank layer
`static int`	`DEFAULT_FIELD_VALUE_STATS_ROWS` the default number of rows if the statistics value is missing and we have less than the max number of statistics entries
`static boolean`	`DISABLE_FIELD_RECYCLER` Is the field recycling disabled ?
`static java.util.concurrent.atomic.AtomicBoolean`	`DISABLE_JMS_FILTER` disabled the JMS filter
`int`	`id` The layer id
`static int`	`MAX_SEGMENT_KEY` The maximum size of a key field that we can grantee to be able to load and decode from the varchar(255) in the index table.
`static int`	`MAX_TRANSACTION_HINT`
`VirtualDB`	`parentDb` The extended layer
`static java.lang.String`	`PROPERTY_DISABLE_FIELD_RECYCLER` The property to disable the field recycling.
`static java.lang.String`	`PROPERTY_DISABLE_JMS_FILTER` The property to disabled the JMS filter.
`TransactionWindow`	`transactionWindow` the transaction window.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDBClassListener(DBClass dbClass, DBClassListener listener)`
`void`	`addDBClassListener(java.lang.String className, DBClassListener listener)` add a listener for any records of this class.
`void`	`buildDB(java.lang.String ownerFirstName, java.lang.String ownerLastName, java.lang.String ownerLogin, java.lang.String ownerPassword, java.lang.String phoneNumber, java.lang.String email)` create a layer
`void`	`checkIndexies()` check the indexes
`void`	`checkLicense()`
`void`	`checkMaxLogin(DBObject login)` Returns the maximum number of concurrent logins allowed for this VirtualDB. We limit the number of concurrent users for commercial reasons.
`static int`	`checkSignature(java.lang.String signature)` Returns a database id by it's signature.
`static void`	`checkSuppressedIssue()`
`void`	`checkSuspended()`
`void`	`clearCache(DBClass dbClass)` When an object is created/deleted/cleared clear all possible full lists.
`java.lang.String`	`clearCachedValueDB(java.lang.String flg)` clear the cache value.
`static void`	`clearDB(int id)` Clears the VirtualDB from the cache.
`void`	`correctEstimateClassRows(DBClass dbClass)` correct the estimates for Class
`int`	`countLogin(DBObject currentLogin)` Returns the number of concurrent users active in this VirtualDB
`DBObject`	`create(DBClass dbClass)` Create always throws a ReadOnlyException.
`DBObject`	`create(GlobalId classGid)` Create always throws a ReadOnlyException.
`DBObject`	`create(java.lang.String className)` Create always throws a ReadOnlyException.
`java.lang.String`	`currentEncryptionCode()` get the current encryption code for all new field values
`java.lang.String`	`decrypt(java.lang.String code, java.lang.String value)` decrypt a value using a decryption code stored in the master DB
`java.lang.String`	`encrypt(java.lang.String code, java.lang.String value)` encrypt a value using a encryption code stored in the master DB
`PossibleRowsHolder`	`fetchFullPR(DBClass dbClass)` Return the full list of objects has been loaded for this class.
`TransHeader`	`fetchTransHeader(long transId)` Fetch the transaction header for this layer and id.
`static VirtualDB`	`find(int id)` Returns a VirtualDB by it's ID.
`static VirtualDB`	`find(java.lang.String signature)` Returns a VirtualDB by it's signature.
`PossibleRowsHolder`	`findCacheClause(DBClass dbClass, DBPathClause pc)` Cache of clauses.
`TransHeader`	`findCreatedTransHeader(long rowId)` find the transaction that created this record.
`DBClass`	`findDBClass(GlobalId classId)` Find the class definition.
`DBClass`	`findDBClass(java.lang.String name)` Find the class definition.
`DBClassAbstract`	`findDBClassAbstract(GlobalId classId)` Find the class definition.
`DBClassAbstract`	`findDBClassAbstract(java.lang.String name)` Find the class definition.
`PossibleRowsHolder`	`findFullPR(DBClass dbClass, boolean lock)` Return the full list of objects for this class.
`DBObject`	`findKey(GlobalId valueId, GlobalId classId)` Finds a DBObject with the GlobalID.
`DBObject`	`findKey(GlobalId id, java.lang.String defName)` Finds a new DBObject by its primary integer key
`DBObject`	`findKey(GlobalKey gKey)` Finds a DBObject for the passed key.
`DBObject`	`findKey(java.lang.String value, java.lang.String defName)` Finds a unique DBObject based on supplied key value
`TransHeader`	`findMaxTransHeader(java.util.Date asOfDate)` Find the maximum transaction for this date.
`static VirtualDB`	`findNoCheck(int id)` Find the layer without checking the version number.
`RecentLink`	`findRecentLink(java.lang.String fieldKey)` Find the recent list for this field.
`DBObject`	`findRow(long rowId, DBClassConcrete dbClass, Hint hint)` Finds a DBObject by it's rowId
`TransHeader`	`findTransHeader(long transId)` Fetch the transaction header for this layer and id.
`TransHeader`	`findTransHeader(long transId, long[] hint)` Find the transaction header for this layer and id.
`void`	`fireObjectCreated(DBData data, Hint hint)` When a new object is created for this VirtualDB and its dependents Clear the "Not Found" cache for this global key Check this object is in the full list Check the searchable fields cache for the current values THREADS: Don't synchronize this method because it calls each child database you can get into a deadlock situation.
`void`	`fireObjectDeleted(DBData data, Hint hint)` When an object is DELETED for this VirtualDB and its dependents Don't do anything, deleted objects will be filtered out later.
`void`	`fireObjectModified(DBData data)` When an object is MODIFIED for this VirtualDB and its dependents Check the searchable fields cache for the current values THREADS: Don't synchronize this method because it calls each child database you can get into a deadlock situation.
`TransHeader`	`forceLoadTransHeader(long transId, long[] hint)`
`long`	`freeMemory(double percentage)` Free memory at this level and below.
`void`	`generateStats()` Generate the statistics
`void`	`generateStats(boolean quick)` Generate the statistics
`void`	`generateStats(boolean quick, java.lang.String classes)` Generate the statistics
`static VirtualDB`	`get(int id)` get the layer if in memory
`Login`	`getAccessLevelLogin(java.lang.String accessLevel)`
`DBCriteria`	`getACLCriteria(Login login, DBClassConcrete dbClass, java.lang.String accessTypeField)` Builds a constraint based on the Access Controls that apply to this login the specified DBClass and the access control type, i.e Read, Modify, etc Access Controls are store by Access Group for each class.
`java.lang.Object`	`getAttribute(java.lang.String name)` Gets a general purpose attribute
`java.lang.String`	`getCachedValueDB(java.lang.String name)`
`java.lang.String`	`getCachedValueDB(java.lang.String name, java.lang.String defaultValue)`
`java.lang.Object`	`getCacheObject(java.lang.String key)` NO USER CACHE FOR THE VIRTUAL DB
`VirtualDB[]`	`getChildren()` Get the children of this VirtualDB.
`MemoryHandler.Cost`	`getCost()` The cost level for this MemoryHandler.
`DataSource`	`getCurrentDataSource()` get the current data source, if from VurtualDB then the thread local version Current login used to store the login used for access controls within this thread This allows checking of objects loaded from VirtualDB with privileges allocated based on a login
`VirtualDB`	`getDataBase()` Fills in the DataSource required method of getting the underlying VirtualDB in this can it's a very simple method.
`DataSource`	`getDataBaseReadOnly()` Fills in the DataSource required method of getting the underlying VirtualDB in this can it's a very simple method.
`java.util.HashMap`	`getDBModuleMap()` return a HashMap of DBModule codes
`java.lang.String`	`getDisplayID()` Returns a IP address style version of the virtualDB's ID
`java.lang.String`	`getDocMgrURL()` The document storage URL for this database.
`long`	`getEstimatedAverageFieldRowsPerValue(DBClass baseClass, DBField dbField)` estimated average rows per field per value
`long`	`getEstimatedClassRows(DBClass dbClass)` The estimated rows for a class
`long`	`getEstimatedFieldRows(DBField dbField, DBClass baseClass, java.lang.String value)` estimated rows for a field/value
`long`	`getEstimatedSize()` The estimated size of data held by this memory handler
`Globals`	`getGlobalObject()` Get the global object Each VirtualDB will have exactly ONE Global DBObject.
`Login`	`getGuestLogin()` Returns the guest or public login for this VirtualDB
`java.lang.String`	`getHexID()` The hex version of the ID
`DBResult`	`getInwardLinkage(DBClass sourceClass, DBField sourceField, DBObject target, HintField hint)` Get the cached DBResult set for the linkage passed If this is an incoming link and the base object is new then don't check the database for records as there will not/should not be any records.
`java.lang.Integer`	`getKey()` The ID of this virtualDB as an object, useful for keys of maps
`long`	`getLastAccessed()` The last time this memory handle was accessed
`LayerField`	`getLayerFieldRecycle(DBField fld, LayerField lf)` Recycle the layer field.
`LayerFieldRecycler`	`getLayerFieldRecycler(DBField fld)` Recycle the layer field.
`java.util.Date`	`getLicenseKeyExpiryDate()`
`Login`	`getLogin()` The login for this DataSource.
`long`	`getMaxStartTransaction()` The maximum transaction number for this layer when the server was started
`Login`	`getOwnerLogin()` Returns the Owner Login for this VirtualDB
`DBQueryHandler`	`getQueryHandler(DBClass searchClass)` makes a Query handler for simple virtual db.
`DataBase`	`getRawDB()` returns the physical WRITE database for this virtualDB
`Login`	`getRealLogin()` The login for this DataSource.
`RootClassHolder`	`getRootHolder(DBClass dbClass)` internal only
`Session`	`getSession()` Get the current session
`java.lang.String`	`getSignature()` Returns one of the signatures for this virtualDB
`java.util.Date`	`getSuspended()`
`static DataSource`	`getThreadDataSource()` get the current data source
`java.util.TimeZone`	`getTimeZone()` Because VirtualDB is not based on a Login, just return GMT time zone.
`Person`	`getUser()` Returns the User for this DataSource. In the case of a VirtualDB it is always NULL.
`MasterDB`	`getWriteMasterDB()` The "write" master DB.
`boolean`	`hasChild(DBClass mapClass, DBField parentField, DBObject parentObject, DBField childField, DBObject childObject)` does this map table contain a mapping for the parent to child.
`boolean`	`hasChildViewedFrom(DBClass mapClass, DBField parentField, DBObject parentObject, DBField childField, DBObject childObject, DataSource viewedFrom)` does this map table contain a mapping for the parent to child.
`boolean`	`hasDBClassListener(DBClass dbClass)` has a listener for records of this class.
`boolean`	`hasExcludedGroups()` are any contacts excluded ?
`void`	`hint(DBClass dbClass, long[] rows)` add to the global hint for this class.
`void`	`hint(DBClass dbClass, PossibleRowsHolder pr)` add to the global hint for this class.
`void`	`hint(java.lang.String className, long row)` add to the global hint for this class.
`void`	`hint(java.lang.String className, long[] rows)` add to the global hint for this class.
`int`	`hintCount(GlobalKeyId rootId)` How many rows are in the hint for this class
`void`	`holdHardCacheLink(DBClass classToHold)` keep a hold on the cache
`boolean`	`isaAcessLevelLogin(Login login)`
`boolean`	`isAncestorOrSelf(int ancestorLayerID)` Is this virtualDB in the family of the passed ID.
`boolean`	`isDescendant(VirtualDB descendantLayer)` Is this Virtual DB viewable from another.
`boolean`	`isExcludeFromGroup(ContactGroup group, Person person)` is the contact excluded from the group.
`boolean`	`isIndexed(DBClass baseClass, DBField field)` Is the index for the passed field reliable ? When a field definition is changed to be searchable or different type or whatever a background task starts to re-index the effected objects until this task finishes the field's index is marked as not reliable.
`boolean`	`isPrivateDB()` Are we using private database ?
`boolean`	`isValueCached(DBClass dbClass, DBField field, java.lang.String searchValue)`
`boolean`	`isValueCached(java.lang.String dbClassName, java.lang.String fieldName, java.lang.String searchValue)`
`java.util.Date`	`lastBackedUp()` When was this layer last backed up.
`static VirtualDB[]`	`listInMemoryLayers()` list of in memory Layers
`void`	`loadStats()` load the previously generated statistics
`void`	`loadStatsIfRequired()`
`TransHeader`	`loadTransHeader(long transId, long[] hint)` Find the transaction header for this layer and id.
`javax.crypto.Cipher`	`makeCipher(java.lang.String code, int mode)`
`DataLoader`	`makeDataResult(GlobalKeyId rootDBClassId, long[] rowsToLoad)` The data loader for this datasource
`DALQuery`	`makeQuery(java.lang.String className)`
`long[]`	`makeRowsToLoad(GlobalKeyId rootId, long rowId, Hint hint)` make the row list to load from the database.
`java.lang.String`	`makeTable(DBClass dbClass, java.lang.String tablePrefix)` make a table for this class.
`boolean`	`needToLoad(GlobalKeyId rootId)` need to load this class
`boolean`	`needToLoad(GlobalKeyId rootId, long checkRow, HashLongMap globalHintMap, long transactionNr)` Do we need to load this record ?
`long`	`nextNumber(java.lang.String key)` A dummy nextNumber always returns zero.
`long`	`nextNumber(java.lang.String key, int cacheSize)` A dummy nextNumber always returns zero.
`long`	`panicFreeMemory()` Clear all memory ASAP.
`void`	`placeRow(boolean createIfMissing, FieldValuesHolder values, DBClass rootClass, DBField field, java.lang.Object rawValue, FieldCacheHolderTracker tracker, long rowUID, boolean maxCheck)` internal use only.
`long`	`queuedFreeMemory(double percentage)` This method should implement the freeing of the method and maybe synchronized.
`void`	`reIndex(java.lang.String classes, java.lang.String excludeClasses)`
`void`	`releaseHardCacheLink(DBClass classToHold)` release a hold on the cache
`void`	`removeDBClassListener(DBClass dbClass, DBClassListener listener)` remove a listener for records of this class.
`void`	`reset()` reset the cache document manager cache.
`void`	`setCachedValueDB(java.lang.String flg, java.lang.String value)` set the cache value in the database
`void`	`setCacheObject(java.lang.String key, java.lang.Object obj)` Set the data source's cache
`static DataSource`	`setCurrentDataSource(DataSource ds)` set the current data source
`void`	`setKnownClassRows(DBClass dbClass, long rows)`
`static void`	`simulateHeavyLoad(long sleepMS)` simulate heavy load by sleeping in select spots.
`static void`	`stats(StatsCollector collector)` collect the statistics
`MutableDataSource`	`sudoSystem()` obtain system level access.
`MutableDataSource`	`sudoSystem(DataSource ds)` obtain system level access.
`MutableDataSource`	`sudoSystem(Login realLogin)` obtain system level access.
`long`	`tidyUp()` Tidy up the memory handler
`java.lang.String`	`toString()`
`void`	`transactionKnownToExist(long transId)` This transaction is known to exist
`static VirtualDB.SignatureValidationResult`	`validateSignature(java.lang.String signature, boolean createMode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- id
```
public final int id
```
  The layer id
- parentDb
```
public final VirtualDB parentDb
```
  The extended layer
- transactionWindow
```
public final TransactionWindow transactionWindow
```
  the transaction window.
- BLANK_LAYER
```
public final LayerData BLANK_LAYER
```
  the blank layer
- BLANK_FINAL_LAYER
```
public final LayerData BLANK_FINAL_LAYER
```
  a common final blank layer
- DEFAULT_FIELD_VALUE_STATS_ROWS
```
public static final int DEFAULT_FIELD_VALUE_STATS_ROWS
```
  the default number of rows if the statistics value is missing and we have less than the max number of statistics entries
  
  See Also:
  
  Constant Field Values
- PROPERTY_DISABLE_FIELD_RECYCLER
```
public static final java.lang.String PROPERTY_DISABLE_FIELD_RECYCLER
```
  The property to disable the field recycling.
  
  See Also:
  
  Constant Field Values
- DISABLE_FIELD_RECYCLER
```
public static final boolean DISABLE_FIELD_RECYCLER
```
  Is the field recycling disabled ?
- DISABLE_JMS_FILTER
```
public static final java.util.concurrent.atomic.AtomicBoolean DISABLE_JMS_FILTER
```
  disabled the JMS filter
- PROPERTY_DISABLE_JMS_FILTER
```
public static final java.lang.String PROPERTY_DISABLE_JMS_FILTER
```
  The property to disabled the JMS filter.
  
  See Also:
  
  Constant Field Values
- MAX_TRANSACTION_HINT
```
public static final int MAX_TRANSACTION_HINT
```
  See Also:
  
  Constant Field Values
- MAX_SEGMENT_KEY
```
public static final int MAX_SEGMENT_KEY
```
  The maximum size of a key field that we can grantee to be able to load and decode from the varchar(255) in the index table. 42= 255 chars div 6 chars for encoded Euro = #20AC;
  
  See Also:
  
  Constant Field Values

Method Detail

checkSuppressedIssue

public static void checkSuppressedIssue()
                                 throws java.lang.Exception

Throws:: java.lang.Exception

simulateHeavyLoad
```
public static void simulateHeavyLoad(@Nonnegative
                                     long sleepMS)
```
simulate heavy load by sleeping in select spots.

Parameters:

sleepMS - number of milliseconds to sleep

validateSignature

@Nonnull
public static VirtualDB.SignatureValidationResult validateSignature(@Nonnull
                                                                             java.lang.String signature,
                                                                             boolean createMode)

Parameters:: signature - the signature to check.; createMode - check if already exists.
Returns:: the validation result.

listInMemoryLayers

@CheckReturnValue
 @Nonnull
public static VirtualDB[] listInMemoryLayers()

list of in memory Layers

Returns:: the layers.

stats

public static void stats(@Nonnull
                         StatsCollector collector)

collect the statistics

Parameters:: collector - the collector

getLayerFieldRecycler

@CheckReturnValue
 @Nullable
public LayerFieldRecycler getLayerFieldRecycler(@Nonnull
                                                                             DBField fld)

Recycle the layer field.

Parameters:: fld - the field
Returns:: The recycled field layer.

getLayerFieldRecycle

@CheckReturnValue
 @Nonnull
public LayerField getLayerFieldRecycle(@Nonnull
                                                                   DBField fld,
                                                                   @Nonnull
                                                                   LayerField lf)

Recycle the layer field.

Parameters:: fld - the field; lf - the layer field.
Returns:: The recycled field layer.

isExcludeFromGroup

@CheckReturnValue
public boolean isExcludeFromGroup(@Nonnull
                                                    ContactGroup group,
                                                    @Nonnull
                                                    Person person)

is the contact excluded from the group.

Specified by:: isExcludeFromGroup in interface DataSource
Parameters:: person - the person to check.; group - the group to check if the contact is excluded.
Returns:: true if excluded.

hasExcludedGroups
```
@CheckReturnValue
public boolean hasExcludedGroups()
```
are any contacts excluded ?

Specified by:

hasExcludedGroups in interface DataSource

Returns:

true if any contacts are excluded.

isIndexed
```
@CheckReturnValue
public boolean isIndexed(@Nonnull
                                           DBClass baseClass,
                                           @Nonnull
                                           DBField field)
```
Is the index for the passed field reliable ? When a field definition is changed to be
searchable or different type or whatever a background task starts to re-index the effected objects
until this task finishes the field's index is marked as not reliable.

Parameters:

baseClass - the base class.

field - The field's index to check.

Returns:

True if the field's index is OK.

hasChild

@CheckReturnValue
public boolean hasChild(DBClass mapClass,
                                          DBField parentField,
                                          DBObject parentObject,
                                          DBField childField,
                                          DBObject childObject)
                                   throws java.lang.Exception

does this map table contain a mapping for the parent to child.

Specified by:: hasChild in interface DataSource
Parameters:: mapClass - The map class; parentField - the parent link; parentObject - the parent object; childField - the child link; childObject - the child object
Returns:: TRUE if a mapping found
Throws:: java.lang.Exception - a serious problem

hasChildViewedFrom

@CheckReturnValue
public boolean hasChildViewedFrom(DBClass mapClass,
                                                    DBField parentField,
                                                    DBObject parentObject,
                                                    @Nonnull
                                                    DBField childField,
                                                    @Nonnull
                                                    DBObject childObject,
                                                    DataSource viewedFrom)
                                             throws java.lang.Exception

does this map table contain a mapping for the parent to child.

Parameters:: viewedFrom - layer that it's viewed from; mapClass - The map class; parentField - the parent link; parentObject - the parent object; childField - the child link; childObject - the child object
Returns:: TRUE if a mapping found
Throws:: java.lang.Exception - a serious problem

getCurrentDataSource
```
@CheckReturnValue
 @Nonnull
public DataSource getCurrentDataSource()
```
get the current data source, if from VurtualDB then the thread local version Current login used to store the login used for access controls within this thread This allows checking of objects loaded from VirtualDB with privileges allocated based on a login

Specified by:

getCurrentDataSource in interface DataSource

Returns:

the current data source

setCurrentDataSource

@Nullable
public static DataSource setCurrentDataSource(@Nullable
                                                        DataSource ds)

set the current data source

Parameters:: ds - the database
Returns:: the original data source

getThreadDataSource

@CheckReturnValue
 @Nullable
public static DataSource getThreadDataSource()

get the current data source

Returns:: the original data source

decrypt

@CheckReturnValue
 @Nonnull
public java.lang.String decrypt(@Nonnull
                                                            java.lang.String code,
                                                            @Nonnull
                                                            java.lang.String value)
                                                     throws java.lang.Exception

decrypt a value using a decryption code stored in the master DB

Parameters:: code - The master DB decryption code.; value - the value to decrypt
Returns:: the decrypted value
Throws:: java.lang.Exception - a serious problem

makeCipher

@CheckReturnValue
 @Nonnull
public javax.crypto.Cipher makeCipher(@Nonnull
                                                                  java.lang.String code,
                                                                  int mode)
                                                           throws java.lang.Exception

Parameters:: code -; mode -
Returns:: the value
Throws:: java.lang.Exception - A serious problem

encrypt

@CheckReturnValue
 @Nonnull
public java.lang.String encrypt(@Nonnull
                                                            java.lang.String code,
                                                            @Nonnull
                                                            java.lang.String value)
                                                     throws java.lang.Exception

encrypt a value using a encryption code stored in the master DB

Parameters:: code - The master DB encryption code.; value - the value to encrypt
Returns:: the encrypted value
Throws:: java.lang.Exception - a serious problem

currentEncryptionCode

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

get the current encryption code for all new field values

Returns:: the encryption code
Throws:: java.lang.Exception - a serious problem

getSession
```
@CheckReturnValue
 @Nullable
public Session getSession()
```
Get the current session

Specified by:

getSession in interface DataSource

Returns:

The session

lastBackedUp

@CheckReturnValue
 @Nullable
public java.util.Date lastBackedUp()
                                                         throws java.lang.Exception

When was this layer last backed up.

Returns:: the date last backed up.
Throws:: java.lang.Exception - a error occurred.

findMaxTransHeader

@CheckReturnValue
 @Nonnull
public TransHeader findMaxTransHeader(@Nonnull
                                                                  java.util.Date asOfDate)
                                                           throws java.lang.Exception

Find the maximum transaction for this date.

Parameters:: asOfDate - The date to check
Returns:: The maximum transaction
Throws:: java.lang.Exception - A serious problem

fetchTransHeader
```
@CheckReturnValue
 @Nullable
public TransHeader fetchTransHeader(long transId)
                                                          throws NotFoundException
```
Fetch the transaction header for this layer and id.

Parameters:

transId - The transaction to find

Returns:

the transaction header or null if not loaded yet

Throws:

NotFoundException - The transaction was not found

findCreatedTransHeader

@CheckReturnValue
 @Nonnull
public TransHeader findCreatedTransHeader(long rowId)
                                                               throws NotFoundException,
                                                                      java.sql.SQLException

find the transaction that created this record.

Parameters:: rowId - the row to find
Returns:: the transaction
Throws:: NotFoundException - the transaction was not found.; java.sql.SQLException

findTransHeader
```
@CheckReturnValue
 @Nonnull
public TransHeader findTransHeader(long transId)
                                                        throws NotFoundException
```
Fetch the transaction header for this layer and id.

Parameters:

transId - The transaction id to fetch

Returns:

the transaction header or null if not loaded yet

Throws:

NotFoundException - The transaction number was not found

See Also:

loadTransHeader

loadTransHeader
```
@CheckReturnValue
 @Nonnull
public TransHeader loadTransHeader(long transId,
                                                               long[] hint)
                                                        throws NotFoundException
```
Find the transaction header for this layer and id. if cached as not found then retry to select

Parameters:

hint - what other rows should be loaded.

transId - the transaction id

Returns:

the transaction header.

Throws:

NotFoundException - The transaction could not be found.

forceLoadTransHeader

@CheckReturnValue
 @Nonnull
public TransHeader forceLoadTransHeader(long transId,
                                                                    long[] hint)
                                                             throws NotFoundException

Throws:: NotFoundException

transactionKnownToExist
```
public void transactionKnownToExist(long transId)
```
This transaction is known to exist

Parameters:

transId - the transId

findTransHeader

@CheckReturnValue
 @Nonnull
public TransHeader findTransHeader(long transId,
                                                               @Nullable
                                                               long[] hint)
                                                        throws NotFoundException

Find the transaction header for this layer and id.

Parameters:: hint - what other rows should be loaded.; transId - the transaction id
Returns:: the transaction header.
Throws:: NotFoundException - The transaction could not be found.
See Also:: loadTransHeader

makeQuery

@CheckReturnValue
 @Nonnull
public DALQuery makeQuery(java.lang.String className)

isaAcessLevelLogin

@CheckReturnValue
public boolean isaAcessLevelLogin(@Nonnull
                                                    Login login)

getACLCriteria

@CheckReturnValue
 @Nonnull
public DBCriteria getACLCriteria(@Nonnull
                                                             Login login,
                                                             @Nonnull
                                                             DBClassConcrete dbClass,
                                                             @Nonnull
                                                             java.lang.String accessTypeField)
                                                      throws java.lang.Exception

Builds a constraint based on the Access Controls that apply to this login the specified DBClass and the access control type, i.e Read, Modify, etc Access Controls are store by Access Group for each class. Since a login can be assigned to multiple Access Groups we need to determine the access controls for each group.

Parameters:: login - the user login; dbClass - the base class; accessTypeField -
Returns:: the value
Throws:: java.lang.Exception - A serious problem

correctEstimateClassRows

public void correctEstimateClassRows(@Nonnull
                                     DBClass dbClass)
                              throws java.lang.Exception

correct the estimates for Class

Parameters:: dbClass - the class
Throws:: java.lang.Exception - a serious problem

setKnownClassRows

public void setKnownClassRows(@Nullable
                              DBClass dbClass,
                              @Nonnegative
                              long rows)
                       throws java.lang.Exception

Throws:: java.lang.Exception

getEstimatedClassRows

@CheckReturnValue
 @Nonnegative
public long getEstimatedClassRows(@Nullable
                                                                  DBClass dbClass)

The estimated rows for a class

Parameters:: dbClass - the class to estimate
Returns:: the estimated rows

getEstimatedAverageFieldRowsPerValue

@CheckReturnValue
 @Nonnegative
public long getEstimatedAverageFieldRowsPerValue(@Nonnull
                                                                                 DBClass baseClass,
                                                                                 @Nonnull
                                                                                 DBField dbField)

estimated average rows per field per value

Parameters:: baseClass - the base class; dbField - the base field
Returns:: the estimated rows

getEstimatedFieldRows

@CheckReturnValue
 @Nonnegative
public long getEstimatedFieldRows(@Nonnull
                                                                  DBField dbField,
                                                                  @Nonnull
                                                                  DBClass baseClass,
                                                                  @Nullable
                                                                  java.lang.String value)

estimated rows for a field/value

Parameters:: value - the value to estimate; baseClass - the base class; dbField - the base field
Returns:: the estimated rows

generateStats
```
public void generateStats()
                   throws java.lang.Exception
```
Generate the statistics

Throws:

java.lang.Exception - a serious problem

generateStats
```
public void generateStats(boolean quick)
                   throws java.lang.Exception
```
Generate the statistics

Parameters:

quick - quickly generate statistics that don't exist.

Throws:

java.lang.Exception - a serious problem

generateStats
```
public void generateStats(boolean quick,
                          @Nullable
                          java.lang.String classes)
                   throws java.lang.Exception
```
Generate the statistics

Parameters:

quick - quickly generate statistics that don't exist.

classes - the limited set of classes to scan.

Throws:

java.lang.Exception - a serious problem

loadStatsIfRequired

public void loadStatsIfRequired()
                         throws java.lang.Exception

Throws:: java.lang.Exception

loadStats
```
public void loadStats()
               throws java.lang.Exception
```
load the previously generated statistics

Throws:

java.lang.Exception - a serious problem.

getDataBase
```
@CheckReturnValue
 @Nonnull
public VirtualDB getDataBase()
```
Fills in the DataSource required method of getting the underlying VirtualDB
in this can it's a very simple method. It just returns itself.

Specified by:

getDataBase in interface DataSource

Returns:

This virtualDB

getDataBaseReadOnly
```
@CheckReturnValue
 @Nonnull
public DataSource getDataBaseReadOnly()
```
Fills in the DataSource required method of getting the underlying VirtualDB
in this can it's a very simple method. It just returns itself.

Specified by:

getDataBaseReadOnly in interface DataSource

Returns:

This virtualDB

getLogin
```
@CheckReturnValue
 @Nonnull
public Login getLogin()
```
The login for this DataSource.

Specified by:

getLogin in interface DataSource

Returns:

null

getRealLogin
```
@CheckReturnValue
 @Nonnull
public Login getRealLogin()
```
The login for this DataSource.

Specified by:

getRealLogin in interface DataSource

Returns:

null

getUser
```
@CheckReturnValue
 @Nullable
public Person getUser()
```
Returns the User for this DataSource. In the case of a VirtualDB it is always NULL. ( causes a stack overflow otherwise)

Specified by:

getUser in interface DataSource

Returns:

The user.

getTimeZone
```
@CheckReturnValue
 @Nonnull
public java.util.TimeZone getTimeZone()
```
Because VirtualDB is not based on a Login, just return GMT time zone.

Specified by:

getTimeZone in interface DataSource

Returns:

GMT timeZone

getGlobalObject
```
@CheckReturnValue
 @Nonnull
public Globals getGlobalObject()
                                                    throws java.lang.Exception
```
Get the global object Each VirtualDB will have exactly ONE Global DBObject.

Specified by:

getGlobalObject in interface DataSource

Returns:

The Global DBObject

Throws:

java.lang.Exception - A serious problem occurred.

getDBModuleMap
```
@CheckReturnValue
 @Nonnull
public java.util.HashMap getDBModuleMap()
```
return a HashMap of DBModule codes

Returns:

List of DBModules

checkMaxLogin
```
public void checkMaxLogin(@Nonnull
                          DBObject login)
                   throws java.lang.Exception
```
Returns the maximum number of concurrent logins allowed for this VirtualDB.
We limit the number of concurrent users for commercial reasons.

Parameters:

login - Omit this login from the count ( because it's the one that is trying to login)

Throws:

java.lang.Exception - Too many concurrent users for this VirtualDB

countLogin

@CheckReturnValue
public int countLogin(@Nullable
                                        DBObject currentLogin)
                                 throws java.lang.Exception

Returns the number of concurrent users active in this VirtualDB

Parameters:: currentLogin - Omit the current Login
Returns:: The total count
Throws:: java.lang.Exception - A serious problem occurred

sudoSystem
```
@CheckReturnValue
 @Nonnull
public MutableDataSource sudoSystem()
```
obtain system level access.

Returns:

A mutableDataSource with system level access.

sudoSystem

@CheckReturnValue
 @Nonnull
public MutableDataSource sudoSystem(@Nullable
                                                                DataSource ds)

obtain system level access.

Parameters:: ds - the data source to obtain the login/timezone
Returns:: A mutableDataSource with system level access.

sudoSystem

@CheckReturnValue
 @Nonnull
public MutableDataSource sudoSystem(@Nonnull
                                                                Login realLogin)

obtain system level access.

Parameters:: realLogin - the real login
Returns:: A mutableDataSource with system level access.

getOwnerLogin
```
@CheckReturnValue
 @Nullable
public Login getOwnerLogin()
```
Returns the Owner Login for this VirtualDB

Returns:

The Owner Login

getAccessLevelLogin

@CheckReturnValue
 @Nonnull
public Login getAccessLevelLogin(@Nonnull
                                                             java.lang.String accessLevel)

getWriteMasterDB
```
@CheckReturnValue
 @Nonnull
public MasterDB getWriteMasterDB()
```
The "write" master DB. In a slave mode write and read masters may be different

Returns:

The master DB version for write.

getDocMgrURL

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

The document storage URL for this database.

Returns:: The URL
Throws:: java.lang.Exception - A serious problem

getGuestLogin
```
@CheckReturnValue
 @Nonnull
public Login getGuestLogin()
```
Returns the guest or public login for this VirtualDB

Returns:

The public login

create
```
@CheckReturnValue
 @Nonnull
public DBObject create(@Nonnull
                                                   java.lang.String className)
                                            throws java.lang.Exception
```
Create always throws a ReadOnlyException. Use MutableDataSource instead.

Specified by:

create in interface DataSource

Parameters:

className - The class to be created

Returns:

never returns

Throws:

java.lang.Exception - Read Only Exception

create

@CheckReturnValue
 @Nonnull
public DBObject create(@Nonnull
                                                   DBClass dbClass)
                                            throws java.lang.Exception

Create always throws a ReadOnlyException. Use MutableDataSource instead.

Specified by:: create in interface DataSource
Parameters:: dbClass - The class to be created
Returns:: never returns
Throws:: java.lang.Exception - Read Only Exception

create

@CheckReturnValue
 @Nonnull
public DBObject create(@Nonnull
                                                   GlobalId classGid)
                                            throws java.lang.Exception

Create always throws a ReadOnlyException. Use MutableDataSource instead.

Specified by:: create in interface DataSource
Parameters:: classGid - The class to be created
Returns:: never returns
Throws:: java.lang.Exception - Read Only Exception

findDBClassAbstract

@CheckReturnValue
 @Nonnull
public DBClassAbstract findDBClassAbstract(@Nonnull
                                                                       GlobalId classId)
                                                                throws NotFoundException

Find the class definition.

Specified by:: findDBClassAbstract in interface DataSource
Parameters:: classId - The class to find
Returns:: The class definition
Throws:: NotFoundException - The class wasn't found

findDBClass

@CheckReturnValue
 @Nonnull
public DBClass findDBClass(@Nonnull
                                                       GlobalId classId)
                                                throws NotFoundException

Find the class definition.

Specified by:: findDBClass in interface DataSource
Parameters:: classId - The class to find
Returns:: The class definition
Throws:: NotFoundException - The class wasn't found

findDBClassAbstract

@CheckReturnValue
 @Nonnull
public DBClassAbstract findDBClassAbstract(@Nonnull
                                                                       java.lang.String name)
                                                                throws NotFoundException

Find the class definition.

Specified by:: findDBClassAbstract in interface DataSource
Parameters:: name - The class to find
Returns:: The class definition
Throws:: NotFoundException - The class wasn't found

findDBClass

@CheckReturnValue
 @Nonnull
public DBClass findDBClass(@Nonnull
                                                       java.lang.String name)
                                                throws NotFoundException

Find the class definition.

Specified by:: findDBClass in interface DataSource
Parameters:: name - The class to find
Returns:: The class definition
Throws:: NotFoundException - The class wasn't found

findRow

@CheckReturnValue
 @Nonnull
public DBObject findRow(long rowId,
                                                    @Nonnull
                                                    DBClassConcrete dbClass,
                                                    Hint hint)
                                             throws NotFoundException

Finds a DBObject by it's rowId

Specified by:: findRow in interface DataSource
Parameters:: rowId - The row id to find; dbClass - The class for this row; hint - If we are to fetch this row id from the DB also check these row IDs
Returns:: The DBObject
Throws:: NotFoundException - The row wasn't found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    GlobalId id,
                                                    @Nonnull
                                                    java.lang.String defName)
                                             throws NotFoundException

Finds a new DBObject by its primary integer key

Specified by:: findKey in interface DataSource
Parameters:: id - The id; defName - The Class name
Returns:: The found object
Throws:: NotFoundException - The DBObject was not found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    GlobalId valueId,
                                                    @Nonnull
                                                    GlobalId classId)
                                             throws NotFoundException

Finds a DBObject with the GlobalID.

Specified by:: findKey in interface DataSource
Parameters:: valueId - The value ID ( first half of a global key); classId - The class ID ( second half of a global key)
Returns:: The DBObject
Throws:: NotFoundException - The key wasn't found

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    GlobalKey gKey)
                                             throws NotFoundException

Finds a DBObject for the passed key.

Specified by:: findKey in interface DataSource
Parameters:: gKey - The Global key
Returns:: The found DBObject
Throws:: NotFoundException - The global key wasn't found.

findKey

@CheckReturnValue
 @Nonnull
public DBObject findKey(@Nonnull
                                                    java.lang.String value,
                                                    @Nonnull
                                                    java.lang.String defName)
                                             throws NotFoundException,
                                                    TooManyRowsException,
                                                    java.lang.Exception

Finds a unique DBObject based on supplied key value

Specified by:: findKey in interface DataSource
Parameters:: value - The value to find; defName - The class name
Returns:: The found object
Throws:: java.lang.Exception - a serious problem; NotFoundException - The key was not found; TooManyRowsException - The key was not found

needToLoad

@CheckReturnValue
 @Nonnull
public boolean needToLoad(@Nonnull
                                                      GlobalKeyId rootId)

need to load this class

Parameters:: rootId - root class
Returns:: true if we nee to load.

nextNumber
```
@CheckReturnValue
public long nextNumber(@Nonnull
                                         java.lang.String key,
                                         int cacheSize)
```
A dummy nextNumber always returns zero.

Specified by:

nextNumber in interface DataSource

Parameters:

key - The next number key.

cacheSize - The cache size of the numbers

Returns:

ZERO

nextNumber
```
@CheckReturnValue
public long nextNumber(@Nonnull
                                         java.lang.String key)
```
A dummy nextNumber always returns zero.

Specified by:

nextNumber in interface DataSource

Parameters:

key - The next number key.

Returns:

ZERO

find

@CheckReturnValue
 @Nonnull
public static VirtualDB find(@Nonnull
                                                         java.lang.String signature)
                                                  throws VirtualDBNotFoundException,
                                                         DBVersionException,
                                                         VirtualDBExpiredException

Returns a VirtualDB by it's signature.

Thread Safe:

This method doesn't need to be synchronized as two parallel threads
on the first attempt will only result in SELECTING the ID twice

Parameters:: signature - The name of the virtualDB to find.
Returns:: The matching VirtualDB
Throws:: VirtualDBExpiredException - The layer has expired; DBVersionException - The database is the wrong version.; VirtualDBNotFoundException - The virtualDB was not found

checkSignature

@CheckReturnValue
public static int checkSignature(@Nullable
                                                   java.lang.String signature)
                                            throws VirtualDBNotFoundException

Returns a database id by it's signature.

Thread Safe:

This method doesn't need to be synchronized as two parallel threads
on the first attempt will only result in SELECTING the ID twice

Parameters:: signature - The name of the virtualDB to find.
Returns:: The database id of the VirtualDB
Throws:: VirtualDBNotFoundException - The virtualDB was not found

find

@CheckReturnValue
 @Nonnull
public static VirtualDB find(int id)
                                                  throws VirtualDBNotFoundException,
                                                         DBVersionException,
                                                         VirtualDBExpiredException

Returns a VirtualDB by it's ID.

Thread Safe:

We rely that we only ever have one V-irtualDB for an ID in memory.
We do a DCL (Double Check Lock) but we use a HashTable to give us the
synchronization we require.

Parameters:: id - The id of the VirtualDB
Returns:: The matching VirtualDB
Throws:: VirtualDBExpiredException - The layer has expired; DBVersionException - The database is an out of date version.; VirtualDBNotFoundException - The id is invalid.

findNoCheck

@CheckReturnValue
 @Nonnull
public static VirtualDB findNoCheck(int id)
                                                         throws VirtualDBNotFoundException

Find the layer without checking the version number.

Parameters:: id - The layer id.
Returns:: The layer.
Throws:: VirtualDBNotFoundException - Could not find the layer.

get
```
@CheckReturnValue
 @Nullable
public static VirtualDB get(int id)
```
get the layer if in memory

Parameters:

id - The layer id.

Returns:

The layer.

fireObjectCreated
```
public void fireObjectCreated(@Nonnull
                              DBData data,
                              @Nullable
                              Hint hint)
```
When a new object is created for this VirtualDB and its dependents
- Clear the "Not Found" cache for this global key
- Check this object is in the full list
- Check the searchable fields cache for the current values
THREADS: Don't synchronize this method because it calls each child database you can get into a deadlock situation.
Parameters:

data - The raw data for the record that has been created ( first load)

hint - What other records will be checked.

fireObjectModified
```
public void fireObjectModified(@Nonnull
                               DBData data)
```
When an object is MODIFIED for this VirtualDB and its dependents
- Check the searchable fields cache for the current values
THREADS: Don't synchronize this method because it calls each child database you can get into a deadlock situation.
Parameters:

data - The raw data for the record that has been created ( first load)

placeRow

public void placeRow(boolean createIfMissing,
                     FieldValuesHolder values,
                     DBClass rootClass,
                     DBField field,
                     java.lang.Object rawValue,
                     FieldCacheHolderTracker tracker,
                     long rowUID,
                     boolean maxCheck)
              throws java.lang.Exception

internal use only.

Parameters:: createIfMissing - create the row if missing.; values - The values.; rootClass - the root class.; field - The field; rawValue - the value; tracker - the list of new holders.; rowUID - the row UID.; maxCheck - check max
Throws:: java.lang.Exception - a exception

fireObjectDeleted
```
public void fireObjectDeleted(@Nonnull
                              DBData data,
                              Hint hint)
```
When an object is DELETED for this VirtualDB and its dependents
- Don't do anything, deleted objects will be filtered out later.
Parameters:

data - The raw data for the record that has been created ( first load)

hint - What other records will be checked.

fetchFullPR
```
public PossibleRowsHolder fetchFullPR(@Nonnull
                                      DBClass dbClass)
```
Return the full list of objects has been loaded for this class. This maybe used in queries
where there are no keyed criteria to use.

Parameters:

dbClass - The full list for this class

Returns:

The full list is loaded

findFullPR

@CheckReturnValue
 @Nonnull
public PossibleRowsHolder findFullPR(@Nonnull
                                                                 DBClass dbClass,
                                                                 boolean lock)
                                                          throws java.lang.Exception

Return the full list of objects for this class. Fetch them if that aren't loaded.

Thread Safe:

We store an Object array after putting the array into a table
Select if the first element is null. Two parallel threads on the
first pass would just cause the list to be load twice.

Parameters:: lock - should we lock the list?; dbClass - The class to get the full list.
Returns:: The full list of row IDs
Throws:: java.lang.Exception - A serious problem

holdHardCacheLink

public void holdHardCacheLink(@Nonnull
                              DBClass classToHold)
                       throws java.lang.Exception

keep a hold on the cache

Parameters:: classToHold - The class to hold
Throws:: java.lang.Exception - a serious problem

releaseHardCacheLink

public void releaseHardCacheLink(@Nonnull
                                 DBClass classToHold)
                          throws java.lang.Exception

release a hold on the cache

Parameters:: classToHold - The class to hold
Throws:: java.lang.Exception - a serious problem

getRootHolder

public RootClassHolder getRootHolder(@Nonnull
                                     DBClass dbClass)
                              throws java.lang.InterruptedException

internal only

Parameters:: dbClass - The class.
Returns:: The holder
Throws:: java.lang.InterruptedException

isValueCached

public boolean isValueCached(@Nonnull
                             java.lang.String dbClassName,
                             @Nonnull
                             java.lang.String fieldName,
                             @Nonnull
                             java.lang.String searchValue)
                      throws java.lang.InterruptedException

Parameters:: dbClassName -; fieldName -; searchValue -
Returns:: the value
Throws:: java.lang.InterruptedException

isValueCached

@CheckReturnValue
public boolean isValueCached(@Nonnull
                                               DBClass dbClass,
                                               @Nonnull
                                               DBField field,
                                               @Nonnull
                                               java.lang.String searchValue)
                                        throws java.lang.InterruptedException

Parameters:: dbClass - the class; field - The field; searchValue -
Returns:: the value
Throws:: java.lang.InterruptedException - was interrupted.

findCacheClause

@CheckReturnValue
 @Nonnull
public PossibleRowsHolder findCacheClause(@Nonnull
                                                                      DBClass dbClass,
                                                                      @Nonnull
                                                                      DBPathClause pc)
                                                               throws java.lang.Exception

Cache of clauses. Why is it thread safe ? see above.

Parameters:: dbClass - the class; pc - the clause
Returns:: the list of rows.
Throws:: java.lang.Exception - a serious problem

getKey
```
@CheckReturnValue
 @Nonnull
public java.lang.Integer getKey()
```
The ID of this virtualDB as an object, useful for keys of maps

Returns:

The ID as an object

getRawDB
```
@CheckReturnValue
 @Nonnull
public DataBase getRawDB()
```
returns the physical WRITE database for this virtualDB

Returns:

The physical DB

getHexID

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

The hex version of the ID

Returns:: The hex ID

getSignature
```
@CheckReturnValue
 @Nonnull
public java.lang.String getSignature()
```
Returns one of the signatures for this virtualDB

Returns:

The signature

toString
```
@CheckReturnValue
 @Nonnull
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Returns:

the value

getDisplayID
```
@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayID()
```
Returns a IP address style version of the virtualDB's ID

Returns:

The ID in a form of 192.192.173.227

buildDB

public void buildDB(java.lang.String ownerFirstName,
                    java.lang.String ownerLastName,
                    java.lang.String ownerLogin,
                    java.lang.String ownerPassword,
                    java.lang.String phoneNumber,
                    java.lang.String email)
             throws java.lang.Exception

create a layer

Parameters:: ownerFirstName - first name; ownerLastName - last name; ownerLogin - login; ownerPassword - password; phoneNumber - phone number; email - email
Throws:: java.lang.Exception - a serious problem.

getMaxStartTransaction
```
@CheckReturnValue
public long getMaxStartTransaction()
```
The maximum transaction number for this layer when the server was started

Returns:

The maximum transaction

getInwardLinkage

@CheckReturnValue
 @Nonnull
public DBResult getInwardLinkage(@Nonnull
                                                             DBClass sourceClass,
                                                             @Nonnull
                                                             DBField sourceField,
                                                             @Nullable
                                                             DBObject target,
                                                             @Nullable
                                                             HintField hint)
                                                      throws java.lang.Exception

Get the cached DBResult set for the linkage passed

If this is an incoming link and the base object is new
then don't check the database for records as there
will not/should not be any records. If there is then
they are records in error or the base record will have
a duplicate key error when you try to save it.
Thread Safe: See getLinkHolder.

Specified by:: getInwardLinkage in interface DataSource
Parameters:: sourceClass - the source class ( required for fields in interfaces); sourceField - The source field for the link; hint - the other objects that will be searched; target - The target object
Returns:: The result set of linked objects.
Throws:: java.lang.Exception - a serious problem

isDescendant
```
@CheckReturnValue
public boolean isDescendant(@Nonnull
                                              VirtualDB descendantLayer)
```
Is this Virtual DB viewable from another.

engine::design::jasonDB
engine::design
engine::design::nigel

design.isDescendant( jasonDB) TRUE
jasonDB.isDescendant( design) FALSE

Parameters:

descendantLayer - The virtualDB

Returns:

True if viewable by.

isAncestorOrSelf
```
@CheckReturnValue
public boolean isAncestorOrSelf(int ancestorLayerID)
```
Is this virtualDB in the family of the passed ID.

engine::design::jasonDB
engine::design
engine::design::nigelDB

design.isAncestorOrSelf( jasonDB.id) FALSE
jasonDB.isAncestorOrSelf( design.id) TRUE

Parameters:

ancestorLayerID - The virtualDB ID

Returns:

True if in the family

makeDataResult

@CheckReturnValue
 @Nonnull
public DataLoader makeDataResult(GlobalKeyId rootDBClassId,
                                                             long[] rowsToLoad)
                                                      throws java.lang.Exception

The data loader for this datasource

Parameters:: rootDBClassId -; rowsToLoad -
Returns:: The results
Throws:: java.lang.Exception - a serious problem.

hint
```
public void hint(@Nonnull
                 java.lang.String className,
                 long[] rows)
```
add to the global hint for this class.

Parameters:

className - the class to add the hint for

rows - the hint of rows to load

hint
```
public void hint(@Nonnull
                 java.lang.String className,
                 long row)
```
add to the global hint for this class.

Parameters:

className - the class to add the hint for

row - the hint of row to load

hint

public void hint(@Nonnull
                 DBClass dbClass,
                 @Nullable
                 PossibleRowsHolder pr)

add to the global hint for this class.

Parameters:: dbClass - the class to add the hint for; pr - possible rows

hint

public void hint(@Nonnull
                 DBClass dbClass,
                 @Nullable
                 long[] rows)

add to the global hint for this class.

Parameters:: dbClass - the class to add the hint for; rows - the hint of rows to load

hintCount

@CheckReturnValue
public int hintCount(@Nonnull
                                       GlobalKeyId rootId)

How many rows are in the hint for this class

Parameters:: rootId - the root class id
Returns:: the count.

makeRowsToLoad
```
@CheckReturnValue
 @Nonnull
public long[] makeRowsToLoad(@Nonnull
                                                         GlobalKeyId rootId,
                                                         long rowId,
                                                         @Nullable
                                                         Hint hint)
```
make the row list to load from the database. Now that we are about to hit the database make sure we load the record that was asked for and if a hint has been passed in ( normally from DBResult) then check each of these rows in the hint passed in to see if the row is already in memory if not then also load these at the same time. A single SQL can load up to 100 records at one time. If the full limit of rows is not filled by the hint records passed in then supplement the hint with the globally defined hint for this class.

Parameters:

rowId - The row that we will load

rootId - The root class to load

hint - The locally defined hint

Returns:

The list of the rows to load

makeTable

@CheckReturnValue
 @Nonnull
public java.lang.String makeTable(@Nonnull
                                                              DBClass dbClass,
                                                              @Nonnull
                                                              java.lang.String tablePrefix)
                                                       throws java.sql.SQLException

make a table for this class.

Parameters:: dbClass - The class; tablePrefix - The table prefix
Returns:: The table name
Throws:: java.sql.SQLException - A serious problem

checkIndexies

public void checkIndexies()
                   throws java.lang.Exception

check the indexes

Throws:: java.lang.Exception - a serious problem

getChildren
```
@CheckReturnValue
 @Nonnull
public VirtualDB[] getChildren()
```
Get the children of this VirtualDB.

Thread Safe: Just doing a slow search each time.

Returns:

The list of extended databases

getQueryHandler

@CheckReturnValue
 @Nonnull
public DBQueryHandler getQueryHandler(@Nonnull
                                                                  DBClass searchClass)

makes a Query handler for simple virtual db.

Specified by:: getQueryHandler in interface DataSource
Parameters:: searchClass - The class to search.
Returns:: the query handler.

findRecentLink
```
@CheckReturnValue
 @Nonnull
public RecentLink findRecentLink(java.lang.String fieldKey)
```
Find the recent list for this field.

Parameters:

fieldKey - The field.

Returns:

The list

reIndex

public void reIndex(@Nullable
                    java.lang.String classes,
                    @Nullable
                    java.lang.String excludeClasses)
             throws java.lang.Exception

Parameters:: classes -; excludeClasses -
Throws:: java.lang.Exception - A serious problem

clearCache
```
public void clearCache(@Nonnull
                       DBClass dbClass)
```
When an object is created/deleted/cleared clear all possible full lists.
INTERNAL USE ONLY
This has public access ONLY so that the self test routines can clear it.

Parameters:

dbClass - The class to be cleared

clearDB
```
public static void clearDB(int id)
```
Clears the VirtualDB from the cache.
INTERNAL USE ONLY
This is so an internal process can remove a database.

Parameters:

id - The layer id

isPrivateDB
```
@CheckReturnValue
public boolean isPrivateDB()
```
Are we using private database ?

Returns:

the value

getSuspended

@CheckReturnValue
 @Nullable
public java.util.Date getSuspended()
                                                         throws VirtualDBNotFoundException,
                                                                RedirectException

Returns:: layer suspended time
Throws:: VirtualDBNotFoundException; RedirectException

getLicenseKeyExpiryDate

@CheckReturnValue
 @Nullable
public java.util.Date getLicenseKeyExpiryDate()

Returns:: license key expiry date

checkSuspended

public void checkSuspended()
                    throws VirtualDBNotFoundException,
                           VirtualDBExpiredException,
                           RedirectException

Throws:: VirtualDBNotFoundException; VirtualDBExpiredException; RedirectException - redirect to a new URL

checkLicense

public void checkLicense()
                  throws VirtualDBExpiredException

Throws:: VirtualDBExpiredException

setCacheObject
```
public void setCacheObject(java.lang.String key,
                           java.lang.Object obj)
```
Description copied from interface: DataSource

Set the data source's cache

Specified by:

setCacheObject in interface DataSource

Parameters:

key - The key

obj -

getCacheObject
```
@CheckReturnValue
 @Nullable
public java.lang.Object getCacheObject(java.lang.String key)
```
NO USER CACHE FOR THE VIRTUAL DB

Specified by:

getCacheObject in interface DataSource

Parameters:

key - The key

Returns:

the value

getAttribute

@CheckReturnValue
 @Nullable
public java.lang.Object getAttribute(@Nonnull
                                                                  java.lang.String name)

Gets a general purpose attribute

Specified by:: getAttribute in interface DataSource
Parameters:: name - the name of the attribute
Returns:: the value

addDBClassListener

public void addDBClassListener(@Nonnull
                               java.lang.String className,
                               @Nonnull
                               DBClassListener listener)

add a listener for any records of this class.

Parameters:: className -; listener - The listener.

addDBClassListener

public void addDBClassListener(@Nonnull
                               DBClass dbClass,
                               @Nonnull
                               DBClassListener listener)

Parameters:: dbClass - the class; listener -

hasDBClassListener

@CheckReturnValue
public boolean hasDBClassListener(@Nonnull
                                                    DBClass dbClass)

has a listener for records of this class.

Parameters:: dbClass - The class to remove.
Returns:: true if has a listener

removeDBClassListener

public void removeDBClassListener(@Nonnull
                                  DBClass dbClass,
                                  @Nonnull
                                  DBClassListener listener)

remove a listener for records of this class.

Parameters:: dbClass - The class to remove.; listener - The listener.

getCachedValueDB

@CheckReturnValue
 @Nullable
public java.lang.String getCachedValueDB(@Nonnull
                                                                      java.lang.String name,
                                                                      @Nullable
                                                                      java.lang.String defaultValue)

Parameters:: name -; defaultValue - the class
Returns:: the value

getCachedValueDB

@CheckReturnValue
 @Nullable
public java.lang.String getCachedValueDB(@Nonnull
                                                                      java.lang.String name)

Parameters:: name -
Returns:: the value

clearCachedValueDB

@Nullable
public java.lang.String clearCachedValueDB(@Nonnull
                                                     java.lang.String flg)

clear the cache value.

Parameters:: flg - the name of the parameter
Returns:: the value

setCachedValueDB

public void setCachedValueDB(@Nonnull
                             java.lang.String flg,
                             @Nonnull
                             java.lang.String value)

set the cache value in the database

Parameters:: flg - the key value; value - the value

freeMemory
```
public long freeMemory(double percentage)
```
Description copied from interface: MemoryHandler

Free memory at this level and below.
To prevent a possible deadlock this method should not be synchronized. It should call MemoryManager.callFreeMemory which in turn calls queuedFreeMemory()

Specified by:

freeMemory in interface MemoryHandler

Parameters:

percentage -

Returns:

the value

getCost
```
@CheckReturnValue
 @Nonnull
public MemoryHandler.Cost getCost()
```
Description copied from interface: MemoryHandler

The cost level for this MemoryHandler.

Specified by:

getCost in interface MemoryHandler

Returns:

the value

getEstimatedSize
```
@CheckReturnValue
 @Nonnegative
public long getEstimatedSize()
```
Description copied from interface: MemoryHandler

The estimated size of data held by this memory handler

Specified by:

getEstimatedSize in interface MemoryHandler

Returns:

the value

getLastAccessed
```
@CheckReturnValue
public long getLastAccessed()
```
Description copied from interface: MemoryHandler

The last time this memory handle was accessed

Specified by:

getLastAccessed in interface MemoryHandler

Returns:

the value

queuedFreeMemory
```
public long queuedFreeMemory(double percentage)
```
Description copied from interface: MemoryHandler

This method should implement the freeing of the method and maybe synchronized.

Specified by:

queuedFreeMemory in interface MemoryHandler

Parameters:

percentage -

Returns:

The estimated total number of bytes released.

panicFreeMemory
```
public long panicFreeMemory()
```
Clear all memory ASAP.

Specified by:

panicFreeMemory in interface MemoryHandler

Returns:

The estimated total number of bytes released.

tidyUp
```
public long tidyUp()
```
Description copied from interface: MemoryHandler

Tidy up the memory handler

Specified by:

tidyUp in interface MemoryHandler

Returns:

the value

reset
```
public void reset()
```
reset the cache document manager cache.

needToLoad

@CheckReturnValue
public boolean needToLoad(@Nonnull
                                            GlobalKeyId rootId,
                                            long checkRow,
                                            @Nullable
                                            HashLongMap globalHintMap,
                                            long transactionNr)

Do we need to load this record ?

Parameters:: rootId - the class id; checkRow - the row to check; globalHintMap - The global hint; transactionNr - the known transaction
Returns:: true if we should load

Class VirtualDB

Nested Class Summary

Nested classes/interfaces inherited from interface com.aspc.remote.memory.MemoryHandler

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

parentDb

transactionWindow

BLANK_LAYER

BLANK_FINAL_LAYER

DEFAULT_FIELD_VALUE_STATS_ROWS

PROPERTY_DISABLE_FIELD_RECYCLER

DISABLE_FIELD_RECYCLER

DISABLE_JMS_FILTER

PROPERTY_DISABLE_JMS_FILTER

MAX_TRANSACTION_HINT

MAX_SEGMENT_KEY

Method Detail

checkSuppressedIssue

simulateHeavyLoad

validateSignature

listInMemoryLayers

stats

getLayerFieldRecycler

getLayerFieldRecycle

isExcludeFromGroup

hasExcludedGroups

isIndexed

hasChild

hasChildViewedFrom

getCurrentDataSource

setCurrentDataSource

getThreadDataSource

decrypt

makeCipher

encrypt

currentEncryptionCode

getSession

lastBackedUp

findMaxTransHeader

fetchTransHeader

findCreatedTransHeader

findTransHeader

loadTransHeader

forceLoadTransHeader

transactionKnownToExist

findTransHeader

makeQuery

isaAcessLevelLogin

getACLCriteria

correctEstimateClassRows

setKnownClassRows

getEstimatedClassRows

getEstimatedAverageFieldRowsPerValue

getEstimatedFieldRows

generateStats

generateStats

generateStats

loadStatsIfRequired

loadStats

getDataBase

getDataBaseReadOnly

getLogin

getRealLogin

getUser

getTimeZone

getGlobalObject

getDBModuleMap

checkMaxLogin

countLogin

sudoSystem

sudoSystem

sudoSystem

getOwnerLogin

getAccessLevelLogin

getWriteMasterDB

getDocMgrURL

getGuestLogin