thredds.client.catalog.writer

Class CatalogCrawler

java.lang.Object

thredds.client.catalog.writer.CatalogCrawler

public class CatalogCrawler
extends java.lang.Object

Crawl client catalogs

Since:

1/11/2015

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CatalogCrawler.Filter
static interface	CatalogCrawler.Listener
static class	CatalogCrawler.Type

Constructor Summary

Constructors

Constructor and Description
CatalogCrawler(CatalogCrawler.Type type, int max, CatalogCrawler.Filter filter, CatalogCrawler.Listener listen) Constructor.

Method Summary

Modifier and Type	Method and Description
int	crawl(Catalog cat, CancelTask task, java.io.PrintWriter out, java.lang.Object context, Indent indent) Crawl a catalog thats already been opened.
int	crawl(java.lang.String catUrl, CancelTask task, java.io.PrintWriter out, java.lang.Object context) Open a catalog and crawl (depth first) all the datasets in it.
int	getNumReadFailures()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogCrawler

public CatalogCrawler(CatalogCrawler.Type type,
                      int max,
                      CatalogCrawler.Filter filter,
                      CatalogCrawler.Listener listen)

Constructor.

Parameters:

type - CatalogCrawler.Type

max - return max (random_direct_max only)

filter - dont process this dataset or its descendants. may be null

listen - each dataset gets passed to the listener

Method Detail

crawl

public int crawl(java.lang.String catUrl,
                 CancelTask task,
                 java.io.PrintWriter out,
                 java.lang.Object context)
          throws java.io.IOException

Open a catalog and crawl (depth first) all the datasets in it. Close catalogs and release their resources as you.

Parameters:

catUrl - url of catalog to open

task - user can cancel the task (may be null)

out - send status messages to here (may be null)

context - caller can pass this object in (used for thread safety)

Returns:

number of catalogs (this + catrefs) opened and crawled

Throws:

java.io.IOException

crawl

public int crawl(Catalog cat,
                 CancelTask task,
                 java.io.PrintWriter out,
                 java.lang.Object context,
                 Indent indent)
          throws java.io.IOException

Crawl a catalog thats already been opened. When you get to a dataset containing leaf datasets, do all, only the first, or a randomly chosen one.

Parameters:

cat - the catalog

task - user can cancel the task (may be null)

out - send status messages to here (may be null)

context - caller can pass this object in (used for thread safety)

Returns:

number of catalog references opened and crawled

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNumReadFailures

public int getNumReadFailures()