thredds.inventory

Class CollectionManagerSingleFile

java.lang.Object

thredds.inventory.CollectionManagerAbstract

thredds.inventory.CollectionManagerSingleFile

All Implemented Interfaces:

CollectionManager

public class CollectionManagerSingleFile
extends CollectionManagerAbstract

A CollectionManager consisting of a single file

Since:

12/23/11

Author:

caron

Nested Class Summary

Nested classes/interfaces inherited from interface thredds.inventory.CollectionManager

CollectionManager.ChangeChecker, CollectionManager.Force, CollectionManager.TriggerEvent, CollectionManager.TriggerListener, CollectionManager.TriggerType

Field Summary

Fields inherited from class thredds.inventory.CollectionManagerAbstract

auxInfo, changeChecker, collectionName, protoChoice, recheck

Constructor Summary

Constructors

Constructor and Description
CollectionManagerSingleFile(MFile file)

Method Summary

Methods

Modifier and Type	Method and Description
CalendarDate	extractRunDate(MFile mfile) Use the date extractor to extract the date from the filename.
Iterable<MFile>	getFiles() Get the current collection of MFile.
long	getLastScanned() Get the last time scanned
String	getRoot() Get common root directory of all MFiles in the collection - may be null
CalendarDate	getStartCollection() The starting date of the collection.
boolean	hasDateExtractor() Does this CollectionManager have the ability to extract a date from the MFile ?
boolean	isScanNeeded() Compute whether rescan is needed, based on getRecheck(), and the LastScanned value.
boolean	scan(boolean sendEvent) Scan the collection.
boolean	scanIfNeeded() If isScanNeeded(), do a scan.

Methods inherited from class thredds.inventory.CollectionManagerAbstract

addEventListener, close, createListenerManager, deleteOld, enableMetadataManager, getAuxInfo, getCollectionName, getFilenames, getLatestFile, getMetadata, getOlderThanFilterInMSecs, getProtoIndex, getRecheck, isStatic, putAuxInfo, putMetadata, removeEventListener, resetProto, setChangeChecker, setStatic, updateNocheck

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionManagerSingleFile

public CollectionManagerSingleFile(MFile file)

Method Detail

getRoot

public String getRoot()

Description copied from interface: CollectionManager

Get common root directory of all MFiles in the collection - may be null

Returns:

root directory name, or null.

getLastScanned

public long getLastScanned()

Description copied from interface: CollectionManager

Get the last time scanned

Returns:

msecs since 1970

isScanNeeded

public boolean isScanNeeded()

Description copied from interface: CollectionManager

Compute whether rescan is needed, based on getRecheck(), and the LastScanned value.

Returns:

true if rescan is needed.

scanIfNeeded

public boolean scanIfNeeded()
                     throws IOException

Description copied from interface: CollectionManager

If isScanNeeded(), do a scan.

Returns:

true if scan was done, and anything changed.

Throws:

IOException - on io error

scan

public boolean scan(boolean sendEvent)
             throws IOException

Description copied from interface: CollectionManager

Scan the collection. Files may have been deleted or added since last time. If the MFile already exists in the current list, leave it in the list. If anything changes, send TriggerEvent(rescan) and return true Get the results from getFiles()

Returns:

true if anything actually changed.

Throws:

IOException - on I/O error

getFiles

public Iterable<MFile> getFiles()

Description copied from interface: CollectionManager

Get the current collection of MFile. You must call scan() first - this does not call scan(). if hasDateExtractor() == true, these will be sorted by Date, otherwise by path.

Returns:

current collection of MFile as an Iterable. May be empty, not null.

extractRunDate

public CalendarDate extractRunDate(MFile mfile)

Description copied from interface: CollectionManager

Use the date extractor to extract the date from the filename. Only call if hasDateExtractor() == true.

Parameters:

mfile - extract from here

Returns:

Date, or null if none

hasDateExtractor

public boolean hasDateExtractor()

Description copied from interface: CollectionManager

Does this CollectionManager have the ability to extract a date from the MFile ?

Returns:

true if CollectionManager has a DateExtractor

getStartCollection

public CalendarDate getStartCollection()

Description copied from interface: CollectionManager

The starting date of the collection. Only call if hasDateExtractor() == true.

Returns:

starting date of the collection