Dataset (NetCDF-Java CDM Public API v5.4.2)

java.lang.Object
- thredds.client.catalog.DatasetNode
- - thredds.client.catalog.Dataset

All Implemented Interfaces:

ThreddsMetadataContainer

Direct Known Subclasses:

CatalogRef
```
@Immutable
public class Dataset
extends DatasetNode
implements ThreddsMetadataContainer
```
A Client Catalog Dataset

Since:

1/7/2015

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`Access`
`static String`	`Alias`
`static String`	`Authority`
`static String`	`CollectionType`
`static String`	`Contributors`
`static String`	`Creators`
`static String`	`DataFormatType`
`static String`	`Datasets`
`static String`	`DataSize`
`static String`	`Dates`
`static String`	`Documentation`
`static String`	`FeatureType`
`static String`	`GeospatialCoverage`
`static String`	`Harvest`
`static String`	`Id`
`static String`	`Keywords`
`static com.google.common.collect.ImmutableSet<String>`	`listFlds`
`static String`	`MetadataOther`
`static String`	`Ncml`
`static String`	`NotAThreddsDataset`
`static String`	`Projects`
`static String`	`Properties`
`static String`	`Publishers`
`static String`	`RestrictAccess`
`static String`	`ServiceName`
`static String`	`ThreddsMetadataInheritable`
`static String`	`TimeCoverage`
`static String`	`UrlPath`
`static String`	`UseRemoteCatalogService`
`static String`	`VariableGroups`
`static String`	`VariableMapLinkURI`

Constructor Summary

Constructors
Constructor and Description
`Dataset(DatasetNode parent, String name, Map<String,Object> flds, List<AccessBuilder> accessBuilders, List<DatasetBuilder> datasetBuilders)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Access`	`findAccess(String accessURL)` Get access element that matches the given access standard URL.
`String`	`findProperty(String name)`
`List<Access>`	`getAccess()`
`Access`	`getAccess(ServiceType type)`
`String`	`getAuthority()`
`String`	`getCatalogUrl()` Get URL to this dataset.
`String`	`getCollectionType()`
`List<ThreddsMetadata.Contributor>`	`getContributors()`
`List<ThreddsMetadata.Source>`	`getCreators()`
`String`	`getDataFormatName()`
`DataFormatType`	`getDataFormatType()`
`long`	`getDataSize()`
`List<DateType>`	`getDates()`
`List<Documentation>`	`getDocumentation()`
`String`	`getDocumentation(String type)`
`FeatureType`	`getFeatureType()`
`String`	`getFeatureTypeName()`
`ThreddsMetadata.GeospatialCoverage`	`getGeospatialCoverage()`
`String`	`getHistory()`
`String`	`getId()`
`String`	`getID()`
`String`	`getIdOrPath()`
`List<ThreddsMetadata.Vocab>`	`getKeywords()`
`DateType`	`getLastModifiedDate()`
`Object`	`getLocalField(String fldName)`
`List<ThreddsMetadata.MetadataOther>`	`getMetadata(String want)`
`List<ThreddsMetadata.MetadataOther>`	`getMetadataOther()`
`org.jdom2.Element`	`getNcmlElement()`
`String`	`getProcessing()`
`List<ThreddsMetadata.Vocab>`	`getProjects()`
`List<Property>`	`getProperties()`
`List<ThreddsMetadata.Source>`	`getPublishers()`
`String`	`getRestrictAccess()`
`String`	`getRights()`
`Service`	`getServiceDefault()`
`String`	`getServiceNameDefault()`
`String`	`getSummary()`
`DateRange`	`getTimeCoverage()`
`String`	`getUrlPath()`
`ThreddsMetadata.UriResolved`	`getVariableMapLink()`
`List<ThreddsMetadata.VariableGroup>`	`getVariables()`
`boolean`	`hasAccess()`
`boolean`	`hasDataSize()`
`boolean`	`hasProperty(Property want)`
`boolean`	`hasProperty(String name)`
`boolean`	`isDatasetScan()`
`boolean`	`isHarvest()`
`static Dataset`	`makeStandalone(String urlPath, String featureType, String dataFormatS, String serviceType)` Construct an Dataset which refers to a urlPath.

