thredds.inventory

Class CollectionManagerAbstract

java.lang.Object

thredds.inventory.CollectionManagerAbstract

All Implemented Interfaces:

CollectionManager

Direct Known Subclasses:

CollectionManagerSingleFile, MFileCollectionManager

public abstract class CollectionManagerAbstract
extends Object
implements CollectionManager

Abstract superclass for implementations of CollectionManager.

Since:

Jan 19, 2010

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

Modifier and Type	Field and Description
protected Map<String,Object>	auxInfo
protected CollectionManager.ChangeChecker	changeChecker
protected String	collectionName
protected org.slf4j.Logger	logger
protected FeatureCollectionConfig.ProtoChoice	protoChoice
protected TimeDuration	recheck

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionManagerAbstract(String collectionName, org.slf4j.Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(CollectionManager.TriggerListener l) Register to get Trigger events
static String	cleanName(String name)
void	close() Close and release any resources.
protected void	createListenerManager()
protected void	deleteOld(Map<String,MFile> newMap)
static void	enableMetadataManager()
Object	getAuxInfo(String key)
String	getCollectionName() The name of the collection
List<String>	getFilenames()
MFile	getLatestFile()
byte[]	getMetadata(MFile file, String key)
long	getOlderThanFilterInMSecs() The "olderThan" amount in seconds.
int	getProtoIndex(int n) Choose Proto dataset as index from [0..n-1], based on configuration.
TimeDuration	getRecheck() Get how often to rescan
boolean	isStatic() static means doesnt need to be monitored for changes; can be externally triggered, or read in at startup.
void	putAuxInfo(String key, Object value)
void	putMetadata(MFile file, String key, byte[] value)
void	removeEventListener(CollectionManager.TriggerListener l)
void	resetProto() Called by external program to tell the manager its time to switch the proto dataset.
void	setChangeChecker(CollectionManager.ChangeChecker strat)
void	setStatic(boolean aStatic)
void	updateNocheck() send event TriggerType.updateNocheck, which calls call InvDatasetFeatureCollection.update(CollectionManager.Force.nocheck)

Methods inherited from class java.lang.Object

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

Methods inherited from interface thredds.inventory.CollectionManager

extractRunDate, getFiles, getLastChanged, getLastScanned, getRoot, getStartCollection, hasDateExtractor, isScanNeeded, scan, scanIfNeeded, setFiles

Field Detail

collectionName

protected String collectionName

logger

protected final org.slf4j.Logger logger

recheck

protected TimeDuration recheck

protoChoice

protected FeatureCollectionConfig.ProtoChoice protoChoice

auxInfo

protected Map<String,Object> auxInfo

changeChecker

protected CollectionManager.ChangeChecker changeChecker

Constructor Detail

CollectionManagerAbstract

protected CollectionManagerAbstract(String collectionName,
                         org.slf4j.Logger logger)

Method Detail

cleanName

public static String cleanName(String name)

isStatic

public boolean isStatic()

Description copied from interface: CollectionManager

static means doesnt need to be monitored for changes; can be externally triggered, or read in at startup. true if no recheckAfter and no update.rescan

Specified by:

isStatic in interface CollectionManager

Returns:

if static

setStatic

public void setStatic(boolean aStatic)

getCollectionName

public String getCollectionName()

Description copied from interface: CollectionManager

The name of the collection

Specified by:

getCollectionName in interface CollectionManager

Returns:

name of the collection

getRecheck

public TimeDuration getRecheck()

Description copied from interface: CollectionManager

Get how often to rescan

Specified by:

getRecheck in interface CollectionManager

Returns:

time duration of rescan period, or null if none.

getOlderThanFilterInMSecs

public long getOlderThanFilterInMSecs()

Description copied from interface: CollectionManager

The "olderThan" amount in seconds. Files are excluded if they have been modified within this amount of time. However once in the collection they are not removed. Really this is handled by the manager, but this is exposed so that others (eg DatasetScan) can be consistent.

Specified by:

getOlderThanFilterInMSecs in interface CollectionManager

Returns:

olderThan" amount in seconds, or < 0 to mean this filter is not present

close

public void close()

Description copied from interface: CollectionManager

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

Specified by:

close in interface CollectionManager

getFilenames

public List<String> getFilenames()

Specified by:

getFilenames in interface CollectionManager

getLatestFile

public MFile getLatestFile()

Specified by:

getLatestFile in interface CollectionManager

setChangeChecker

public void setChangeChecker(CollectionManager.ChangeChecker strat)

Specified by:

setChangeChecker in interface CollectionManager

getAuxInfo

public Object getAuxInfo(String key)

Specified by:

getAuxInfo in interface CollectionManager

putAuxInfo

public void putAuxInfo(String key,
              Object value)

Specified by:

putAuxInfo in interface CollectionManager

getProtoIndex

public int getProtoIndex(int n)

Description copied from interface: CollectionManager

Choose Proto dataset as index from [0..n-1], based on configuration.

Specified by:

getProtoIndex in interface CollectionManager

Parameters:

n - size to choose from

Returns:

index within range [0..n-1]

enableMetadataManager

public static void enableMetadataManager()

deleteOld

protected void deleteOld(Map<String,MFile> newMap)

putMetadata

public void putMetadata(MFile file,
               String key,
               byte[] value)

getMetadata

public byte[] getMetadata(MFile file,
                 String key)

updateNocheck

public void updateNocheck()
                   throws IOException

Description copied from interface: CollectionManager

send event TriggerType.updateNocheck, which calls call InvDatasetFeatureCollection.update(CollectionManager.Force.nocheck)

Specified by:

updateNocheck in interface CollectionManager

Throws:

IOException

resetProto

public void resetProto()

Description copied from interface: CollectionManager

Called by external program to tell the manager its time to switch the proto dataset. a TriggerEvent.proto is sent to any listeners.

Specified by:

resetProto in interface CollectionManager

addEventListener

public void addEventListener(CollectionManager.TriggerListener l)

Description copied from interface: CollectionManager

Register to get Trigger events

Specified by:

addEventListener in interface CollectionManager

Parameters:

l - listener

removeEventListener

public void removeEventListener(CollectionManager.TriggerListener l)

Specified by:

removeEventListener in interface CollectionManager

createListenerManager

protected void createListenerManager()