thredds.inventory

Class CollectionGeneral

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.CollectionGeneral

All Implemented Interfaces:

AutoCloseable, MCollection

public class CollectionGeneral
extends CollectionAbstract

Describe

Since:

2/7/14

Author:

caron

Nested Class Summary

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
CollectionGeneral(String collectionName, Path rootPath, 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.

Methods inherited from class thredds.inventory.CollectionAbstract

cleanName, extractDate, getAuxInfo, getCollectionName, getFilenames, getIndexFilename, getLastModified, getLatestFile, getProtoIndex, getRoot, 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

CollectionGeneral

public CollectionGeneral(String collectionName,
                 Path rootPath,
                 org.slf4j.Logger logger)

Method Detail

close

public void close()

Description copied from interface: MCollection

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

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