Methods inherited from class thredds.client.catalog.DatasetNode
findDatasetByName, get, getDatasets, getDatasetsLocal, getDatasetsLogical, getFldIterator, getLocalFieldAsList, getName, getParent, getParentCatalog, getParentDataset, hasNestedDatasets

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface thredds.client.catalog.ThreddsMetadataContainer
getLocalFieldAsList

Field Detail

Access
```
public static final String Access
```
See Also:

Constant Field Values

Alias
```
public static final String Alias
```
See Also:

Constant Field Values

Authority
```
public static final String Authority
```
See Also:

Constant Field Values

CollectionType

public static final String CollectionType

See Also:: Constant Field Values

Contributors

public static final String Contributors

See Also:: Constant Field Values

Creators
```
public static final String Creators
```
See Also:

Constant Field Values

DataFormatType

public static final String DataFormatType

See Also:: Constant Field Values

Datasets
```
public static final String Datasets
```
See Also:

Constant Field Values

DataSize
```
public static final String DataSize
```
See Also:

Constant Field Values

Dates
```
public static final String Dates
```
See Also:

Constant Field Values

Documentation

public static final String Documentation

See Also:: Constant Field Values

FeatureType
```
public static final String FeatureType
```
See Also:

Constant Field Values

GeospatialCoverage

public static final String GeospatialCoverage

See Also:: Constant Field Values

Harvest
```
public static final String Harvest
```
See Also:

Constant Field Values

Id
```
public static final String Id
```
See Also:

Constant Field Values

Keywords
```
public static final String Keywords
```
See Also:

Constant Field Values

listFlds

public static final com.google.common.collect.ImmutableSet<String> listFlds

MetadataOther

public static final String MetadataOther

See Also:: Constant Field Values

Ncml
```
public static final String Ncml
```
See Also:

Constant Field Values

NotAThreddsDataset

public static final String NotAThreddsDataset

See Also:: Constant Field Values

Projects
```
public static final String Projects
```
See Also:

Constant Field Values

Properties
```
public static final String Properties
```
See Also:

Constant Field Values

Publishers
```
public static final String Publishers
```
See Also:

Constant Field Values

RestrictAccess

public static final String RestrictAccess

See Also:: Constant Field Values

ServiceName
```
public static final String ServiceName
```
See Also:

Constant Field Values

ThreddsMetadataInheritable

public static final String ThreddsMetadataInheritable

See Also:: Constant Field Values

TimeCoverage

public static final String TimeCoverage

See Also:: Constant Field Values

UrlPath
```
public static final String UrlPath
```
See Also:

Constant Field Values

UseRemoteCatalogService

public static final String UseRemoteCatalogService

See Also:: Constant Field Values

VariableGroups

public static final String VariableGroups

See Also:: Constant Field Values

VariableMapLinkURI

public static final String VariableMapLinkURI

See Also:: Constant Field Values

Constructor Detail

Dataset

public Dataset(DatasetNode parent,
               String name,
               Map<String,Object> flds,
               List<AccessBuilder> accessBuilders,
               List<DatasetBuilder> datasetBuilders)

Method Detail

findAccess
```
public Access findAccess(String accessURL)
```
Get access element that matches the given access standard URL. Match on a.getStandardUrlName().

Parameters:

accessURL - find theis access URL string

Returns:

InvAccess or null if no match.

findProperty

public String findProperty(String name)

getAccess
```
public List<Access> getAccess()
```

getAccess

public Access getAccess(ServiceType type)

getAuthority
```
public String getAuthority()
```

getCatalogUrl
```
public String getCatalogUrl()
```
Get URL to this dataset. Dataset must have an ID. Form is catalogURL#DatasetID

Returns:

URL to this dataset.

getCollectionType
```
public String getCollectionType()
```

getContributors

public List<ThreddsMetadata.Contributor> getContributors()

getCreators

public List<ThreddsMetadata.Source> getCreators()

getDataFormatName
```
public String getDataFormatName()
```

getDataFormatType

public DataFormatType getDataFormatType()

getDataSize
```
public long getDataSize()
```

getDates
```
public List<DateType> getDates()
```

getDocumentation

