Class FeatureCacheTables

Feature Row Cache for multiple feature tables in a single GeoPackage

Hierarchy

FeatureCacheTables

Index

Constructors

Methods

clear clearAll clearAndResize clearAndResizeAll get getCache getCacheWithFeatureRow getMaxCacheSize getMaxSize getSize getTables put remove removeWithFeatureRow resize resizeAll setMaxCacheSize

Constructors

constructor

new FeatureCacheTables(maxCacheSize?: number): FeatureCacheTables
Constructor
Parameters
- maxCacheSize: number = FeatureCache.DEFAULT_CACHE_MAX_SIZE
  
  max feature rows to retain in each feature table cache
Returns FeatureCacheTables
- Defined in lib/features/user/featureCacheTables.ts:22

Methods

clear

clear(tableName: string): void
Clear the feature table cache
Parameters
- tableName: string
  
  feature table name
Returns void
- Defined in lib/features/user/featureCacheTables.ts:134

clearAll

clearAll(): void
Clear all caches

Returns void
- Defined in lib/features/user/featureCacheTables.ts:141

clearAndResize

clearAndResize(tableName: string, maxCacheSize: number): void
Clear and resize the feature table cache
Parameters
- tableName: string
  
  feature table name
- maxCacheSize: number
  
  max cache size
Returns void
- Defined in lib/features/user/featureCacheTables.ts:174

clearAndResizeAll

clearAndResizeAll(maxCacheSize: number): void
Clear and resize all caches and update the max cache size
Parameters
- maxCacheSize: number
  
  max cache size
Returns void
- Defined in lib/features/user/featureCacheTables.ts:184

get

get(tableName: string, featureId: number): FeatureRow
Get the cached feature row by table name and feature id

Returns
feature row or null
Parameters
- tableName: string
  
  feature table name
- featureId: number
  
  feature row id
Returns FeatureRow
- Defined in lib/features/user/featureCacheTables.ts:98

getCache

getCache(tableName: string): FeatureCache
Get or create a feature row cache for the table name

Returns
feature row cache
Parameters
- tableName: string
  
  feature table name
Returns FeatureCache
- Defined in lib/features/user/featureCacheTables.ts:55

getCacheWithFeatureRow

getCacheWithFeatureRow(featureRow: FeatureRow): FeatureCache
Get or create a feature row cache for the feature row

Returns
feature row cache
Parameters
- featureRow: FeatureRow
  
  feature row
Returns FeatureCache
- Defined in lib/features/user/featureCacheTables.ts:69

getMaxCacheSize

getMaxCacheSize(): number
Get the max cache size used when creating new feature row caches

Returns
max cache size

Returns number
- Defined in lib/features/user/featureCacheTables.ts:30

getMaxSize

getMaxSize(tableName: string): number
Get the cache max size for the table name

Returns
max size
Parameters
- tableName: string
  
  feature table name
Returns number
- Defined in lib/features/user/featureCacheTables.ts:78

getSize

getSize(tableName: string): number
Get the current cache size, number of feature rows cached, for the table name

Returns
cache size
Parameters
- tableName: string
  
  feature table name
Returns number
- Defined in lib/features/user/featureCacheTables.ts:88

getTables

getTables(): string[]
Get the feature table names with a feature row cache

Returns
feature table names

Returns string[]
- Defined in lib/features/user/featureCacheTables.ts:46

put

put(featureRow: FeatureRow): FeatureRow
Cache the feature row

Returns
previous cached feature row or null
Parameters
- featureRow: FeatureRow
  
  feature row
Returns FeatureRow
- Defined in lib/features/user/featureCacheTables.ts:107

remove

remove(tableName: string, featureId: number): FeatureRow
Remove the cached feature row by id

Returns
removed feature row or null
Parameters
- tableName: string
  
  feature table name
- featureId: number
  
  feature row id
Returns FeatureRow
- Defined in lib/features/user/featureCacheTables.ts:126

removeWithFeatureRow

removeWithFeatureRow(featureRow: FeatureRow): FeatureRow
Remove the cached feature row

Returns
removed feature row or null
Parameters
- featureRow: FeatureRow
  
  feature row
Returns FeatureRow
- Defined in lib/features/user/featureCacheTables.ts:116

resize

resize(tableName: string, maxCacheSize: number): void
Resize the feature table cache
Parameters
- tableName: string
  
  feature table name
- maxCacheSize: number
  
  max cache size
Returns void
- Defined in lib/features/user/featureCacheTables.ts:150

resizeAll

resizeAll(maxCacheSize: number): void
Resize all caches and update the max cache size
Parameters
- maxCacheSize: number
  
  max cache size
Returns void
- Defined in lib/features/user/featureCacheTables.ts:159

setMaxCacheSize

setMaxCacheSize(maxCacheSize: number): void
Set the max cache size to use when creating new feature row caches
Parameters
- maxCacheSize: number
  
  feature row max cache size
Returns void
- Defined in lib/features/user/featureCacheTables.ts:38

Generated using TypeDoc