CrawlableDatasetAmazonS3 (NetCDF-Java All API v5.9.1)

java.lang.Object
- thredds.crawlabledataset.CrawlableDatasetFile
- - thredds.crawlabledataset.s3.CrawlableDatasetAmazonS3

All Implemented Interfaces:

CrawlableDataset
```
public class CrawlableDatasetAmazonS3
extends CrawlableDatasetFile
```
CrawlableDataset implementation that allows THREDDS to interact with datasets stored on Amazon S3.

Since:

2015/08/23

Constructor Summary

Constructors
Constructor and Description
`CrawlableDatasetAmazonS3(S3URI s3uri)`
`CrawlableDatasetAmazonS3(S3URI s3uri, java.lang.Object configObject)`
`CrawlableDatasetAmazonS3(S3URI s3uri, java.lang.Object configObject, ThreddsS3Client threddsS3Client)`
`CrawlableDatasetAmazonS3(java.lang.String path)`
`CrawlableDatasetAmazonS3(java.lang.String path, java.lang.Object configObject)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearCache()`
`boolean`	`equals(java.lang.Object other)`
`boolean`	`exists()` Return true if the dataset represented by this CrawlableDataset actually exists, null if it does not or an I/O error occurs.
`CrawlableDataset`	`getDescendant(java.lang.String relativePath)` Return the requested descendant of this dataset.
`java.io.File`	`getFile()` Provide access to the file that this CrawlableDataset represents.
`java.lang.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.
`java.lang.String`	`getPath()` Returns the dataset path.
`S3URI`	`getS3URI()`
`ThreddsS3Client`	`getThreddsS3Client()`
`int`	`hashCode()`
`boolean`	`isCollection()` Return true if the dataset is a collection dataset.
`java.util.Date`	`lastModified()` Returns the date that the dataset was last modified.
`long`	`length()` Returns the size of the dataset, in bytes.
`java.util.List<CrawlableDataset>`	`listDatasets()` Returns the list of CrawlableDatasets contained in this collection dataset.
`static void`	`setDefaultThreddsS3Client(ThreddsS3Client threddsS3Client)`
`java.lang.String`	`toString()`

Methods inherited from class thredds.crawlabledataset.CrawlableDatasetFile
getConfigObject, listDatasets

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

- Constructor Detail
  - CrawlableDatasetAmazonS3
```
public CrawlableDatasetAmazonS3(java.lang.String path)
```
  - CrawlableDatasetAmazonS3
```
public CrawlableDatasetAmazonS3(java.lang.String path,
                                java.lang.Object configObject)
```
  - CrawlableDatasetAmazonS3
```
public CrawlableDatasetAmazonS3(S3URI s3uri)
```
  - CrawlableDatasetAmazonS3
```
public CrawlableDatasetAmazonS3(S3URI s3uri,
                                java.lang.Object configObject)
```
  - CrawlableDatasetAmazonS3
```
public CrawlableDatasetAmazonS3(S3URI s3uri,
                                java.lang.Object configObject,
                                ThreddsS3Client threddsS3Client)
