thredds.crawlabledataset.CrawlableDatasetFilter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
 *
 * Portions of this software were developed by the Unidata Program at the
 * University Corporation for Atmospheric Research.
 *
 * Access and use of this software shall impose the following obligations
 * and understandings on the user. The user is granted the right, without
 * any fee or cost, to use, copy, modify, alter, enhance and distribute
 * this software, and any derivative works thereof, and its supporting
 * documentation for any purpose whatsoever, provided that this entire
 * notice appears in all copies of the software, derivative works and
 * supporting documentation.  Further, UCAR requests that the user credit
 * UCAR/Unidata in any publications that result from the use of this
 * software or in any product that includes this software. The names UCAR
 * and/or Unidata, however, may not be used in any advertising or publicity
 * to endorse or promote any products or commercial entity unless specific
 * written permission is obtained from UCAR/Unidata. The user also
 * understands that UCAR/Unidata is not obligated to provide the user with
 * any support, consulting, training or assistance of any kind with regard
 * to the use, operation and performance of this software nor to provide
 * the user with any updates, revisions, new versions or "bug fixes."
 *
 * THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */
// $Id: CrawlableDatasetFilter.java 63 2006-07-12 21:50:51Z edavis $
package thredds.crawlabledataset;

/**
 * A filter for CrawlableDatasets.
 *
 * Instances of this interface may be passed to the
 * {@link CrawlableDataset#listDatasets(CrawlableDatasetFilter)}
 * method of the {@link CrawlableDataset} class.
 *
 * Implementation note:
 * The TDS framework (InvDatasetScan, etc) uses a public constructor
 * with a single configuration Object argument to instantiate instances
 * of a CrawlableDatasetFilter. If your implementation will not be used
 * in the TDS framework, other constructors can be used.
 *
 * @author edavis
 * @since Jun 22, 2005 9:30:43 AM
 * @see CrawlableDataset#listDatasets(CrawlableDatasetFilter)
 */
public interface CrawlableDatasetFilter
{
  /**
   * Test whether the specified CrawlableDataset should be included
   * in a list of CrawlableDatasets.
   *
   * @param dataset the CrawlableDataset to test for inclusion.
   * @return true if the given CrawlableDataset should be included, false otherwise.
   */
  public boolean accept( CrawlableDataset dataset);

  /**
   * Return the configuration object.
   *
   * @return the configuration Object (may be null).
   */
  public Object getConfigObject();
}