| org.apache.jetspeed.page.document.FolderHandler
All known Subclasses: org.apache.jetspeed.page.document.psml.FileSystemFolderHandler,
| FolderHandler | | public interface FolderHandler (Code) | |
FolderHandler
author:
Scott T. Weaver
version:
$Id: FolderHandler.java 553584 2007-07-05 18:09:45Z taylor $ |
| Method Summary | |
| Folder | getFolder(String path)
getFolder
Locates a folder given using the path argument. | | Folder | getFolder(String path, boolean fromCache)
getFolder
Locates a folder given using the path argument. | | NodeSet | getFolders(String path)
| | NodeSet | getNodes(String path, boolean regexp, String documentType)
getNodes
Returns a set of nodes relative to the folder argument of the type
indicated by the documentType argument. | | boolean | isFolder(String path)
| | String[] | list(String folderPath, String documentType)
list
generates a list of document names, relative to the folderPath argument
of the type indicated by the documentType argument.
Parameters:
folderPath - folder path to search under
Parameters:
documentType - document type to filter on. | | String[] | listAll(String folderPath)
| | void | removeFolder(Folder folder)
removeFolder
Removes the folder specified with the folder argument. | | void | updateFolder(Folder folder)
updateFolder
Updates the folder specified with the folder argument. |
| getNodes | | NodeSet getNodes(String path, boolean regexp, String documentType) throws FolderNotFoundException, InvalidFolderException, NodeException(Code) | |
getNodes
Returns a set of nodes relative to the folder argument of the type
indicated by the documentType argument. The folder argument
may include regular expressions if indicated by the regex argument. The
returned set is unordered.
Parameters:
path - Path from which to locate documents
Parameters:
regexp - Flag indicating whether regexp should be expanded in path
Parameters:
documentType - document type to filter on. NodeSet of documents and folders located under the path argument.
throws:
FolderNotFoundException - if folder under the path does not actually exist.
throws:
DocumentException - if an error is encountered reading the folders.
throws:
InvalidFolderException -
throws:
NodeException - |
| isFolder | | boolean isFolder(String path)(Code) | | Returns true if the path is a folder
Parameters:
path - |
| list | | String[] list(String folderPath, String documentType) throws FolderNotFoundException(Code) | |
list
generates a list of document names, relative to the folderPath argument
of the type indicated by the documentType argument.
Parameters:
folderPath - folder path to search under
Parameters:
documentType - document type to filter on. a String[] of child document names relative to the folderPathargument and matching the documentType argument.
throws:
FolderNotFoundException - if the folderPath does not exsit. |
|
|