thredds.inventory.partition

Class DirectoryPartition

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.partition.DirectoryPartition

All Implemented Interfaces:

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

public class DirectoryPartition
extends CollectionAbstract
implements PartitionManager

A Partition that uses directories to do the partitioning. Intended for very large collections - does not scan more than one directory at a time. The partitions may be DirectoryPartitions or DirectoryCollections, figured out by DirectoryBuilder.factory()

Since:

11/9/13

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
DirectoryPartition(FeatureCollectionConfig config, java.nio.file.Path collectionDir, boolean isTop, IndexReader indexReader, 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.
java.lang.String	getIndexFilename()
java.lang.String	getRoot() Get common root directory of all MFiles in the collection - may be null
java.lang.Iterable<MCollection>	makePartitions(CollectionUpdateType forceCollection)
void	removePartition(MCollection partition)

Methods inherited from class thredds.inventory.CollectionAbstract

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

Methods inherited from interface thredds.inventory.MCollection

extractDate, getAuxInfo, getCollectionName, getFilenames, getLastModified, getLatestFile, getPartitionDate, getProtoIndex, hasDateExtractor, putAuxInfo

Constructor Detail

DirectoryPartition

public DirectoryPartition(FeatureCollectionConfig config,
                          java.nio.file.Path collectionDir,
                          boolean isTop,
                          IndexReader indexReader,
                          org.slf4j.Logger logger)

Method Detail

getIndexFilename

public java.lang.String getIndexFilename()

Specified by:

getIndexFilename in interface MCollection

Overrides:

getIndexFilename in class CollectionAbstract

makePartitions

public java.lang.Iterable<MCollection> makePartitions(CollectionUpdateType forceCollection)
                                               throws java.io.IOException

Specified by:

makePartitions in interface PartitionManager

Throws:

java.io.IOException

getRoot

public java.lang.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.

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.

Specified by:

getFilesSorted in interface MCollection

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();
      }
    }
 

Specified by:

getFileIterator in interface MCollection

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.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface MCollection

removePartition

public void removePartition(MCollection partition)

Specified by:

removePartition in interface PartitionManager