thredds.client.catalog

Class CatalogRef

java.lang.Object

thredds.client.catalog.DatasetNode

thredds.client.catalog.Dataset

thredds.client.catalog.CatalogRef

All Implemented Interfaces:

ThreddsMetadataContainer

public class CatalogRef
extends Dataset

A Client CatalogRef

Since:

1/7/2015

Field Summary

Fields inherited from class thredds.client.catalog.Dataset

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

Fields inherited from class thredds.client.catalog.DatasetNode

flds, name, parent

Constructor Summary

Constructors

Constructor and Description
CatalogRef(DatasetNode parent, String name, String xlink, Map<String,Object> flds, List<thredds.client.catalog.builder.AccessBuilder> accessBuilders, List<thredds.client.catalog.builder.DatasetBuilder> datasetBuilders)

Method Summary

Modifier and Type	Method and Description
List<Dataset>	getDatasets() Get top level datasets contained in this catalog, or if its a catref, get the datasets in the referenced catalog only if already read in.
List<Dataset>	getDatasetsLogical() Get top level datasets logically contained in this catalog.
URI	getURI()
String	getXlinkHref()
boolean	hasNestedDatasets()
boolean	isRead()
Optional<DatasetNode>	readCatref()
void	setRead(boolean isRead)
protected String	translatePathToReletiveLocation(String dsPath, String configPath)
Boolean	useRemoteCatalogService()

Methods inherited from class thredds.client.catalog.Dataset

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, getUrlPath, getVariableMapLink, getVariables, hasAccess, hasDataSize, hasProperty, hasProperty, isDatasetScan, isHarvest, makeStandalone

Methods inherited from class thredds.client.catalog.DatasetNode

findDatasetByName, get, getDatasetsLocal, getFldIterator, getLocalFieldAsList, getName, getParent, getParentCatalog, getParentDataset

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

Constructor Detail

CatalogRef

public CatalogRef(DatasetNode parent,
                  String name,
                  String xlink,
                  Map<String,Object> flds,
                  List<thredds.client.catalog.builder.AccessBuilder> accessBuilders,
                  List<thredds.client.catalog.builder.DatasetBuilder> datasetBuilders)

Method Detail

getXlinkHref

public String getXlinkHref()

isRead

public boolean isRead()

setRead

public void setRead(boolean isRead)

useRemoteCatalogService

public Boolean useRemoteCatalogService()

getURI

public URI getURI()

Returns:

Xlink reference as a URI, resolved

translatePathToReletiveLocation

protected String translatePathToReletiveLocation(String dsPath,
                                                 String configPath)

hasNestedDatasets

public boolean hasNestedDatasets()

Overrides:

hasNestedDatasets in class DatasetNode

getDatasets

public List<Dataset> getDatasets()

Description copied from class: DatasetNode

Get top level datasets contained in this catalog, or if its a catref, get the datasets in the referenced catalog only if already read in.

Overrides:

getDatasets in class DatasetNode

getDatasetsLogical

public List<Dataset> getDatasetsLogical()

Description copied from class: DatasetNode

Get top level datasets logically contained in this catalog. If this is a catalogRef, read it in.

Overrides:

getDatasetsLogical in class DatasetNode

readCatref

public Optional<DatasetNode> readCatref()
                                 throws IOException

Throws:

IOException