FileIndexManager (JCMS API)

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

public class FileIndexManager
extends java.lang.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

Author:: Olivier Dedieu

Constructor Summary

Constructors
Constructor Description

FileIndexManager()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.HashMap<java.lang.String,java.util.TreeSet<Data>>`	`getIndex()`
`java.util.TreeSet<Data>`	`getIndexedDataSet(java.lang.String filename)`	Returns the Set of data bound to the given filename (typically a FileDocument).
`java.util.TreeSet<Data>`	`getIndexedDataSet(java.lang.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

- Constructor Detail
  - FileIndexManager
```
public FileIndexManager()
```
- Method Detail
  - getIndex
```
public java.util.HashMap<java.lang.String,java.util.TreeSet<Data>> getIndex()
```
  - getIndexedDataSet
```
public java.util.TreeSet<Data> getIndexedDataSet(java.lang.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 java.util.TreeSet<Data> getIndexedDataSet(java.lang.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