thredds.inventory

Class CollectionList

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.CollectionList

All Implemented Interfaces:

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

Direct Known Subclasses:

CollectionSingleFile

public class CollectionList
extends CollectionAbstract

MCollection that is initialized by specific list of MFiles. Sorted by name. no date extractor.

Since:

11/13/13

Nested Class Summary

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

CollectionAbstract.DateSorter, CollectionAbstract.MyStreamFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<MFile>	mfiles

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

Modifier	Constructor and Description
protected	CollectionList(java.lang.String collectionName, org.slf4j.Logger logger)
	CollectionList(java.lang.String collectionName, java.lang.String root, java.util.List<MFile> mfiles, org.slf4j.Logger logger)
	CollectionList(java.lang.String collectionName, java.lang.String list, org.slf4j.Logger logger)

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

Field Detail

mfiles

protected java.util.List<MFile> mfiles

Constructor Detail

CollectionList

public CollectionList(java.lang.String collectionName,
                      java.lang.String list,
                      org.slf4j.Logger logger)

CollectionList

public CollectionList(java.lang.String collectionName,
                      java.lang.String root,
                      java.util.List<MFile> mfiles,
                      org.slf4j.Logger logger)

CollectionList

protected CollectionList(java.lang.String collectionName,
                         org.slf4j.Logger logger)

Method Detail

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.