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 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 Deprecated.
static String	DateTypes
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 Deprecated.
static String	TimeCoverageNew
static String	UrlPath
static String	UseRemoteCatalogService
static String	VariableGroups
static String	VariableMapLinkURI

Fields inherited from class thredds.client.catalog.DatasetNode

flds, name, parent

Constructor Summary

Constructors

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

Method Summary

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() Deprecated. use getDateTypes()
List<DateType>	getDateTypes()
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()
CalendarDate	getLastModifiedCalendarDate() Find a DateType with type "modified", return it as a CalendarDate.
DateType	getLastModifiedDate() Deprecated. use getLastModifiedCalendarDate
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() Deprecated. use getTimeCoverageNew()
TimeCoverage	getTimeCoverageNew()
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

clone, equals, finalize, 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

@Deprecated
public static final String Dates

Deprecated.

See Also:

Constant Field Values

DateTypes

public static final String DateTypes

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

MetadataOther

public static final String MetadataOther

See Also:

Constant Field Values

Ncml

public static final String Ncml

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

@Deprecated
public static final String TimeCoverage

Deprecated.

See Also:

Constant Field Values

TimeCoverageNew

public static final String TimeCoverageNew

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

UrlPath

public static final String UrlPath

See Also:

Constant Field Values

UseRemoteCatalogService

public static final String UseRemoteCatalogService

See Also:

Constant Field Values

NotAThreddsDataset

public static final String NotAThreddsDataset

See Also:

Constant Field Values

listFlds

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

Constructor Detail

Dataset

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

Method Detail

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

getAccess

public List<Access> getAccess()

getAccess

@Nullable
public Access getAccess(ServiceType type)

hasAccess

public boolean hasAccess()

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.

getCatalogUrl

@Nullable
public String getCatalogUrl()

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

Returns:

URL to this dataset.

getCollectionType

@Nullable
public String getCollectionType()

isDatasetScan

public boolean isDatasetScan()

isHarvest

public boolean isHarvest()

getId

@Nullable
public String getId()

getID

@Nullable
public String getID()

getUrlPath

@Nullable
public String getUrlPath()

getIdOrPath

@Nullable
public String getIdOrPath()

getNcmlElement

@Nullable
public org.jdom2.Element getNcmlElement()

getLocalField

@Nullable
public Object getLocalField(String fldName)

Specified by:

getLocalField in interface ThreddsMetadataContainer

getAuthority

@Nullable
public String getAuthority()

getDataFormatName

@Nullable
public String getDataFormatName()

getDataFormatType

@Nullable
public DataFormatType getDataFormatType()

getDataSize

public long getDataSize()

hasDataSize

public boolean hasDataSize()

getFeatureType

@Nullable
public FeatureType getFeatureType()

getFeatureTypeName

@Nullable
public String getFeatureTypeName()

getGeospatialCoverage

@Nullable
public ThreddsMetadata.GeospatialCoverage getGeospatialCoverage()

getServiceNameDefault

@Nullable
public String getServiceNameDefault()

getServiceDefault

@Nullable
public Service getServiceDefault()

getRestrictAccess

public String getRestrictAccess()

getTimeCoverage

@Deprecated
 @Nullable
public DateRange getTimeCoverage()

Deprecated. use getTimeCoverageNew()

getTimeCoverageNew

@Nullable
public TimeCoverage getTimeCoverageNew()

getVariableMapLink

@Nullable
public ThreddsMetadata.UriResolved getVariableMapLink()

getCreators

public List<ThreddsMetadata.Source> getCreators()

getContributors

public List<ThreddsMetadata.Contributor> getContributors()

getDates

@Deprecated
public List<DateType> getDates()

Deprecated. use getDateTypes()

getDateTypes

public List<DateType> getDateTypes()

getDocumentation

public List<Documentation> getDocumentation()

getKeywords

public List<ThreddsMetadata.Vocab> getKeywords()

getMetadataOther

public List<ThreddsMetadata.MetadataOther> getMetadataOther()

getMetadata

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

getProjects

public List<ThreddsMetadata.Vocab> getProjects()

getProperties

public List<Property> getProperties()

findProperty

@Nullable
public String findProperty(String name)

hasProperty

public boolean hasProperty(Property want)

hasProperty

public boolean hasProperty(String name)

getPublishers

public List<ThreddsMetadata.Source> getPublishers()

getVariables

public List<ThreddsMetadata.VariableGroup> getVariables()

getDocumentation

@Nullable
public String getDocumentation(String type)

getHistory

@Nullable
public String getHistory()

Returns:

specific type of documentation = history

getProcessing

@Nullable
public String getProcessing()

Returns:

specific type of documentation = processing_level

getRights

@Nullable
public String getRights()

Returns:

specific type of documentation = rights

getSummary

@Nullable
public String getSummary()

Returns:

specific type of documentation = summary

getLastModifiedDate

@Deprecated
 @Nullable
public DateType getLastModifiedDate()

Deprecated. use getLastModifiedCalendarDate

getLastModifiedCalendarDate

@Nullable
public CalendarDate getLastModifiedCalendarDate()

Find a DateType with type "modified", return it as a CalendarDate.