thredds.inventory

Class MCollection

java.lang.Object

thredds.inventory.MCollection

@Immutable
public class MCollection
extends Object

Configuration object for a collection of managed files.

Author:

caron

Constructor Summary

Constructors

Constructor and Description
MCollection(String name, String dirName, boolean wantSubdirs, List<MFileFilter> filters, Object auxInfo) Constructor
MCollection(String name, String dirName, boolean wantSubdirs, MFileFilter ff, Object auxInfo) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(MFile file)
Object	getAuxInfo()
String	getDirectoryName()
MFileFilter	getFileFilter()
String	getName()
MCollection	subdir(MFile child)
String	toString()
boolean	wantSubdirs()

Methods inherited from class java.lang.Object

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

Constructor Detail

MCollection

public MCollection(String name,
           String dirName,
           boolean wantSubdirs,
           List<MFileFilter> filters,
           Object auxInfo)

Constructor

Parameters:

name - name of collection

dirName - top directory name

wantSubdirs - if want subdirectories

filters - optional list of MFileFilter (may be null) - applies only to non-directories

auxInfo - optional info added to each MFile

MCollection

public MCollection(String name,
           String dirName,
           boolean wantSubdirs,
           MFileFilter ff,
           Object auxInfo)

Constructor

Parameters:

name - name of collection

dirName - top directory name

wantSubdirs - if want subdirectories

ff - optional FilenameFilter (may be null) - applies only to non-directories

auxInfo - optional info added to each MFile

Method Detail

subdir

public MCollection subdir(MFile child)

getName

public String getName()

getDirectoryName

public String getDirectoryName()

wantSubdirs

public boolean wantSubdirs()

getFileFilter

public MFileFilter getFileFilter()

accept

public boolean accept(MFile file)

toString

public String toString()

Overrides:

toString in class Object

getAuxInfo

public Object getAuxInfo()