thredds.inventory.partition

Interface IndexReader

public interface IndexReader

Knows how to read ncx Index files, to decouple eg from GRIB

Since:

11/10/13

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IndexReader.AddChildCallback

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isPartition(Path indexFile) Open an ncx file and find out what type it is
boolean	readChildren(Path indexFile, IndexReader.AddChildCallback callback) Open a Partition ncx file and read children indexes
boolean	readMFiles(Path indexFile, List<MFile> result) Read the MFiles from a GribCollection index file

Method Detail

readChildren

boolean readChildren(Path indexFile,
                   IndexReader.AddChildCallback callback)
                     throws IOException

Open a Partition ncx file and read children indexes

Parameters:

indexFile - the Partition ncx index file to open

callback - for each child index, call this back

Returns:

true if indexFile is a partition collection

Throws:

IOException - on bad things

isPartition

boolean isPartition(Path indexFile)
                    throws IOException

Open an ncx file and find out what type it is

Parameters:

indexFile - the ncx index file to open

Returns:

true if its a partition type index

Throws:

IOException - on bad

readMFiles

boolean readMFiles(Path indexFile,
                 List<MFile> result)
                   throws IOException

Read the MFiles from a GribCollection index file

Parameters:

indexFile - the Partition ncx index file to open

result - put results in this list

Returns:

true if indexFile is a GribCollection collection, and read ok

Throws:

IOException