thredds.client.catalog

Class Dataset

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 java.lang.String	Access
static java.lang.String	Alias
static java.lang.String	Authority
static java.lang.String	CollectionType
static java.lang.String	Contributors
static java.lang.String	Creators
static java.lang.String	DataFormatType
static java.lang.String	DatasetHash
static java.lang.String	DatasetRoots
static java.lang.String	Datasets
static java.lang.String	DataSize
static java.lang.String	Dates
static java.lang.String	Documentation
static java.lang.String	Expires
static java.lang.String	FeatureType
static java.lang.String	GeospatialCoverage
static java.lang.String	Harvest
static java.lang.String	Id
static java.lang.String	Keywords
static java.lang.String	MetadataOther
static java.lang.String	Ncml
static java.lang.String	Projects
static java.lang.String	Properties
static java.lang.String	Publishers
static java.lang.String	RestrictAccess
static java.lang.String	ServiceName
static java.lang.String	Services
static java.lang.String	ThreddsMetadataInheritable
static java.lang.String	TimeCoverage
static java.lang.String	UrlPath
static java.lang.String	UseRemoteCatalogService
static java.lang.String	VariableGroups
static java.lang.String	VariableMapLink
static java.lang.String	Version

Fields inherited from class thredds.client.catalog.DatasetNode

flds, name, parent

Constructor Summary

Constructors

Constructor and Description
Dataset(DatasetNode parent, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> flds, java.util.List<AccessBuilder> accessBuilders, java.util.List<DatasetBuilder> datasetBuilders)
Dataset(java.lang.String urlPath, java.lang.String featureType, java.lang.String dataFormatS, java.lang.String serviceType) Construct an Dataset which refers to a urlPath.

Method Summary

Modifier and Type	Method and Description
Access	findAccess(java.lang.String accessURL) Get access element that matches the given access standard URL.
java.lang.String	findProperty(java.lang.String name)
java.util.List<Access>	getAccess()
Access	getAccess(ServiceType type)
java.lang.String	getAuthority()
java.lang.String	getCatalogUrl() Get URL to this dataset.
java.lang.String	getCollectionType()
java.util.List<ThreddsMetadata.Contributor>	getContributors()
java.util.List<ThreddsMetadata.Source>	getCreators()
java.lang.String	getDataFormatName()
DataFormatType	getDataFormatType()
long	getDataSize()
java.util.List<DateType>	getDates()
java.util.List<Documentation>	getDocumentation()
java.lang.String	getDocumentation(java.lang.String type)
FeatureType	getFeatureType()
java.lang.String	getFeatureTypeName()
ThreddsMetadata.GeospatialCoverage	getGeospatialCoverage()
java.lang.String	getHistory()
java.lang.String	getId()
java.lang.String	getID()
java.util.List<ThreddsMetadata.Vocab>	getKeywords()
DateType	getLastModifiedDate()
java.lang.Object	getLocalField(java.lang.String fldName)
java.util.List	getLocalFieldAsList(java.lang.String fldName)
java.util.List<ThreddsMetadata.MetadataOther>	getMetadata(java.lang.String want)
java.util.List<ThreddsMetadata.MetadataOther>	getMetadataOther()
org.jdom2.Element	getNcmlElement()
java.lang.String	getProcessing()
java.util.List<ThreddsMetadata.Vocab>	getProjects()
java.util.List<Property>	getProperties()
java.util.List<ThreddsMetadata.Source>	getPublishers()
java.lang.String	getRestrictAccess()
java.lang.String	getRights()
Service	getServiceDefault()
java.lang.String	getServiceNameDefault()
java.lang.String	getSummary()
DateRange	getTimeCoverage()
java.lang.String	getUrlPath()
ThreddsMetadata.UriResolved	getVariableMapLink()
java.util.List<ThreddsMetadata.VariableGroup>	getVariables()
boolean	hasAccess()
boolean	hasDataSize()
boolean	isDatasetScan()
boolean	isHarvest()

Methods inherited from class thredds.client.catalog.DatasetNode

findDatasetByName, getDatasets, getFlds, getName, getParent, getParentCatalog, getParentDataset, hasNestedDatasets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Access

public static final java.lang.String Access

See Also:

Constant Field Values

Alias

public static final java.lang.String Alias

See Also:

Constant Field Values

Authority

public static final java.lang.String Authority

See Also:

Constant Field Values

CollectionType

public static final java.lang.String CollectionType

See Also:

Constant Field Values

Contributors

public static final java.lang.String Contributors

See Also:

Constant Field Values

Creators

public static final java.lang.String Creators

See Also:

Constant Field Values

DataFormatType

public static final java.lang.String DataFormatType

See Also:

Constant Field Values

Datasets

public static final java.lang.String Datasets

See Also:

Constant Field Values

DatasetHash

public static final java.lang.String DatasetHash

See Also:

Constant Field Values

DatasetRoots

public static final java.lang.String DatasetRoots

See Also:

Constant Field Values

DataSize

public static final java.lang.String DataSize

See Also:

Constant Field Values

Dates

public static final java.lang.String Dates

See Also:

Constant Field Values

Documentation

public static final java.lang.String Documentation

See Also:

Constant Field Values

Expires

