Class: ICFS::Cache Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/icfs/cache.rb

Overview

This class is abstract.

Stores current items and provides a standard search interface.

Stores:

  • Case - current version

  • Log - all

  • Entry - current version

  • Action - current version

  • Current - for each case

  • Index - current version

Provides locking and searching interface.

Direct Known Subclasses

CacheElastic

Instance Method Summary collapse

Instance Method Details

#action_read(cid, anum) ⇒ String

Read an action

Parameters:

  • cid (String) —

    caseid

  • anum (Integer) —

    the action number

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


151
 
# File 'lib/icfs/cache.rb', line 151

def action_read(cid, anum); raise NotImplementedError; end

#action_search(query) ⇒ Object

Search for actions

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


169
 
# File 'lib/icfs/cache.rb', line 169

def action_search(query); raise NotImplementedError; end

#action_tags(query) ⇒ Object

List tags used on action tasks

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


177
 
# File 'lib/icfs/cache.rb', line 177

def action_tags(query); raise NotImplementedError; end

#action_write(cid, anum, item) ⇒ Object

Write an action

Parameters:

  • cid (String) —

    caseid

  • anum (Integer) —

    the action number

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


161
 
# File 'lib/icfs/cache.rb', line 161

def action_write(cid, anum, item); raise NotImplementedError; end

#case_read(cid) ⇒ String

Read a case

Parameters:

  • cid (String) —

    caseid

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


80
 
# File 'lib/icfs/cache.rb', line 80

def case_read(cid); raise NotImplementedError; end

#case_search(query) ⇒ Object

Search for cases

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


97
 
# File 'lib/icfs/cache.rb', line 97

def case_search(query); raise NotImplementedError; end

#case_tags(query) ⇒ Object

Get list of tags for cases

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


105
 
# File 'lib/icfs/cache.rb', line 105

def case_tags(query); raise NotImplementedError;end

#case_write(cid, item) ⇒ Object

Write a case

Parameters:

  • cid (String) —

    caseid

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


89
 
# File 'lib/icfs/cache.rb', line 89

def case_write(cid, item); raise NotImplementedError; end

#current_read(cid) ⇒ String

Read current

Parameters:

  • cid (String) —

    caseid

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


62
 
# File 'lib/icfs/cache.rb', line 62

def current_read(cid); raise NotImplementedError; end

#current_write(cid, item) ⇒ Object

Write current

Parameters:

  • cid (String) —

    caseid

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


71
 
# File 'lib/icfs/cache.rb', line 71

def current_write(cid, item); raise NotImplementedError; end

#entry_read(cid, enum) ⇒ String

Read an entry

Parameters:

  • cid (String) —

    caseid

  • enum (Integer) —

    the entry number

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


115
 
# File 'lib/icfs/cache.rb', line 115

def entry_read(cid, enum); raise NotImplementedError; end

#entry_search(query) ⇒ Object

Search for entries

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


133
 
# File 'lib/icfs/cache.rb', line 133

def entry_search(query); raise NotImplementedError; end

#entry_tags(query) ⇒ Object

List tags used on Entries

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


141
 
# File 'lib/icfs/cache.rb', line 141

def entry_tags(query); raise NotImplementedError; end

#entry_write(cid, enum, item) ⇒ Object

Write an entry

Parameters:

  • cid (String) —

    caseid

  • enum (Integer) —

    the entry number

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


125
 
# File 'lib/icfs/cache.rb', line 125

def entry_write(cid, enum, item); raise NotImplementedError; end

#index_read(cid, xnum) ⇒ String

Read an Index

Parameters:

  • cid (String) —

    caseid

  • xnum (Integer) —

    the index number

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


187
 
# File 'lib/icfs/cache.rb', line 187

def index_read(cid, xnum); raise NotImplementedError; end

#index_search(query) ⇒ Object

Search for Indexes

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


205
 
# File 'lib/icfs/cache.rb', line 205

def index_search(query); raise NotImplementedError; end

#index_tags(query) ⇒ Object

List tags used in indexes

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


213
 
# File 'lib/icfs/cache.rb', line 213

def index_tags(query); raise NotImplementedError; end

#index_write(cid, xnum, item) ⇒ Object

Write an Index

Parameters:

  • cid (String) —

    caseid

  • xnum (Integer) —

    the index number

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


197
 
# File 'lib/icfs/cache.rb', line 197

def index_write(cid, xnum, item); raise NotImplementedError; end

#lock_release(cid) ⇒ Object

Release a case lock

Parameters:

  • cid (String) —

    caseid

Raises:

  • (NotImplementedError) 


53
 
# File 'lib/icfs/cache.rb', line 53

def lock_release(cid); raise NotImplementedError; end

#lock_take(cid) ⇒ Object

Take a case lock

Parameters:

  • cid (String) —

    caseid

Raises:

  • (NotImplementedError) 


45
 
# File 'lib/icfs/cache.rb', line 45

def lock_take(cid); raise NotImplementedError; end

#log_read(cid, lnum) ⇒ String

Read a log

Parameters:

  • cid (String) —

    caseid

  • lnum (Integer) —

    the log number

Returns:

  • (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


223
 
# File 'lib/icfs/cache.rb', line 223

def log_read(cid, lnum); raise NotImplementedError; end

#log_search(query) ⇒ Object

Search for a log

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


241
 
# File 'lib/icfs/cache.rb', line 241

def log_search(query); raise NotImplementedError; end

#log_write(cid, lnum, item) ⇒ Object

Write a log

Parameters:

  • cid (String) —

    caseid

  • lnum (Integer) —

    the log number

  • item (String) —

    JSON encoded item

Raises:

  • (NotImplementedError) 


233
 
# File 'lib/icfs/cache.rb', line 233

def log_write(cid, lnum, item); raise NotImplementedError; end

#stats(query) ⇒ Object

Analyze stats

Parameters:

  • query (Hash) —

    the query

Raises:

  • (NotImplementedError) 


249
 
# File 'lib/icfs/cache.rb', line 249

def stats(query); raise NotImplementedError; end

#supports ⇒ Hash

What searching options are supported

Returns:

  • (Hash) —

    Supported searching options

Raises:

  • (NotImplementedError) 


37
 
# File 'lib/icfs/cache.rb', line 37

def supports; raise NotImplementedError; end