thredds.inventory

Interface MController

All Known Implementing Classes:

ControllerOS, ControllerOS7, ControllerS3, ControllerZip

public interface MController

Inventory Management Controller

Since:

Jun 25, 2009

Method Summary

Modifier and Type	Method and Description
void	close()
java.util.Iterator<MFile>	getInventoryAll(CollectionConfig mc, boolean recheck) Returns all leaves in collection, recursing into subdirectories.
java.util.Iterator<MFile>	getInventoryTop(CollectionConfig mc, boolean recheck) Returns all leaves in top collection, not recursing into subdirectories.
java.util.Iterator<MFile>	getSubdirs(CollectionConfig mc, boolean recheck) Returns all subdirectories in top collection.

Method Detail

getInventoryAll

java.util.Iterator<MFile> getInventoryAll(CollectionConfig mc,
                                          boolean recheck)

Returns all leaves in collection, recursing into subdirectories.

Parameters:

mc - defines the collection to scan

recheck - if false, may use cached results. otherwise must sync with File OS

Returns:

iterator over Mfiles, or null if collection does not exist

getInventoryTop

java.util.Iterator<MFile> getInventoryTop(CollectionConfig mc,
                                          boolean recheck)
                                   throws java.io.IOException

Returns all leaves in top collection, not recursing into subdirectories.

Parameters:

mc - defines the collection to scan

recheck - if false, may use cached results. otherwise must sync with File OS

Returns:

iterator over Mfiles, or null if collection does not exist

Throws:

java.io.IOException

getSubdirs

java.util.Iterator<MFile> getSubdirs(CollectionConfig mc,
                                     boolean recheck)

Returns all subdirectories in top collection.

Parameters:

mc - defines the collection to scan

recheck - if false, may use cached results. otherwise must sync with File OS

Returns:

iterator over Mfiles, or null if collection does not exist

close

void close()