thredds.inventory

Class CollectionAbstract

java.lang.Object

thredds.inventory.CollectionAbstract

All Implemented Interfaces:

AutoCloseable, MCollection

Direct Known Subclasses:

CollectionGeneral, CollectionGlob, CollectionList, CollectionManagerAbstract, DirectoryCollection, DirectoryPartition, PartitionManagerFromIndexDirectory, PartitionManagerFromIndexList

public abstract class CollectionAbstract
extends Object
implements MCollection

Abstact superclass for Collections of MFiles.

Since:

11/20/13

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CollectionAbstract.DateSorter
class	CollectionAbstract.MyGribFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	auxInfo
static String	CATALOG
protected String	collectionName
protected DateExtractor	dateExtractor
static String	DIR
static String	FILE
protected MFileFilter	filter
static String	GLOB
protected long	lastModified
static String	LIST
protected org.slf4j.Logger	logger
static String	NCX_SUFFIX
protected FeatureCollectionConfig.ProtoChoice	protoChoice
protected String	root
protected DirectoryStream.Filter<Path>	sfilter
protected CalendarDate	startCollection

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static String	cleanName(String name)
CalendarDate	extractDate(MFile mfile) Use the date extractor to extract the date from the filename.
Object	getAuxInfo(String key)
String	getCollectionName() The name of the collection
List<String>	getFilenames() Sorted filename
String	getIndexFilename()
long	getLastModified() last time this collection was modified
MFile	getLatestFile() The latest file in the collection.
int	getProtoIndex(int n) Choose Proto dataset as index from [0..n-1], based on configuration.
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	isLeaf() Consider MCollections as a tree.
protected List<MFile>	makeFileListSorted()
static MCollection	open(String collectionName, String collectionSpec, String olderThan, Formatter errlog)
void	putAuxInfo(String key, Object value)
void	setDateExtractor(DateExtractor dateExtractor)
void	setLeaf(boolean isLeaf)
void	setMFileFilter(MFileFilter filter)
void	setRoot(String root)
void	setStreamFilter(DirectoryStream.Filter<Path> filter)

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

close, getFileIterator, getFilesSorted

Field Detail

NCX_SUFFIX

public static final String NCX_SUFFIX

See Also:

Constant Field Values

CATALOG

public static final String CATALOG

See Also:

Constant Field Values

DIR

public static final String DIR

See Also:

Constant Field Values

FILE

public static final String FILE

See Also:

Constant Field Values

LIST

public static final String LIST

See Also:

Constant Field Values

GLOB

public static final String GLOB

See Also:

Constant Field Values

collectionName

protected String collectionName

root

protected String root

logger

protected final org.slf4j.Logger logger

protoChoice

protected FeatureCollectionConfig.ProtoChoice protoChoice

auxInfo

protected Map<String,Object> auxInfo

dateExtractor

protected DateExtractor dateExtractor

startCollection

protected CalendarDate startCollection

lastModified

protected long lastModified

filter

protected MFileFilter filter

sfilter

protected DirectoryStream.Filter<Path> sfilter

Constructor Detail

CollectionAbstract

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

Method Detail

open

public static MCollection open(String collectionName,
               String collectionSpec,
               String olderThan,
               Formatter errlog)
                        throws IOException

Throws:

IOException

cleanName

public static String cleanName(String name)

isLeaf

public boolean isLeaf()

Description copied from interface: MCollection

Consider MCollections as a tree. At the leaves are a single mfile or mfile collection. A leaf MCollection will be a GC if it has a single runtime, or a PofGC otherwise. A non-leaf is a directory with other directories under it. It will either be a PofGC (Partition of GC) or PofP (Partition of Partition).

Specified by:

isLeaf in interface MCollection

Returns:

if leaf collection

setLeaf

public void setLeaf(boolean isLeaf)

getCollectionName

public String getCollectionName()

Description copied from interface: MCollection

The name of the collection

Specified by:

getCollectionName in interface MCollection

Returns:

name of the collection

getIndexFilename

public String getIndexFilename()

Specified by:

getIndexFilename in interface MCollection

setMFileFilter

public void setMFileFilter(MFileFilter filter)

setStreamFilter

public void setStreamFilter(DirectoryStream.Filter<Path> filter)

getRoot

public 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

Returns:

root directory name, or null.

setRoot

public void setRoot(String root)

getLastModified

public long getLastModified()

Description copied from interface: MCollection

last time this collection was modified

Specified by:

getLastModified in interface MCollection

Returns:

msess since epoch

getLatestFile

public MFile getLatestFile()
                    throws IOException

Description copied from interface: MCollection

The latest file in the collection. Only call if hasDateExtractor() == true.

Specified by:

getLatestFile in interface MCollection

Returns:

latest file in the collection

Throws:

IOException

getFilenames

public List<String> getFilenames()
                          throws IOException

Description copied from interface: MCollection

Sorted filename

Specified by:

getFilenames in interface MCollection

Returns:

Sorted filename

Throws:

IOException

extractDate

public CalendarDate extractDate(MFile mfile)

Description copied from interface: MCollection

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

Specified by:

extractDate in interface MCollection

Parameters:

mfile - extract from here

Returns:

Date, or null if none

hasDateExtractor

public boolean hasDateExtractor()

Description copied from interface: MCollection

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

Specified by:

hasDateExtractor in interface MCollection

Returns:

true if CollectionManager has a DateExtractor

setDateExtractor

public void setDateExtractor(DateExtractor dateExtractor)

getStartCollection

public CalendarDate getStartCollection()

Description copied from interface: MCollection

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

Specified by:

getStartCollection in interface MCollection

Returns:

starting date of the collection

getAuxInfo

public Object getAuxInfo(String key)

Specified by:

getAuxInfo in interface MCollection

putAuxInfo

public void putAuxInfo(String key,
              Object value)

Specified by:

putAuxInfo in interface MCollection

getProtoIndex

public int getProtoIndex(int n)

Description copied from interface: MCollection

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

Specified by:

getProtoIndex in interface MCollection

Parameters:

n - size to choose from

Returns:

index within range [0..n-1]

makeFileListSorted

protected List<MFile> makeFileListSorted()
                                  throws IOException

Throws:

IOException