```
- Method Detail
  - setDefaultThreddsS3Client
```
public static void setDefaultThreddsS3Client(ThreddsS3Client threddsS3Client)
```
  - clearCache
```
public static void clearCache()
```
  - getS3URI
```
public S3URI getS3URI()
```
  - getThreddsS3Client
```
public ThreddsS3Client getThreddsS3Client()
```
  - getFile
```
public java.io.File getFile()
```
    Description copied from class: CrawlableDatasetFile
    
    Provide access to the file that this CrawlableDataset represents.
    
    Overrides:
    
    getFile in class CrawlableDatasetFile
    
    Returns:
    
    the file that this CrawlableDataset represents or null if it could not be obtained.
  - getPath
```
public java.lang.String getPath()
```
    Description copied from interface: CrawlableDataset
    
    Returns the dataset path.
    
    Specified by:
    
    getPath in interface CrawlableDataset
    
    Overrides:
    
    getPath in class CrawlableDatasetFile
    
    Returns:
    
    the dataset path.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: CrawlableDataset
    
    Returns the dataset name, i.e., the last part of the dataset path.
    
    Specified by:
    
    getName in interface CrawlableDataset
    
    Overrides:
    
    getName in class CrawlableDatasetFile
    
    Returns:
    
    the dataset name, i.e., the last part of the dataset path.
  - getParentDataset
```
public CrawlableDataset getParentDataset()
```
    Description copied from interface: CrawlableDataset
    
    Returns the parent CrawlableDataset or null if this dataset has no parent.
    
    Specified by:
    
    getParentDataset in interface CrawlableDataset
    
    Overrides:
    
    getParentDataset in class CrawlableDatasetFile
    
    Returns:
    
    the parent CrawlableDataset or null if this dataset has no parent.
  - getDescendant
```
public CrawlableDataset getDescendant(java.lang.String relativePath)
```
    Description copied from interface: CrawlableDataset
    
    Return the requested descendant of this dataset.
    
    Specified by:
    
    getDescendant in interface CrawlableDataset
    
    Overrides:
    
    getDescendant in class CrawlableDatasetFile
    
    Parameters:
    
    relativePath - the path, relative to this dataset, of the requested dataset.
    
    Returns:
    
    the requested descendant of this dataset.
  - exists
```
public boolean exists()
```
    Description copied from interface: CrawlableDataset
    
    Return true if the dataset represented by this CrawlableDataset actually exists, null if it does not or an I/O error occurs.
    
    Specified by:
    
    exists in interface CrawlableDataset
    
    Overrides:
    
    exists in class CrawlableDatasetFile
    
    Returns:
    
    true if the dataset represented by this CrawlableDataset actually exists.
  - isCollection
```
public boolean isCollection()
```
    Description copied from interface: CrawlableDataset
    
    Return true if the dataset is a collection dataset.
    
    Specified by:
    
    isCollection in interface CrawlableDataset
    
    Overrides:
    
    isCollection in class CrawlableDatasetFile
    
    Returns:
    
    true if the dataset is a collection dataset.
  - listDatasets
```
public java.util.List<CrawlableDataset> listDatasets()
                                              throws java.io.IOException
```
    Description copied from interface: CrawlableDataset
    
    Returns the list of CrawlableDatasets contained in this collection dataset. The returned list will be empty if this collection dataset does not contain any children datasets. If this dataset is not a collection dataset, this method returns null.
    
    Specified by:
    
    listDatasets in interface CrawlableDataset
    
    Overrides:
    
    listDatasets in class CrawlableDatasetFile
    
    Returns:
    
    Returns a list of the CrawlableDatasets contained in this collection dataset. The llist will be empty if no datasets are contained in this collection dataset.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs while accessing the children datasets.
  - length
```
public long length()
```
    Returns the size of the dataset, in bytes. Will be zero if this dataset is a collection or non-existent.
    
    Specified by:
    
    length in interface CrawlableDataset
    
    Overrides:
    
    length in class CrawlableDatasetFile
    
    Returns:
    
    the size of the dataset
  - lastModified
```
public java.util.Date lastModified()
```
    Returns the date that the dataset was last modified. Will be null if the dataset is a collection or non-existent.
    
    Specified by:
    
    lastModified in interface CrawlableDataset
    
    Overrides:
    
    lastModified in class CrawlableDatasetFile
    
    Returns:
    
    the date that the dataset was last modified
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class CrawlableDatasetFile
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class CrawlableDatasetAmazonS3

Constructor Summary

Method Summary

Methods inherited from class thredds.crawlabledataset.CrawlableDatasetFile

Methods inherited from class java.lang.Object

Constructor Detail

CrawlableDatasetAmazonS3

CrawlableDatasetAmazonS3

CrawlableDatasetAmazonS3

CrawlableDatasetAmazonS3

CrawlableDatasetAmazonS3

Method Detail

setDefaultThreddsS3Client

clearCache

getS3URI

getThreddsS3Client

getFile

getPath

getName

getParentDataset

getDescendant

exists

isCollection

listDatasets

length

lastModified

toString

equals

hashCode