CrawlableDatasetFile (NetCDF-Java Library 4.2.20 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

thredds.crawlabledataset
Class CrawlableDatasetFile

java.lang.Object
  thredds.crawlabledataset.CrawlableDatasetFile

All Implemented Interfaces:: CrawlableDataset

public class CrawlableDatasetFile
extends Object
implements CrawlableDataset
extends Object
implements CrawlableDataset

An implementation of CrawlableDataset where the dataset being represented is a local file (java.io.File).

The constructor extends the allowed form of a CrawlableDataset path to allow file paths to be given in their native formats including Unix (/my/file), Windows (c:\my\file), and UNC file paths (\\myhost\my\file). However, the resulting CrawlableDataset path is normalized to conform to the allowed form of the CrawlableDataset path.

This is the default implementation of CrawlableDataset used by CrawlableDatasetFactory if the class name handed to the createCrawlableDataset() method is null.

Since:: Jun 8, 2005 15:34:04 -0600
Author:: edavis

Constructor Summary
`CrawlableDatasetFile(File file)`
`CrawlableDatasetFile(String path, Object configObj)` Constructor required by CrawlableDatasetFactory.

Method Summary
`boolean`	`exists()` Return true if the dataset represented by this CrawlableDataset actually exists, null if it does not or an I/O error occurs.
`Object`	`getConfigObject()` Return the configuration Object (can be null).
`CrawlableDataset`	`getDescendant(String relativePath)` A factory method for getting a descendant of this datasets.
`File`	`getFile()` Provide access to the java.io.File that this CrawlableDataset represents.
`String`	`getName()` Returns the dataset name, i.e., the last part of the dataset path.
`CrawlableDataset`	`getParentDataset()` Returns the parent CrawlableDataset or null if this dataset has no parent.
`String`	`getPath()` Returns the dataset path.
`boolean`	`isCollection()` Return true if the dataset is a collection dataset.
`Date`	`lastModified()` Returns the date the dataset was last modified, null if unknown.
`long`	`length()` Returns the size in bytes of the dataset, -1 if unknown.
`List<CrawlableDataset>`	`listDatasets()` Returns the list of CrawlableDatasets contained in this collection dataset.
`List<CrawlableDataset>`	`listDatasets(CrawlableDatasetFilter filter)` Returns the list of CrawlableDatasets contained in this collection dataset that satisfy the given filter.
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

CrawlableDatasetFile

public CrawlableDatasetFile(String path,
                            Object configObj)

Constructor required by CrawlableDatasetFactory.

Parameters:: path - the path of the CrawlableDataset being constructed.; configObj - the configuration object required by CrawlableDatasetFactory; it is ignored.

CrawlableDatasetFile

public CrawlableDatasetFile(File file)

Method Detail

getFile

public File getFile()

Provide access to the java.io.File that this CrawlableDataset represents.

Returns:: the java.io.File that this CrawlableDataset represents.