ldas-tools-diskcacheAPI  2.7.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
diskCache::Cache::SDGTx Class Reference

SDGTx caching scheme. More...

#include <SDGTx.hh>

Inheritance diagram for diskCache::Cache::SDGTx:
Inheritance graph
[legend]
Collaboration diagram for diskCache::Cache::SDGTx:
Collaboration graph
[legend]

Classes

class  DirectoryInfo
 This class has the cache of directory information. More...
 
class  ExtensionError
 
class  OverlapHandler
 
class  QueryParams
 Optimized version of an ASCII query. More...
 

Public Types

typedef std::string file_extension_type
 
typedef std::list< file_extension_typefile_extension_container_type
 
typedef std::string file_extension_type
 
typedef std::list< file_extension_typefile_extension_container_type
 
typedef std::string file_extension_type
 
typedef std::list< file_extension_typefile_extension_container_type
 

Public Member Functions

virtual bool Configure (const std::string &Variable, const std::string &Value)
 Allow for customization. More...
 
virtual bool Configure (const std::string &Variable, const std::string &Value)
 Allow for customization. More...
 
virtual bool Configure (const std::string &Variable, const std::string &Value)
 Allow for customization. More...
 

Static Public Member Functions

static RegistrySingleton::id_type RegisterSearchEngine ()
 Register as a search engine. More...
 
static void FileExtList (const file_extension_container_type &Extensions, const std::string &Default)
 
static const file_extension_container_typeFileExtList ()
 
static void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer)
 
static bool IsMatch (DirectoryScanData &Data)
 Function called during processing of a directory. More...
 
static void OnDirectoryClose (DirectoryScanData &Data)
 Function called after all files have been processed. More...
 
static void TranslateQuery (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 
static void Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 Query for specific data. More...
 
static RegistrySingleton::id_type RegisterSearchEngine ()
 Register as a search engine. More...
 
static void FileExtList (const file_extension_container_type &Extensions, const std::string &Default)
 
static const file_extension_container_typeFileExtList ()
 
static void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer)
 
static bool IsMatch (DirectoryScanData &Data)
 Function called during processing of a directory. More...
 
static void OnDirectoryClose (DirectoryScanData &Data)
 Function called after all files have been processed. More...
 
static void TranslateQuery (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 
static void Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 Query for specific data. More...
 
static RegistrySingleton::id_type RegisterSearchEngine ()
 Register as a search engine. More...
 
static void FileExtList (const file_extension_container_type &Extensions, const std::string &Default)
 
static const file_extension_container_typeFileExtList ()
 
static void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer)
 
static bool IsMatch (DirectoryScanData &Data)
 Function called during processing of a directory. More...
 
static void OnDirectoryClose (DirectoryScanData &Data)
 Function called after all files have been processed. More...
 
static void TranslateQuery (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 
static void Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer)
 Query for specific data. More...
 

Static Public Attributes

static const char * AsciiId = "SDGTx"
 
static RegistrySingleton::id_type REGISTRY_ID
 
static file_extension_type s_default_extension = ".gwf"
 
static file_extension_container_type s_extensions
 

Detailed Description

SDGTx caching scheme.

This caching scheme is based on the S-D-G-T.%<ext%> naming convention that is referenced in the appendix of the Frame Specification.

Member Typedef Documentation

◆ file_extension_container_type [1/3]

◆ file_extension_container_type [2/3]

◆ file_extension_container_type [3/3]

◆ file_extension_type [1/3]

◆ file_extension_type [2/3]

◆ file_extension_type [3/3]

Member Function Documentation

◆ Configure() [1/3]

bool diskCache::Cache::SDGTx::Configure ( const std::string &  Variable,
const std::string &  Value 
)
virtual

Allow for customization.

Parameters
[in]VariableName of the option to modify
[in]ValueThe ascii string representation of the value for the option.
Returns
Upon successful setting of the option, true is returned; false otherwise.

Implements diskCache::Cache::Interface.

◆ Configure() [2/3]

virtual bool diskCache::Cache::SDGTx::Configure ( const std::string &  Variable,
const std::string &  Value 
)
virtual

Allow for customization.

Parameters
[in]VariableName of the option to modify
[in]ValueThe ascii string representation of the value for the option.
Returns
Upon successful setting of the option, true is returned; false otherwise.

Implements diskCache::Cache::Interface.

◆ Configure() [3/3]

virtual bool diskCache::Cache::SDGTx::Configure ( const std::string &  Variable,
const std::string &  Value 
)
virtual

Allow for customization.

Parameters
[in]VariableName of the option to modify
[in]ValueThe ascii string representation of the value for the option.
Returns
Upon successful setting of the option, true is returned; false otherwise.

Implements diskCache::Cache::Interface.

◆ FileExtList() [1/6]

static void diskCache::Cache::SDGTx::FileExtList ( const file_extension_container_type Extensions,
const std::string &  Default 
)
static

◆ FileExtList() [2/6]

void diskCache::Cache::SDGTx::FileExtList ( const file_extension_container_type Extensions,
const std::string &  Default 
)
static

◆ FileExtList() [3/6]

