thredds.inventory.partition

Class DirectoryBuilder

java.lang.Object

thredds.inventory.partition.DirectoryBuilder

public class DirectoryBuilder
extends java.lang.Object

A Builder of DirectoryPartitions and DirectoryCollections. Each DirectoryBuilder is associated with one directory, and one ncx index. This may contain collections of files (MFiles in a DirectoryCollection), or subdirectories (MCollections in a DirectoryPartition).

Since:

11/10/13

Constructor Summary

Constructors

Constructor and Description
DirectoryBuilder(java.lang.String topCollectionName, java.nio.file.Path dir, java.nio.file.attribute.BasicFileAttributes attr, java.lang.String suffix) Create a DirectoryBuilder for the named directory
DirectoryBuilder(java.lang.String topCollectionName, java.lang.String dirFilename, java.lang.String suffix)

Method Summary

Modifier and Type	Method and Description
java.util.List<DirectoryBuilder>	constructChildren(IndexReader indexReader, CollectionUpdateType forceCollection) Find all children directories.
java.util.List<DirectoryBuilder>	constructChildrenFromIndex(IndexReader indexReader, boolean substituteParentDir)
static MCollection	factory(FeatureCollectionConfig config, java.nio.file.Path topDir, boolean isTop, IndexReader indexReader, java.lang.String suffix, org.slf4j.Logger logger)
boolean	findIndex() Find the index file, using its canonical name
java.util.List<DirectoryBuilder>	getChildren() May be null if constructChildren() was not called
java.nio.file.Path	getDir() The directory that the partition covers
java.nio.file.Path	getIndex() The ncx2 file
java.lang.String	getPartitionName()
java.util.List<MFile>	readFilesFromIndex(IndexReader indexReader)
void	show(java.util.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(java.lang.String topCollectionName,
                        java.lang.String dirFilename,
                        java.lang.String suffix)
                 throws java.io.IOException

Throws:

java.io.IOException

DirectoryBuilder

public DirectoryBuilder(java.lang.String topCollectionName,
                        java.nio.file.Path dir,
                        java.nio.file.attribute.BasicFileAttributes attr,
                        java.lang.String suffix)
                 throws java.io.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:

java.io.IOException

Method Detail

factory

public static MCollection factory(FeatureCollectionConfig config,
                                  java.nio.file.Path topDir,
                                  boolean isTop,
                                  IndexReader indexReader,
                                  java.lang.String suffix,
                                  org.slf4j.Logger logger)
                           throws java.io.IOException

Throws:

java.io.IOException

findIndex

public boolean findIndex()
                  throws java.io.IOException

Find the index file, using its canonical name

Returns:

true if found

Throws:

java.io.IOException

constructChildren

public java.util.List<DirectoryBuilder> constructChildren(IndexReader indexReader,
                                                          CollectionUpdateType forceCollection)
                                                   throws java.io.IOException

Find all children directories. Does not recurse. We separate this from the constructor so it can be done on demand Public for debugging. 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:

java.io.IOException

constructChildrenFromIndex

public java.util.List<DirectoryBuilder> constructChildrenFromIndex(IndexReader indexReader,
                                                                   boolean substituteParentDir)
                                                            throws java.io.IOException

Throws:

java.io.IOException

readFilesFromIndex

public java.util.List<MFile> readFilesFromIndex(IndexReader indexReader)
                                         throws java.io.IOException

Throws:

java.io.IOException

getDir

public java.nio.file.Path getDir()

The directory that the partition covers

Returns:

directory

getIndex

public java.nio.file.Path getIndex()

The ncx2 file

Returns:

ncx2 file path

getChildren

public java.util.List<DirectoryBuilder> getChildren()

May be null if constructChildren() was not called

Returns:

children directories

getPartitionName

public java.lang.String getPartitionName()

show

public void show(java.util.Formatter out)