com.jalios.jcms
Class FileIndexManager

java.lang.Object
  com.jalios.jcms.FileIndexManager

public class FileIndexManager
extends Object

This class manages the Custom Type file index. It is intended to return a Set of Data referencing a given file.

 HashMap
   Key: the filename
   Value: TreeSet containing all the Data referencing this file
 

Version:

$Revision: 26167 $

Author:

Olivier Dedieu

Field Summary

static String

REVISION

Constructor Summary

FileIndexManager()

Method Summary

HashMap<String,TreeSet<Data>>	getIndex()
TreeSet<Data>	getIndexedDataSet(String filename) Returns the Set of data bound to the given filename (typically a FileDocument).
TreeSet<Data>	getIndexedDataSet(String filename, boolean searchInDB) Returns the Set of data bound to the given filename (typically a FileDocument or a DBFileDocument).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

FileIndexManager

public FileIndexManager()

Method Detail

getIndex

public HashMap<String,TreeSet<Data>> getIndex()

getIndexedDataSet

public TreeSet<Data> getIndexedDataSet(String filename)

Returns the Set of data bound to the given filename (typically a FileDocument).

Parameters:

filename - the filename

Returns:

the Set of data bound to the given filename (typically a FileDocument).

getIndexedDataSet

public TreeSet<Data> getIndexedDataSet(String filename,
                                       boolean searchInDB)

Returns the Set of data bound to the given filename (typically a FileDocument or a DBFileDocument).

Parameters:

filename - the filename

searchInDB - if true extends the search to JcmsDB

Returns:

the Set of data bound to the given filename (typically a FileDocument or a DBFileDocument).

Since:

jcms-6.2.0