public List<Documentation> getDocumentation()

getDocumentation

public String getDocumentation(String type)

getFeatureType
```
public FeatureType getFeatureType()
```

getFeatureTypeName
```
public String getFeatureTypeName()
```

getGeospatialCoverage

public ThreddsMetadata.GeospatialCoverage getGeospatialCoverage()

getHistory
```
public String getHistory()
```
Returns:

specific type of documentation = history

getId
```
public String getId()
```

getID
```
public String getID()
```

getIdOrPath
```
public String getIdOrPath()
```

getKeywords

public List<ThreddsMetadata.Vocab> getKeywords()

getLastModifiedDate
```
public DateType getLastModifiedDate()
```

getLocalField
```
public Object getLocalField(String fldName)
```
Specified by:

getLocalField in interface ThreddsMetadataContainer

getMetadata

public List<ThreddsMetadata.MetadataOther> getMetadata(String want)

getMetadataOther

public List<ThreddsMetadata.MetadataOther> getMetadataOther()

getNcmlElement

public org.jdom2.Element getNcmlElement()

getProcessing
```
public String getProcessing()
```
Returns:

specific type of documentation = processing_level

getProjects

public List<ThreddsMetadata.Vocab> getProjects()

getProperties
```
public List<Property> getProperties()
```

getPublishers

public List<ThreddsMetadata.Source> getPublishers()

getRestrictAccess
```
public String getRestrictAccess()
```

getRights
```
public String getRights()
```
Returns:

specific type of documentation = rights

getServiceDefault
```
public Service getServiceDefault()
```

getServiceNameDefault
```
public String getServiceNameDefault()
```

getSummary
```
public String getSummary()
```
Returns:

specific type of documentation = summary

getTimeCoverage
```
public DateRange getTimeCoverage()
```

getUrlPath
```
public String getUrlPath()
```

getVariableMapLink

public ThreddsMetadata.UriResolved getVariableMapLink()

getVariables

public List<ThreddsMetadata.VariableGroup> getVariables()

hasAccess
```
public boolean hasAccess()
```

hasDataSize
```
public boolean hasDataSize()
```

hasProperty

public boolean hasProperty(Property want)

hasProperty

public boolean hasProperty(String name)

isDatasetScan
```
public boolean isDatasetScan()
```

isHarvest
```
public boolean isHarvest()
```

makeStandalone

public static Dataset makeStandalone(String urlPath,
                                     String featureType,
                                     String dataFormatS,
                                     String serviceType)

Construct an Dataset which refers to a urlPath. This is used to create a standalone Dataset, outside of an Catalog. An "anonymous" Service is created and attached to the Dataset.

Parameters:: urlPath - : construct URL from this path; featureType - : feature type; dataFormatS - : data format; serviceType - : ServiceType

Class Dataset

Field Summary

Constructor Summary

Method Summary

Methods inherited from class thredds.client.catalog.DatasetNode

Methods inherited from class java.lang.Object

Methods inherited from interface thredds.client.catalog.ThreddsMetadataContainer

Field Detail

Access

Alias

Authority

CollectionType

Contributors

Creators

DataFormatType

Datasets

DataSize

Dates

Documentation

FeatureType

GeospatialCoverage

Harvest

Id

Keywords

listFlds

MetadataOther

Ncml

NotAThreddsDataset

Projects

Properties

Publishers

RestrictAccess

ServiceName

ThreddsMetadataInheritable

TimeCoverage

UrlPath

UseRemoteCatalogService

VariableGroups

VariableMapLinkURI

Constructor Detail

Dataset

Method Detail

findAccess

findProperty

getAccess

getAccess

getAuthority

getCatalogUrl

getCollectionType

getContributors

getCreators

getDataFormatName

getDataFormatType

getDataSize

getDates

getDocumentation

getDocumentation

getFeatureType

getFeatureTypeName

getGeospatialCoverage

getHistory

getId

getID

getIdOrPath

getKeywords

getLastModifiedDate

getLocalField

getMetadata

getMetadataOther

getNcmlElement

getProcessing

getProjects

getProperties

getPublishers

getRestrictAccess

getRights

getServiceDefault

getServiceNameDefault

getSummary

getTimeCoverage