thredds.inventory

Class CollectionListRange

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.CollectionListRange

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, MCollection

public class CollectionListRange
extends CollectionAbstract

Collection defined by a list of files, wit a [start, end) date range

Since:

12/23/2014

Nested Class Summary

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

CollectionAbstract.DateSorter, CollectionAbstract.MyStreamFilter

Field Summary

Fields inherited from class thredds.inventory.CollectionAbstract

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

Constructor Summary

Constructors

Constructor and Description
CollectionListRange(java.lang.String collectionName, java.lang.String root, CalendarDate startDate, CalendarDate endDate, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method and Description
void	addFile(MFile mfile)
void	close() Close and release any resources.
CalendarDate	getEndDate()
CloseableIterator<MFile>	getFileIterator() Get the current collection of MFile, no guaranteed order.
java.lang.Iterable<MFile>	getFilesSorted() Get the current collection of MFile.
CalendarDate	getStartDate()
java.lang.String	toString()

Methods inherited from class thredds.inventory.CollectionAbstract

cleanName, extractDate, getAuxInfo, getCollectionName, getFilenames, getIndexFilename, getLastModified, getLatestFile, getPartitionDate, getProtoIndex, getRoot, hasDateExtractor, makeFileListSorted, open, parseOlderThanString, putAuxInfo, setDateExtractor, setRoot, setStreamFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionListRange

public CollectionListRange(java.lang.String collectionName,
                           java.lang.String root,
                           CalendarDate startDate,
                           CalendarDate endDate,
                           org.slf4j.Logger logger)

Method Detail

getStartDate

public CalendarDate getStartDate()

getEndDate

public CalendarDate getEndDate()

addFile

public void addFile(MFile mfile)

getFilesSorted

public java.lang.Iterable<MFile> getFilesSorted()

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.

getFileIterator

public CloseableIterator<MFile> getFileIterator()
                                         throws java.io.IOException

Description copied from interface: MCollection

Get the current collection of MFile, no guaranteed order. May be faster than getFilesSorted() 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:

java.io.IOException

close

public void close()

Description copied from interface: MCollection

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object