thredds.inventory.partition

Class DirectoryBuilder

java.lang.Object

thredds.inventory.partition.DirectoryBuilder

public class DirectoryBuilder
extends Object

A Builder of Directory Partitions and Collections Each DirectoryBuilder is associated with one directory, and one ncx2 index. This may contain collections of files, or subdirectories. If there are subdirectories, these are children DirectoryBuilders.

Since:

11/10/13

Author:

caron

Constructor Summary

Constructors

Constructor and Description
DirectoryBuilder(String topCollectionName, Path dir, BasicFileAttributes attr) Create a DirectoryBuilder for the named directory
DirectoryBuilder(String topCollectionName, String dirFilename)

Method Summary

Methods

Modifier and Type	Method and Description
List<DirectoryBuilder>	constructChildren(IndexReader indexReader, CollectionUpdateType forceCollection) Find all children directories.
List<DirectoryBuilder>	constructChildrenFromIndex(IndexReader indexReader, boolean substituteParentDir)
static MCollection	factory(FeatureCollectionConfig config, Path topDir, IndexReader indexReader, org.slf4j.Logger logger)
boolean	findIndex() Find the index file, using its canonical name
List<DirectoryBuilder>	getChildren() May be null if constructChildren() was not called
Path	getDir() The directory that the partition covers
Path	getIndex() The ncx2 file
String	getPartitionName()
boolean	isLeaf(IndexReader indexReader) Read the index file to find out if a partition or collection of files
List<MFile>	readFilesFromIndex(IndexReader indexReader)
void	setChildrenConstructed(boolean childrenConstructed)
void	show(Formatter out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryBuilder

public DirectoryBuilder(String topCollectionName,
                String dirFilename)
                 throws IOException

Throws:

IOException

DirectoryBuilder

public DirectoryBuilder(String topCollectionName,
                Path dir,
                BasicFileAttributes attr)
                 throws IOException

Create a DirectoryBuilder for the named directory

Parameters:

topCollectionName - from config, name of the collection

dir - covers this directory

attr - file attributes, may be null

Throws:

IOException

Method Detail

factory

public static MCollection factory(FeatureCollectionConfig config,
                  Path topDir,
                  IndexReader indexReader,
                  org.slf4j.Logger logger)
                           throws IOException

Throws:

IOException

setChildrenConstructed

public void setChildrenConstructed(boolean childrenConstructed)

findIndex

public boolean findIndex()
                  throws IOException

Find the index file, using its canonical name

Returns:

true if found

Throws:

IOException

isLeaf

public boolean isLeaf(IndexReader indexReader)
               throws IOException

Read the index file to find out if a partition or collection of files

Parameters:

indexReader - reads the index

Returns:

true if partition, false if file collection

Throws:

IOException - on IO error

constructChildren

public List<DirectoryBuilder> constructChildren(IndexReader indexReader,
                                       CollectionUpdateType forceCollection)
                                         throws IOException

Find all children directories. Does not recurse. We separate this from the constructor so it can be done on demand Look for children by:

1. If index exists , use the children inside there./li>
2. (or) scan the directory for children partitions

Parameters:

indexReader - this reads the index, and calls AddChild.addchild() for each child

Returns:

children, may be empty but not null

Throws:

IOException

constructChildrenFromIndex

public List<DirectoryBuilder> constructChildrenFromIndex(IndexReader indexReader,
                                                boolean substituteParentDir)
                                                  throws IOException

Throws:

IOException

readFilesFromIndex

public List<MFile> readFilesFromIndex(IndexReader indexReader)
                               throws IOException

Throws:

IOException

getDir

public Path getDir()

The directory that the partition covers

Returns:

directory

getIndex

public Path getIndex()

The ncx2 file

Returns:

ncx2 file path

getChildren

public List<DirectoryBuilder> getChildren()

May be null if constructChildren() was not called

Returns:

children directories

getPartitionName

public String getPartitionName()

show

public void show(Formatter out)