public static final java.lang.String Expires

See Also:

Constant Field Values

FeatureType

public static final java.lang.String FeatureType

See Also:

Constant Field Values

GeospatialCoverage

public static final java.lang.String GeospatialCoverage

See Also:

Constant Field Values

Harvest

public static final java.lang.String Harvest

See Also:

Constant Field Values

Id

public static final java.lang.String Id

See Also:

Constant Field Values

Keywords

public static final java.lang.String Keywords

See Also:

Constant Field Values

MetadataOther

public static final java.lang.String MetadataOther

See Also:

Constant Field Values

Ncml

public static final java.lang.String Ncml

See Also:

Constant Field Values

Projects

public static final java.lang.String Projects

See Also:

Constant Field Values

Properties

public static final java.lang.String Properties

See Also:

Constant Field Values

Publishers

public static final java.lang.String Publishers

See Also:

Constant Field Values

RestrictAccess

public static final java.lang.String RestrictAccess

See Also:

Constant Field Values

ServiceName

public static final java.lang.String ServiceName

See Also:

Constant Field Values

Services

public static final java.lang.String Services

See Also:

Constant Field Values

ThreddsMetadataInheritable

public static final java.lang.String ThreddsMetadataInheritable

See Also:

Constant Field Values

TimeCoverage

public static final java.lang.String TimeCoverage

See Also:

Constant Field Values

VariableGroups

public static final java.lang.String VariableGroups

See Also:

Constant Field Values

VariableMapLink

public static final java.lang.String VariableMapLink

See Also:

Constant Field Values

Version

public static final java.lang.String Version

See Also:

Constant Field Values

UrlPath

public static final java.lang.String UrlPath

See Also:

Constant Field Values

UseRemoteCatalogService

public static final java.lang.String UseRemoteCatalogService

See Also:

Constant Field Values

Constructor Detail

Dataset

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

Dataset

public Dataset(java.lang.String urlPath,
               java.lang.String featureType,
               java.lang.String dataFormatS,
               java.lang.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

Method Detail

getAccess

public java.util.List<Access> getAccess()

getAccess

public Access getAccess(ServiceType type)

hasAccess

public boolean hasAccess()

findAccess

public Access findAccess(java.lang.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.

getCatalogUrl

public java.lang.String getCatalogUrl()

Get URL to this dataset. Dataset must have an ID. Form is catalogURL#DatasetID

Returns:

URL to this dataset.

getCollectionType

public java.lang.String getCollectionType()

isDatasetScan

public boolean isDatasetScan()

isHarvest

public boolean isHarvest()

getId

public java.lang.String getId()

getID

public java.lang.String getID()

getUrlPath

public java.lang.String getUrlPath()

getNcmlElement

public org.jdom2.Element getNcmlElement()

getLocalField

public java.lang.Object getLocalField(java.lang.String fldName)

Specified by:

getLocalField in interface ThreddsMetadataContainer

getAuthority

public java.lang.String getAuthority()

getDataFormatName

public java.lang.String getDataFormatName()

getDataFormatType

public DataFormatType getDataFormatType()

getDataSize

public long getDataSize()

hasDataSize

public boolean hasDataSize()

getFeatureType

public FeatureType getFeatureType()

getFeatureTypeName

public java.lang.String getFeatureTypeName()

getGeospatialCoverage

public ThreddsMetadata.GeospatialCoverage getGeospatialCoverage()

getServiceNameDefault

public java.lang.String getServiceNameDefault()

getServiceDefault

public Service getServiceDefault()

getRestrictAccess

public java.lang.String getRestrictAccess()

getTimeCoverage

public DateRange getTimeCoverage()

getVariableMapLink

public ThreddsMetadata.UriResolved getVariableMapLink()

getLocalFieldAsList

public java.util.List getLocalFieldAsList(java.lang.String fldName)

Specified by:

getLocalFieldAsList in interface ThreddsMetadataContainer

getCreators

public java.util.List<ThreddsMetadata.Source> getCreators()

getContributors

public java.util.List<ThreddsMetadata.Contributor> getContributors()

getDates

public java.util.List<DateType> getDates()

getDocumentation

public java.util.List<Documentation> getDocumentation()

getKeywords

public java.util.List<ThreddsMetadata.Vocab> getKeywords()

getMetadataOther

public java.util.List<ThreddsMetadata.MetadataOther> getMetadataOther()

getMetadata

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

getProjects

public java.util.List<ThreddsMetadata.Vocab> getProjects()

getProperties

public java.util.List<Property> getProperties()

findProperty

public java.lang.String findProperty(java.lang.String name)

getPublishers

public java.util.List<ThreddsMetadata.Source> getPublishers()

getVariables

public java.util.List<ThreddsMetadata.VariableGroup> getVariables()

getDocumentation

public java.lang.String getDocumentation(java.lang.String type)

getHistory

public java.lang.String getHistory()

Returns:

specific type of documentation = history

getProcessing

public java.lang.String getProcessing()

Returns:

specific type of documentation = processing_level

getRights

public java.lang.String getRights()

Returns:

specific type of documentation = rights

getSummary

public java.lang.String getSummary()

Returns:

specific type of documentation = summary

getLastModifiedDate

public DateType getLastModifiedDate()