FileFolderService (Alfresco Benchmark Util 3.0.2 API)

java.lang.Object
- org.alfresco.bm.cm.FileFolderService

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean
```
public class FileFolderService
extends Object
implements org.springframework.beans.factory.InitializingBean
```
Service to keep track of files and folders.

Since:

4.0.4

Author:

Derek Hulley

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.mongodb.DBCollection`	`collection` The collection of users, which can be reused by derived extensions.
`static String`	`FIELD_CONTEXT`
`static String`	`FIELD_FILE_COUNT`
`static String`	`FIELD_FOLDER_COUNT`
`static String`	`FIELD_ID`
`static String`	`FIELD_LEVEL`
`static String`	`FIELD_NAME`
`static String`	`FIELD_PARENT_PATH`
`static String`	`FIELD_PATH`

Constructor Summary

Constructors
Constructor and Description

FileFolderService(com.mongodb.DB db, String collection)

Constructors
Constructor and Description
`FileFolderService(com.mongodb.DB db, String collection)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`long`	`countChildFolders(String context, String path)` Produces a count of the folders that have the given context and path as a parent folder.
`long`	`countEmptyFolders(String context)` Count folders without either subfolders or files
`void`	`createNewFolder(FolderData data)` Create a new folder entry with the given data
`void`	`createNewFolder(String id, String context, String path)` Create a new folder entry with the given data.
`int`	`deleteFolder(String context, String path, boolean cascade)` Delete a folder entry based on the folder ID
`protected List<FolderData>`	`fromDBCursor(com.mongodb.DBCursor cursor)` Turn a cursor into an array of API-friendly objects
`protected FolderData`	`fromDBObject(com.mongodb.DBObject folderDataObj)` Helper to convert a Mongo DBObject into the API consumable object Note that `null` is handled as a `null` return.
`List<FolderData>`	`getChildFolders(String context, String path, int skip, int limit)` Get a list of folders that have the given context and path as a parent folder.
`FolderData`	`getFolder(String id)` Retrieve a folder by the ID
`FolderData`	`getFolder(String context, String path)` Retrieve a folder by the path
`List<FolderData>`	`getFoldersByCounts(String context, Long minLevel, Long maxLevel, Long minFolders, Long maxFolders, Long minFiles, Long maxFiles, int skip, int limit)` Get a list of folders filtered by the number of child files and/or folders, returning results sorted according to the parameters supplied.
`void`	`incrementFileCount(String context, String path, long fileCountInc)` Increment the count of the files in a folder.
`void`	`incrementFolderCount(String context, String path, long folderCountInc)` Increment the count of the subfolders in a folder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIELD_ID
```
public static final String FIELD_ID
```
    See Also:
    
    Constant Field Values
  - FIELD_CONTEXT
```
public static final String FIELD_CONTEXT
```
    See Also:
    
    Constant Field Values
  - FIELD_PATH
```
public static final String FIELD_PATH
```
    See Also:
    
    Constant Field Values
  - FIELD_LEVEL
```
public static final String FIELD_LEVEL
```
    See Also:
    
    Constant Field Values
  - FIELD_PARENT_PATH
```
public static final String FIELD_PARENT_PATH
```
    See Also:
    
    Constant Field Values
  - FIELD_NAME
```
public static final String FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - FIELD_FOLDER_COUNT
```
public static final String FIELD_FOLDER_COUNT
```
    See Also:
    
    Constant Field Values
  - FIELD_FILE_COUNT
```
public static final String FIELD_FILE_COUNT
```
    See Also:
    
    Constant Field Values
  - collection
```
protected final com.mongodb.DBCollection collection
```
    The collection of users, which can be reused by derived extensions.
- Constructor Detail
  - FileFolderService
```
public FileFolderService(com.mongodb.DB db,
                         String collection)
```
- Method Detail
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - fromDBObject
```
protected FolderData fromDBObject(com.mongodb.DBObject folderDataObj)
```
    Helper to convert a Mongo DBObject into the API consumable object
    Note that null is handled as a null return.
  - fromDBCursor
```
protected List<FolderData> fromDBCursor(com.mongodb.DBCursor cursor)
```
    Turn a cursor into an array of API-friendly objects
  - createNewFolder
```
public void createNewFolder(String id,
                            String context,
                            String path)
