thredds.inventory.partition

Class DirectoryCollection

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.partition.DirectoryCollection

All Implemented Interfaces:

AutoCloseable, MCollection

Direct Known Subclasses:

FilePartition

public class DirectoryCollection
extends CollectionAbstract

Manage MFiles from one directory. Use getFileIterator() for best performance on large directories

Since:

11/16/13

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DirectoryCollection.Visitor

Nested classes/interfaces inherited from class thredds.inventory.CollectionAbstract

CollectionAbstract.DateSorter, CollectionAbstract.MyGribFilter

Field Summary

Fields inherited from class thredds.inventory.CollectionAbstract

auxInfo, CATALOG, collectionName, dateExtractor, DIR, FILE, filter, GLOB, lastModified, LIST, logger, NCX_SUFFIX, protoChoice, root, sfilter, startCollection

Constructor Summary

Constructors

Constructor and Description
DirectoryCollection(String topCollectionName, Path topDir, org.slf4j.Logger logger)
DirectoryCollection(String topCollectionName, String topDirS, org.slf4j.Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close and release any resources.
CloseableIterator<MFile>	getFileIterator() Get the current collection of MFile, no guaranteed order.
Iterable<MFile>	getFilesSorted() Get the current collection of MFile.
String	getIndexFilename()
Path	getIndexPath()
String	getRoot() Get common root directory of all MFiles in the collection - may be null
boolean	isLeafDirectory()
void	iterateOverMFileCollection(DirectoryCollection.Visitor visit)
static Path	makeCollectionIndexPath(String topCollectionName, Path dir) Create standard name = topCollectionName + last directory
static String	makeCollectionName(String topCollectionName, Path dir) Create standard name = topCollectionName + last directory

Methods inherited from class thredds.inventory.CollectionAbstract

cleanName, extractDate, getAuxInfo, getCollectionName, getFilenames, getLastModified, getLatestFile, getProtoIndex, getStartCollection, hasDateExtractor, isLeaf, makeFileListSorted, open, putAuxInfo, setDateExtractor, setLeaf, setMFileFilter, setRoot, setStreamFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryCollection

public DirectoryCollection(String topCollectionName,
                   Path topDir,
                   org.slf4j.Logger logger)

DirectoryCollection

public DirectoryCollection(String topCollectionName,
                   String topDirS,
                   org.slf4j.Logger logger)

Method Detail

makeCollectionName

public static String makeCollectionName(String topCollectionName,
                        Path dir)

Create standard name = topCollectionName + last directory

Parameters:

topCollectionName - from config, name of the collection

dir - directory for this

Returns:

standard collection name, to name the index file

makeCollectionIndexPath

public static Path makeCollectionIndexPath(String topCollectionName,
                           Path dir)

Create standard name = topCollectionName + last directory

Parameters:

topCollectionName - from config, name of the collection

dir - directory for this

Returns:

standard collection name, to name the index file

getIndexPath

public Path getIndexPath()

isLeafDirectory

public boolean isLeafDirectory()
                        throws IOException

Throws:

IOException

getRoot

public String getRoot()

Description copied from interface: MCollection

Get common root directory of all MFiles in the collection - may be null

Specified by:

getRoot in interface MCollection

Overrides:

getRoot in class CollectionAbstract

Returns:

root directory name, or null.

getIndexFilename

public String getIndexFilename()

Specified by:

getIndexFilename in interface MCollection

Overrides:

getIndexFilename in class CollectionAbstract

getFilesSorted

public Iterable<MFile> getFilesSorted()
                               throws IOException

Description copied from interface: MCollection

Get the current collection of MFile. if hasDateExtractor() == true, these will be sorted by Date, otherwise by path.

Returns:

current collection of MFile as an Iterable.

Throws:

IOException

getFileIterator

public CloseableIterator<MFile> getFileIterator()
                                         throws IOException

Description copied from interface: MCollection

Get the current collection of MFile, no guaranteed order. May be faster for large collections, use when order is not important.

     try (CloseableIterator iter = getFileIterator()) {
      while (iter.hasNext()) {
        MFile file = iter.next();
      }
    }
 

Returns:

current collection of MFile as an CloseableIterator.

Throws:

IOException

close

public void close()

Description copied from interface: MCollection

Close and release any resources. Do not make further calls on this object.

iterateOverMFileCollection

public void iterateOverMFileCollection(DirectoryCollection.Visitor visit)
                                throws IOException

Throws:

IOException