DatasetSource (NetCDF-Java All API v5.5.3)

java.lang.Object
- thredds.cataloggen.config.DatasetSource

Direct Known Subclasses:

DodsDirDatasetSource, DodsFileServerDatasetSource, GrADSDataServerDatasetSource, LocalDatasetSource
```
public abstract class DatasetSource
extends java.lang.Object
```
Represents a source from which a collection of datasets can be found and expanded into an InvCatalog. Besides expanding the DatasetSource, the datasets in the resulting catalog can be named, sorted, and have metadata added to them.
Currently an abstract class, three abstract methods must be implemented to make a concrete subclass. These methods are getTopLevelDataset():InvDataset, isCollection():boolean, and expandThisLevel(InvDataset):List. (In previous versions, expandThisType():void was the only abstract method.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected InvDataset`	`accessPointDataset` Top-level dataset of the catalog generated by this DatasetSource.
`protected boolean`	`addDatasetSize`
`protected java.util.List`	`catalogRefInfoList` Information on the catalogRefs in the resulting catalog.
`protected boolean`	`createCatalogRefs`
`protected java.util.List`	`datasetEnhancerList`
`protected java.util.List`	`datasetFilterList`
`protected java.util.List`	`datasetNamerList`
`protected DatasetSorter`	`datasetSorter`
`protected boolean`	`isValid`
`protected java.lang.StringBuffer`	`msgLog`
`protected InvCatalog`	`resultingCatalog` The catalog that results from expanding this DatasetSource.
`protected DatasetSourceType`	`type`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DatasetSource()
Default Constructor

Constructors
Modifier	Constructor and Description
`protected`	`DatasetSource()` Default Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDatasetEnhancer(DatasetEnhancer1 dsEnhancer)`
`void`	`addDatasetFilter(DatasetFilter datasetFilter)`
`void`	`addDatasetNamer(DatasetNamer datasetNamer)`
`protected abstract InvDataset`	`createDataset(java.lang.String datasetLocation, java.lang.String prefixUrlPath)` Creates an InvDataset to represent the dataset at the given location on this DatasetSource.
`protected abstract InvCatalog`	`createSkeletonCatalog(java.lang.String prefixUrlPath)` Return a skeleton InvCatalog for this DatasetSource.
`boolean`	`equals(java.lang.Object o)`
`InvDataset`	`expand()` Crawl this DatasetSource and generate a new InvCatalog, return the top-level InvDataset.
`InvDataset`	`expand(java.util.List accessPoints)`
`protected abstract java.util.List`	`expandThisLevel(InvDataset collectionDataset, java.lang.String prefixUrlPath)` Return a list of the InvDatasets contained in the given collection dataset on this DatasetSource.
`InvCatalog`	`fullExpand()` Crawl this DatasetSource and generate a new InvCatalog with all datasets named, sorted, and organized as defined by this DatasetSource, return the newly generated InvCatalog.
`java.lang.String`	`getAccessPoint()`
`java.util.List`	`getCatalogRefInfoList()`
`java.util.List`	`getDatasetEnhancerList()`
`java.util.List`	`getDatasetFilterList()`
`java.util.List`	`getDatasetNamerList()`
`DatasetSorter`	`getDatasetSorter()`
`java.lang.String`	`getName()`
`java.lang.String`	`getPrefixUrlPath()`
`InvCatalog`	`getResultingCatalog()`
`ResultService`	`getResultService()`
`DatasetSourceStructure`	`getStructure()`
`DatasetSourceType`	`getType()`
`int`	`hashCode()`
`boolean`	`isAddDatasetSize()`
`protected abstract boolean`	`isCollection(InvDataset dataset)` Return true if the given dataset is a collection dataset, false otherwise.
`boolean`	`isCreateCatalogRefs()`
`boolean`	`isFlatten()`
`static DatasetSource`	`newDatasetSource(java.lang.String name, DatasetSourceType type, DatasetSourceStructure structure, java.lang.String accessPoint, ResultService resultService)` Factory method for this abstract class.
`void`	`setAccessPoint(java.lang.String accessPoint)`
`void`	`setAddDatasetSize(boolean addDatasetSize)`
`void`	`setCreateCatalogRefs(boolean createCatalogRefs)`
`void`	`setDatasetSorter(DatasetSorter datasetSorter)`
`void`	`setName(java.lang.String name)`
`void`	`setPrefixUrlPath(java.lang.String prefixUrlPath)`
`void`	`setResultService(ResultService resultService)`
`void`	`setStructure(DatasetSourceStructure structure)`
`java.lang.String`	`toString()` string representation
`boolean`	`validate(java.lang.StringBuilder out)`

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

- Field Detail
  - resultingCatalog
```
protected InvCatalog resultingCatalog
```
    The catalog that results from expanding this DatasetSource.
  - accessPointDataset
```
protected InvDataset accessPointDataset
```
    Top-level dataset of the catalog generated by this DatasetSource.
  - catalogRefInfoList
```
protected java.util.List catalogRefInfoList
```
    Information on the catalogRefs in the resulting catalog.
  - type
```
protected DatasetSourceType type
```
  - createCatalogRefs
```
protected boolean createCatalogRefs
```
  - datasetNamerList
```
protected java.util.List datasetNamerList
```
  - datasetFilterList
```
protected java.util.List datasetFilterList
```
  - datasetSorter
```
protected DatasetSorter datasetSorter
```
  - datasetEnhancerList
```
protected java.util.List datasetEnhancerList
```
  - addDatasetSize
```
protected boolean addDatasetSize
```
  - isValid
```
protected boolean isValid
```
  - msgLog
```
protected java.lang.StringBuffer msgLog
```
- Constructor Detail
  - DatasetSource
```
protected DatasetSource()
```
    Default Constructor
- Method Detail
  - newDatasetSource
```
public static final DatasetSource newDatasetSource(java.lang.String name,
                                                   DatasetSourceType type,
                                                   DatasetSourceStructure structure,
                                                   java.lang.String accessPoint,
                                                   ResultService resultService)
```
    Factory method for this abstract class.
    
    Parameters:
    
    name -
    
    type -
    
    structure -
    
    accessPoint -
    
    Throws:
    
    java.lang.IllegalArgumentException - if DatasetSource type is null or unsupported.
  - getResultingCatalog
```
public InvCatalog getResultingCatalog()
```
  - getCatalogRefInfoList
```
public java.util.List getCatalogRefInfoList()
```
  - getName
```
public java.lang.String getName()
```
  - setName
```
public void setName(java.lang.String name)
```
  - getType
```
public DatasetSourceType getType()
```
  - getStructure
```
public DatasetSourceStructure getStructure()
```
  - setStructure
```
public void setStructure(DatasetSourceStructure structure)
```
  - isFlatten
```
public boolean isFlatten()
```
  - getAccessPoint
```
public java.lang.String getAccessPoint()
```
  - setAccessPoint
```
public void setAccessPoint(java.lang.String accessPoint)
```
  - getPrefixUrlPath
```
public java.lang.String getPrefixUrlPath()
```
  - setPrefixUrlPath
```
public void setPrefixUrlPath(java.lang.String prefixUrlPath)
```
  - getResultService
```
public ResultService getResultService()
```
  - setResultService
```
public void setResultService(ResultService resultService)
```
  - isCreateCatalogRefs
```
public boolean isCreateCatalogRefs()
```
  - setCreateCatalogRefs
```
public void setCreateCatalogRefs(boolean createCatalogRefs)
```
  - getDatasetNamerList
```
public java.util.List getDatasetNamerList()
```
  - addDatasetNamer
```
public void addDatasetNamer(DatasetNamer datasetNamer)
```
  - getDatasetFilterList
```
public java.util.List getDatasetFilterList()
```
  - addDatasetFilter
```
public void addDatasetFilter(DatasetFilter datasetFilter)
```
  - getDatasetSorter
```
public DatasetSorter getDatasetSorter()
```
  - setDatasetSorter
```
public void setDatasetSorter(DatasetSorter datasetSorter)
```
  - getDatasetEnhancerList
```
public java.util.List getDatasetEnhancerList()
```
  - addDatasetEnhancer
```
public void addDatasetEnhancer(DatasetEnhancer1 dsEnhancer)
```
  - isAddDatasetSize
```
public boolean isAddDatasetSize()
```
  - setAddDatasetSize
```
public void setAddDatasetSize(boolean addDatasetSize)
```
  - validate
```
public boolean validate(java.lang.StringBuilder out)
```
  - toString
```
public java.lang.String toString()
```
    string representation
    
    Overrides:
    
    toString in class java.lang.Object
  - expand
```
public InvDataset expand()
                  throws java.io.IOException
```
    Crawl this DatasetSource and generate a new InvCatalog, return the top-level InvDataset. Each object found on the DatasetSource becomes an InvDataset if it is accepted by at least one DatasetFilter. The catalog reflects the heirarchical structure of the DatasetSource. All datasets are named with the location of the object they represent on the dataset source.
    
    Returns:
    
    the top-level InvDataset in the generated InvCatalog.
    
    Throws:
    
    java.io.IOException - if the accessPoint for this DatasetSource is not a container dataset.
  - expand
```
public InvDataset expand(java.util.List accessPoints)
                  throws java.io.IOException
```
    Parameters:
    
    accessPoints -
    
    Returns:
    
    the top-level dataset
    
    Throws:
    
    java.io.IOException - if the main access point for this DatasetSource is not a container dataset or any of the given access points do not exist or are not under the main access point.
  - fullExpand
```
public InvCatalog fullExpand()
                      throws java.io.IOException
```
    Crawl this DatasetSource and generate a new InvCatalog with all datasets named, sorted, and organized as defined by this DatasetSource, return the newly generated InvCatalog.
    
    Returns:
    
    the generated InvCatalog.
    
    Throws:
    
    java.io.IOException - if DatasetSource does not reference a container dataset.
  - createDataset
```
protected abstract InvDataset createDataset(java.lang.String datasetLocation,
                                            java.lang.String prefixUrlPath)
                                     throws java.io.IOException
```
    Creates an InvDataset to represent the dataset at the given location on this DatasetSource.
    
    Parameters:
    
    datasetLocation - a String indicating the location of a dataset.
    
    prefixUrlPath - a path name to be prefixed on the urlPath
    
    Returns:
    
    an InvDataset for the given dataset location.
    
    Throws:
    
    java.io.IOException - if the dataset location does not correspond to an actual dataset or is not below the accessPointHeader directory.
    
    java.lang.NullPointerException - if the given dataset location is null.
  - isCollection
```
protected abstract boolean isCollection(InvDataset dataset)
```
    Return true if the given dataset is a collection dataset, false otherwise.
    
    Parameters:
    
    dataset - - the InvDataset to test for being a collection dataset.
    
    Returns:
    
    true if the given dataset is a collection dataset, false otherwise.
    
    Throws:
    
    java.lang.NullPointerException - if the given InvDataset is null.
    
    java.lang.ClassCastException - if the given InvDataset is not a LocalInvDataset.
  - createSkeletonCatalog
```
protected abstract InvCatalog createSkeletonCatalog(java.lang.String prefixUrlPath)
                                             throws java.io.IOException
```
    Return a skeleton InvCatalog for this DatasetSource. The skeleton catalog is unnamed with a single top-level dataset representing the DatasetSource accessPoint and a service built from the DatasetSource ResultService.
    
    Parameters:
    
    prefixUrlPath -
    
    Returns:
    
    a skeleton InvCatalog for this DatasetSource.
    
    Throws:
    
    java.io.IOException - if top-level dataset does not exist or is not a collection dataset.
  - expandThisLevel
```
protected abstract java.util.List expandThisLevel(InvDataset collectionDataset,
                                                  java.lang.String prefixUrlPath)
```
    Return a list of the InvDatasets contained in the given collection dataset on this DatasetSource.
    
    Parameters:
    
    collectionDataset - - the collection dataset to be expanded.
    
    prefixUrlPath -
    
    Returns:
    
    A list of the InvDatasets contained in the given collection dataset.
    
    Throws:
    
    java.lang.IllegalArgumentException - when given dataset is not a collection dataset.
    
    java.lang.NullPointerException - if given dataset is null.
    
    java.lang.ClassCastException - if the given InvDataset is not a LocalInvDataset.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class DatasetSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

resultingCatalog

accessPointDataset

catalogRefInfoList

type

createCatalogRefs

datasetNamerList

datasetFilterList

datasetSorter

datasetEnhancerList

addDatasetSize

isValid

msgLog

Constructor Detail

DatasetSource

Method Detail

newDatasetSource

getResultingCatalog

getCatalogRefInfoList

getName

setName

getType

getStructure

setStructure

isFlatten

getAccessPoint

setAccessPoint

getPrefixUrlPath

setPrefixUrlPath

getResultService

setResultService

isCreateCatalogRefs

setCreateCatalogRefs

getDatasetNamerList

addDatasetNamer

getDatasetFilterList

addDatasetFilter

getDatasetSorter

setDatasetSorter

getDatasetEnhancerList

addDatasetEnhancer

isAddDatasetSize

setAddDatasetSize

validate

toString

expand

expand

fullExpand

createDataset

isCollection

createSkeletonCatalog

expandThisLevel

equals

hashCode