Package org.opencms.file.quota

Class CmsFolderSizeTable

java.lang.Object

org.opencms.file.quota.CmsFolderSizeTable

public class CmsFolderSizeTable
extends Object

Object for storing folder size information for all folders in the VFS, and for efficiently updating and retrieving it.

Mutable, not threadsafe by itself.

Constructor Summary

Constructors

Constructor	Description
CmsFolderSizeTable(CmsObject cms, boolean online)	Create a new instance.
CmsFolderSizeTable(CmsFolderSizeTable other)	Creates a deep copy of an existing instance.

Method Summary

Modifier and Type	Method	Description
Map<String,CmsFolderReportEntry>	getFolderReport(Collection<String> folders)	Prepares a folder report consisting of subtree sizes for a bunch of folders.
long	getTotalFolderSize(String rootPath)	Gets the total folder size for the complete subtree at the given root path.
long	getTotalFolderSizeExclusive(String rootPath, Collection<String> otherPaths)	Gets the folder size for the subtree at the given root path, but without including any folder sizes of subtrees at any paths from 'otherPaths' of which rootPath is a proper prefix.
void	loadAll()	Loads all folder size data.
void	updateSingle(String rootPath)	Updates the folder size for a single folder, not including subfolders.
void	updateSubtreeCache()	Updates the subtree cache.
void	updateTree(String rootPath)	Updates the information for a complete subtree.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsFolderSizeTable

public CmsFolderSizeTable(CmsFolderSizeTable other)

Creates a deep copy of an existing instance.

Parameters:

other -

CmsFolderSizeTable

public CmsFolderSizeTable(CmsObject cms,
 boolean online)

Create a new instance.

Parameters:

cms - the CMS context

Method Details

getFolderReport

public Map<String,CmsFolderReportEntry> getFolderReport(Collection<String> folders)

Prepares a folder report consisting of subtree sizes for a bunch of folders.

This is more efficient than querying for folder sizes individually.

Parameters:

folders - the folders

Returns:

the folder report

getTotalFolderSize

public long getTotalFolderSize(String rootPath)

Gets the total folder size for the complete subtree at the given root path.

Parameters:

rootPath - the root path for which to compute the size

Returns:

the total size

getTotalFolderSizeExclusive

public long getTotalFolderSizeExclusive(String rootPath,
 Collection<String> otherPaths)

Gets the folder size for the subtree at the given root path, but without including any folder sizes of subtrees at any paths from 'otherPaths' of which rootPath is a proper prefix.

Parameters:

rootPath - the root path for which to calculate the size

otherPaths - the other paths to exclude from the size

Returns:

the total size

loadAll

public void loadAll()
             throws CmsException

Loads all folder size data.

Throws:

CmsException - if something goes wrong

updateSingle

public void updateSingle(String rootPath)
                  throws CmsException

Updates the folder size for a single folder, not including subfolders.

Parameters:

rootPath - the root path of the folder for which to update the information

Throws:

CmsException - if something goes wrong

updateSubtreeCache

public void updateSubtreeCache()

Updates the subtree cache.

updateTree

public void updateTree(String rootPath)
                throws CmsException

Updates the information for a complete subtree.

Parameters:

rootPath - the root path for which to update the information

Throws:

CmsException - if something goes wrong