thredds.inventory

Class CollectionFiltered

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.CollectionFiltered

All Implemented Interfaces:

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

public class CollectionFiltered
extends CollectionAbstract

A decorator to filter an MCollection

Since:

3/12/2015

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, protoChoice, root, sfilter, startCollection

Constructor Summary

Constructors

Constructor and Description
CollectionFiltered(java.lang.String name, MCollection org, MFileFilter filter)

Method Summary

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.
java.lang.Iterable<MFile>	getFilesSorted() Get the current collection of MFile.

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, toString, wait, wait, wait

Constructor Detail

CollectionFiltered

public CollectionFiltered(java.lang.String name,
                          MCollection org,
                          MFileFilter filter)

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 java.lang.Iterable<MFile> getFilesSorted()
                                         throws java.io.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:

java.io.IOException

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