ldas-tools-diskcacheAPI  2.7.2
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
diskCache::Cache::Registry::Info Class Referenceabstract

#include <Registry.hh>

Inheritance diagram for diskCache::Cache::Registry::Info:
Inheritance graph
[legend]
Collaboration diagram for diskCache::Cache::Registry::Info:
Collaboration graph
[legend]

Public Types

typedef Registry::indexing_type indexing_type
 
typedef Registry::indexing_type indexing_type
 
typedef Registry::indexing_type indexing_type
 

Public Member Functions

 Info (const std::string &Key, FindFunc Find, IsMatchFunc IsMatch, OnDirectoryCloseFunc OnDirectoryClose, TranslateQueryFunc TranslateQuery)
 Constructor. More...
 
void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer) const
 
bool IsMatch (DirectoryScanData &Data) const
 Called per file. More...
 
void OnDirectoryClose (DirectoryScanData &Data) const
 Callback once all data has been read. More...
 
void TranslateQuery (const QueryParams &Params, QueryAnswer &Answer) const
 
 Info (const std::string &Key, FindFunc Find, IsMatchFunc IsMatch, OnDirectoryCloseFunc OnDirectoryClose, TranslateQueryFunc TranslateQuery)
 Constructor. More...
 
void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer) const
 
bool IsMatch (DirectoryScanData &Data) const
 Called per file. More...
 
void OnDirectoryClose (DirectoryScanData &Data) const
 Callback once all data has been read. More...
 
void TranslateQuery (const QueryParams &Params, QueryAnswer &Answer) const
 
 Info (const std::string &Key, FindFunc Find, IsMatchFunc IsMatch, OnDirectoryCloseFunc OnDirectoryClose, TranslateQueryFunc TranslateQuery)
 Constructor. More...
 
void Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer) const
 
bool IsMatch (DirectoryScanData &Data) const
 Called per file. More...
 
void OnDirectoryClose (DirectoryScanData &Data) const
 Callback once all data has been read. More...
 
void TranslateQuery (const QueryParams &Params, QueryAnswer &Answer) const
 
virtual InfoClone () const =0
 
virtual InfoClone () const =0
 
virtual InfoClone () const =0
 

Public Attributes

const ascii_key_type m_key_name
 

Static Public Attributes

static const FindFunc FIND_FUNC_NULL
 
static const IsMatchFunc IS_MATCH_FUNC_NULL
 
static const OnDirectoryCloseFunc ON_DIRECTORY_CLOSE_FUNC_NULL
 
static const TranslateQueryFunc TRANSLATE_QUERY_FUNC_NULL
 

Protected Member Functions

 Info (const Info &Source)
 
 Info (const Info &Source)
 
 Info (const Info &Source)
 

Private Attributes

FindFunc m_find_func
 
IsMatchFunc m_is_match_func
 
OnDirectoryCloseFunc m_on_directory_close_func
 
TranslateQueryFunc m_translate_query_func
 

Member Typedef Documentation

◆ indexing_type [1/3]

◆ indexing_type [2/3]

◆ indexing_type [3/3]

Constructor & Destructor Documentation

◆ Info() [1/6]

diskCache::Cache::Registry::Info::Info ( const std::string &  Key,
FindFunc  Find,
IsMatchFunc  IsMatch,
OnDirectoryCloseFunc  OnDirectoryClose,
TranslateQueryFunc  TranslateQuery 
)

Constructor.

Parameters
[in]Key
[in]FindSpecify the function to use to locate files within a directory.
[in]IsMatchFunction to call to check if a file should be indexed by the search engine.
[in]OnDirectoryCloseFunction to call once all entries in the current directory have been processed. If the search engine has no action, then the value ON_DIRECTORY_CLOSE_FUNC_NULL may be passed.
[in]TranslateQueryTranslate the query results (eg: make it easily parsable by TCL, Python, etc.).
Returns
New instance of the object

◆ Info() [2/6]

diskCache::Cache::Registry::Info::Info ( const Info Source)
protected

◆ Info() [3/6]

diskCache::Cache::Registry::Info::Info ( const std::string &  Key,
FindFunc  Find,
IsMatchFunc  IsMatch,
OnDirectoryCloseFunc  OnDirectoryClose,
TranslateQueryFunc  TranslateQuery 
)

Constructor.

Parameters
[in]Key
[in]FindSpecify the function to use to locate files within a directory.
[in]IsMatchFunction to call to check if a file should be indexed by the search engine.
[in]OnDirectoryCloseFunction to call once all entries in the current directory have been processed. If the search engine has no action, then the value ON_DIRECTORY_CLOSE_FUNC_NULL may be passed.
[in]TranslateQueryTranslate the query results (eg: make it easily parsable by TCL, Python, etc.).
Returns
New instance of the object

◆ Info() [4/6]

diskCache::Cache::Registry::Info::Info ( const Info Source)
protected

◆ Info() [5/6]

diskCache::Cache::Registry::Info::Info ( const std::string &  Key,
FindFunc  Find,
IsMatchFunc  IsMatch,
OnDirectoryCloseFunc  OnDirectoryClose,
TranslateQueryFunc  TranslateQuery 
)

Constructor.

Parameters
[in]Key
[in]FindSpecify the function to use to locate files within a directory.
[in]IsMatchFunction to call to check if a file should be indexed by the search engine.
[in]OnDirectoryCloseFunction to call once all entries in the current directory have been processed. If the search engine has no action, then the value ON_DIRECTORY_CLOSE_FUNC_NULL may be passed.
[in]TranslateQueryTranslate the query results (eg: make it easily parsable by TCL, Python, etc.).
Returns
New instance of the object

◆ Info() [6/6]

diskCache::Cache::Registry::Info::Info ( const Info Source)
protected

Member Function Documentation

◆ Clone() [1/3]

virtual Info* diskCache::Common::Registry::Info::Clone ( ) const
pure virtualinherited

◆ Clone() [2/3]

virtual Info* diskCache::Common::Registry::Info::Clone ( ) const
pure virtualinherited

◆ Clone() [3/3]

virtual Info* diskCache::Common::Registry::Info::Clone ( ) const
pure virtualinherited

◆ Find() [1/3]

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

◆ Find() [2/3]

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

◆ Find() [3/3]

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

◆ IsMatch() [1/3]

bool diskCache::Cache::Registry::Info::IsMatch ( DirectoryScanData Data) const
inline

Called per file.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ IsMatch() [2/3]

bool diskCache::Cache::Registry::Info::IsMatch ( DirectoryScanData Data) const

Called per file.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ IsMatch() [3/3]

bool diskCache::Cache::Registry::Info::IsMatch ( DirectoryScanData Data) const

Called per file.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ OnDirectoryClose() [1/3]

void diskCache::Cache::Registry::Info::OnDirectoryClose ( DirectoryScanData Data) const

Callback once all data has been read.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ OnDirectoryClose() [2/3]

void diskCache::Cache::Registry::Info::OnDirectoryClose ( DirectoryScanData Data) const
inline

Callback once all data has been read.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ OnDirectoryClose() [3/3]

void diskCache::Cache::Registry::Info::OnDirectoryClose ( DirectoryScanData Data) const

Callback once all data has been read.

Parameters
[in,out]DataSearch engine specific data. This is also a scratch area for search engines to record transient information related to processing the directory contents.

◆ TranslateQuery() [1/3]

void diskCache::Cache::Registry::Info::TranslateQuery ( const QueryParams Params,
QueryAnswer Answer 
) const
inline

◆ TranslateQuery() [2/3]

void diskCache::Cache::Registry::Info::TranslateQuery ( const QueryParams Params,
QueryAnswer Answer 
) const

◆ TranslateQuery() [3/3]

void diskCache::Cache::Registry::Info::TranslateQuery ( const QueryParams Params,
QueryAnswer Answer 
) const

Member Data Documentation

◆ FIND_FUNC_NULL

static const FindFunc diskCache::Cache::Registry::Info::FIND_FUNC_NULL
static
Initial value:

◆ IS_MATCH_FUNC_NULL

static const IsMatchFunc diskCache::Cache::Registry::Info::IS_MATCH_FUNC_NULL
static
Initial value:

◆ m_find_func

FindFunc diskCache::Cache::Registry::Info::m_find_func
private

◆ m_is_match_func

IsMatchFunc diskCache::Cache::Registry::Info::m_is_match_func
private

◆ m_key_name

const ascii_key_type diskCache::Common::Registry::Info::m_key_name
inherited

◆ m_on_directory_close_func

OnDirectoryCloseFunc diskCache::Cache::Registry::Info::m_on_directory_close_func
private

◆ m_translate_query_func

TranslateQueryFunc diskCache::Cache::Registry::Info::m_translate_query_func
private

◆ ON_DIRECTORY_CLOSE_FUNC_NULL

static const OnDirectoryCloseFunc diskCache::Cache::Registry::Info::ON_DIRECTORY_CLOSE_FUNC_NULL
static
Initial value:

◆ TRANSLATE_QUERY_FUNC_NULL

static const TranslateQueryFunc diskCache::Cache::Registry::Info::TRANSLATE_QUERY_FUNC_NULL
static
Initial value:

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