```
    Create a new folder entry with the given data.
    The file count is assumed to be zero.
  - createNewFolder
```
public void createNewFolder(FolderData data)
```
    Create a new folder entry with the given data
  - deleteFolder
```
public int deleteFolder(String context,
                        String path,
                        boolean cascade)
```
    Delete a folder entry based on the folder ID
    
    Parameters:
    
    id - the folder ID
  - getFolder
```
public FolderData getFolder(String id)
```
    Retrieve a folder by the ID
    
    Parameters:
    
    id - the folder id
    
    Returns:
    
    the folder data or null if it does not exist
  - getFolder
```
public FolderData getFolder(String context,
                            String path)
```
    Retrieve a folder by the path
    
    Parameters:
    
    context - the context in which the folder path is valid (mandatory)
    
    path - the folder path relative to the given context
    
    Returns:
    
    the folder data or null if it does not exist
  - incrementFolderCount
```
public void incrementFolderCount(String context,
                                 String path,
                                 long folderCountInc)
```
    Increment the count of the subfolders in a folder.
    
    Parameters:
    
    context - the context in which the folder path is valid (mandatory)
    
    path - the folder path relative to the given context
    
    fileCountInc - the file count increment (can be negative)
  - incrementFileCount
```
public void incrementFileCount(String context,
                               String path,
                               long fileCountInc)
```
    Increment the count of the files in a folder.
    
    Parameters:
    
    context - the context in which the folder path is valid (mandatory)
    
    path - the folder path relative to the given context
    
    fileCountInc - the file count increment (can be negative)
  - countChildFolders
```
public long countChildFolders(String context,
                              String path)
```
    Produces a count of the folders that have the given context and path as a parent folder.
    If the following files exist:
```
      /home/tests/a
      /home/tests/b
 
```
    then the counts for:
```
      /home/tests
 
```
    will be 2
    Returns:
    
    the folder count
  - countEmptyFolders
```
public long countEmptyFolders(String context)
```
    Count folders without either subfolders or files
    
    Returns:
    
    count of folders without subfolders or files
  - getChildFolders
```
public List<FolderData> getChildFolders(String context,
                                        String path,
                                        int skip,
                                        int limit)
```
    Get a list of folders that have the given context and path as a parent folder.
    If the path given is:
```
      /home/tests
 
```
    then the following results can be returned:
```
      /home/tests/a
      /home/tests/b
 
```
    Parameters:
    
    context - the context in which the folder path is valid (mandatory)
    
    path - the path that will be the parent of all child folders returned
    
    skip - the number of entries to skip
    
    limit - the number of entries to return
    
    Returns:
    
    the child folders
  - getFoldersByCounts
```
public List<FolderData> getFoldersByCounts(String context,
                                           Long minLevel,
                                           Long maxLevel,
                                           Long minFolders,
                                           Long maxFolders,
                                           Long minFiles,
                                           Long maxFiles,
                                           int skip,
                                           int limit)
```
    Get a list of folders filtered by the number of child files and/or folders, returning results sorted according to the parameters supplied.
    Apart from the context, all parametes are optional. However, for best performance, do not mix the file and folder levels; the underlying query performance will be OK but the sorting will not be ideal.
    The sort precedence is folderCount-fileCount.
    
    Parameters:
    
    context - the context in which the folder path is valid (mandatory)
    
    minLevel - the minimum folder level to consider (inclusive, optional)
    
    maxLevel - the maximum folder level to consider (inclusive, optional)
    
    minFiles - the minimum number of files in the folder (inclusive, optional)
    
    maxFiles - the maximum number of files in the folder (inclusive, optional)
    
    skip - the number of entries to skip
    
    limit - the number of entries to return
    
    Returns:
    
    the folders with the correct number of children

Class FileFolderService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIELD_ID

FIELD_CONTEXT

FIELD_PATH

FIELD_LEVEL

FIELD_PARENT_PATH

FIELD_NAME

FIELD_FOLDER_COUNT

FIELD_FILE_COUNT

collection

Constructor Detail

FileFolderService

Method Detail

afterPropertiesSet

fromDBObject

fromDBCursor

createNewFolder

createNewFolder

deleteFolder

getFolder

getFolder

incrementFolderCount

incrementFileCount

countChildFolders

countEmptyFolders

getChildFolders

getFoldersByCounts