static void diskCache::Cache::SDGTx::FileExtList ( const file_extension_container_type Extensions,
const std::string &  Default 
)
static

◆ FileExtList() [4/6]

const SDGTx::file_extension_container_type & diskCache::Cache::SDGTx::FileExtList ( )
inlinestatic

◆ FileExtList() [5/6]

static const file_extension_container_type& diskCache::Cache::SDGTx::FileExtList ( )
static

◆ FileExtList() [6/6]

static const file_extension_container_type& diskCache::Cache::SDGTx::FileExtList ( )
static

◆ Find() [1/3]

void diskCache::Cache::SDGTx::Find ( const Streams::Streamable Source,
const Directory Dir,
QueryAnswer Answer 
)
static
Todo:
Need to catch appropriate exceptions

◆ Find() [2/3]

static void diskCache::Cache::SDGTx::Find ( const Streams::Streamable Source,
const Directory Dir,
QueryAnswer Answer 
)
static

◆ Find() [3/3]

static void diskCache::Cache::SDGTx::Find ( const Streams::Streamable Source,
const Directory Dir,
QueryAnswer Answer 
)
static

◆ IsMatch() [1/3]

bool diskCache::Cache::SDGTx::IsMatch ( DirectoryScanData Data)
static

Function called during processing of a directory.

Parameters
[in]DataPlace to log information as the directory is being processed.
Returns
The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.

◆ IsMatch() [2/3]

static bool diskCache::Cache::SDGTx::IsMatch ( DirectoryScanData Data)
static

Function called during processing of a directory.

Parameters
[in]DataPlace to log information as the directory is being processed.
Returns
The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.

◆ IsMatch() [3/3]

static bool diskCache::Cache::SDGTx::IsMatch ( DirectoryScanData Data)
static

Function called during processing of a directory.

Parameters
[in]DataPlace to log information as the directory is being processed.
Returns
The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.

◆ OnDirectoryClose() [1/3]

static void diskCache::Cache::SDGTx::OnDirectoryClose ( DirectoryScanData Data)
static

Function called after all files have been processed.

Parameters
[in]DataInformation gathered during teh scanning of the directory.

◆ OnDirectoryClose() [2/3]

static void diskCache::Cache::SDGTx::OnDirectoryClose ( DirectoryScanData Data)
static

Function called after all files have been processed.

Parameters
[in]DataInformation gathered during teh scanning of the directory.

◆ OnDirectoryClose() [3/3]

void diskCache::Cache::SDGTx::OnDirectoryClose ( DirectoryScanData Data)
static

Function called after all files have been processed.

Parameters
[in]DataInformation gathered during teh scanning of the directory.

When finished reading from the directory, all files that have been identified as new need to go under further scrutinization to ensure they do not violate any of the rules.

Todo:
Need to look at the old data to see if files existed in the previous version since they will need to be removed here.
Todo:
Need to flag this data as overlapping with other data within this directory
Todo:
Verify that file is unique under the mount point

◆ Query() [1/3]

static void diskCache::Cache::SDGTx::Query ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

Query for specific data.

Parameters
[in]ParamsThe ASCII representation of the query.
[out]AnswerThe answer set.

◆ Query() [2/3]

static void diskCache::Cache::SDGTx::Query ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

Query for specific data.

Parameters
[in]ParamsThe ASCII representation of the query.
[out]AnswerThe answer set.

◆ Query() [3/3]

static void diskCache::Cache::SDGTx::Query ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

Query for specific data.

Parameters
[in]ParamsThe ASCII representation of the query.
[out]AnswerThe answer set.

◆ RegisterSearchEngine() [1/3]

RegistrySingleton::id_type diskCache::Cache::SDGTx::RegisterSearchEngine ( )
static

Register as a search engine.

Register the search engine so it can be used throughout the system.

◆ RegisterSearchEngine() [2/3]

static RegistrySingleton::id_type diskCache::Cache::SDGTx::RegisterSearchEngine ( )
static

Register as a search engine.

◆ RegisterSearchEngine() [3/3]

static RegistrySingleton::id_type diskCache::Cache::SDGTx::RegisterSearchEngine ( )
static

Register as a search engine.

◆ TranslateQuery() [1/3]

void diskCache::Cache::SDGTx::TranslateQuery ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

◆ TranslateQuery() [2/3]

static void diskCache::Cache::SDGTx::TranslateQuery ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

◆ TranslateQuery() [3/3]

static void diskCache::Cache::SDGTx::TranslateQuery ( const Cache::QueryParams Params,
Cache::QueryAnswer Answer 
)
static

Member Data Documentation

◆ AsciiId

static const char * diskCache::Cache::SDGTx::AsciiId = "SDGTx"
static

◆ REGISTRY_ID

static RegistrySingleton::id_type diskCache::Cache::SDGTx::REGISTRY_ID
static
Initial value:

◆ s_default_extension

static file_extension_type diskCache::Cache::SDGTx::s_default_extension = ".gwf"
static

◆ s_extensions

static file_extension_container_type diskCache::Cache::SDGTx::s_extensions
static

The documentation for this class was generated from the following files: