Lucene++ - a full-featured, c++ search engine
API Documentation


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Static Public Member Functions
Lucene::IndexFileNameFilter Class Reference

Filename filter that accept filenames and extensions only created by Lucene. More...

#include <IndexFileNameFilter.h>

+ Inheritance diagram for Lucene::IndexFileNameFilter:

Static Public Member Functions

static bool accept (const String &directory, const String &name)
 Returns true if this is a file known to be a Lucene index file.
static bool isCFSFile (const String &name)
 Returns true if this is a file that would be contained in a CFS file. This function should only be called on files that pass the accept (ie, are already known to be a Lucene index file).
static IndexFileNameFilterPtr getFilter ()
 Return singleton IndexFileNameFilter.

Additional Inherited Members

- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
virtual int32_t hashCode ()
 Return hash code for this object.
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
virtual String toString ()
 Returns a string representation of the object.
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
LuceneSignalPtr objectSignal

Detailed Description

Filename filter that accept filenames and extensions only created by Lucene.

Member Function Documentation

static bool Lucene::IndexFileNameFilter::accept ( const String &  directory,
const String &  name 
)
static

Returns true if this is a file known to be a Lucene index file.

static IndexFileNameFilterPtr Lucene::IndexFileNameFilter::getFilter ( )
static

Return singleton IndexFileNameFilter.

static bool Lucene::IndexFileNameFilter::isCFSFile ( const String &  name)
static

Returns true if this is a file that would be contained in a CFS file. This function should only be called on files that pass the accept (ie, are already known to be a Lucene index file).


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

clucene.sourceforge.net