Package thredds.client.catalog

Class Catalog

java.lang.Object

thredds.client.catalog.DatasetNode

thredds.client.catalog.Catalog

@Immutable
public class Catalog
extends DatasetNode

A Client Catalog

Since:

1/7/2015

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATALOG_NAMESPACE_10
static String	DatasetHash
static String	DatasetRoots
static org.jdom2.Namespace	defNS
static String	Expires
static org.jdom2.Namespace	ncmlNS
static org.jdom2.Namespace	ncmlNSHttps
static String	NJ22_NAMESPACE
static String	NJ22_NAMESPACE_HTTPS
static String	Services
static String	Version
static String	XLINK_NAMESPACE
static org.jdom2.Namespace	xlinkNS
static org.jdom2.Namespace	xsiNS

Constructor Summary

Constructors

Constructor	Description
Catalog(URI baseURI, String name, Map<String,Object> flds, List<DatasetBuilder> datasets)

Method Summary

Modifier and Type	Method	Description
Dataset	findDatasetByID(String id)
Service	findService(String serviceName)
Service	findService(ServiceType type)
Iterable<Dataset>	getAllDatasets()
URI	getBaseURI()
CalendarDate	getExpires()
List<Property>	getProperties()
List<Service>	getServices()
String	getUriString()
String	getVersion()
boolean	hasService(String name)
URI	resolveUri(String uriString)	Resolve reletive URIs, using the catalog's base URI.
static URI	resolveUri(URI baseURI, String uriString)
Catalog	subsetCatalogOnDataset(Dataset dataset)

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

Field Detail

CATALOG_NAMESPACE_10

public static final String CATALOG_NAMESPACE_10

See Also:

Constant Field Values

defNS

public static final org.jdom2.Namespace defNS

NJ22_NAMESPACE

public static final String NJ22_NAMESPACE

See Also:

Constant Field Values

NJ22_NAMESPACE_HTTPS

public static final String NJ22_NAMESPACE_HTTPS

See Also:

Constant Field Values

ncmlNS

public static final org.jdom2.Namespace ncmlNS

ncmlNSHttps

public static final org.jdom2.Namespace ncmlNSHttps

XLINK_NAMESPACE

public static final String XLINK_NAMESPACE

See Also:

Constant Field Values

xlinkNS

public static final org.jdom2.Namespace xlinkNS

xsiNS

public static final org.jdom2.Namespace xsiNS

DatasetHash

public static final String DatasetHash

See Also:

Constant Field Values

DatasetRoots

public static final String DatasetRoots

See Also:

Constant Field Values

Expires

public static final String Expires

See Also:

Constant Field Values

Services

public static final String Services

See Also:

Constant Field Values

Version

public static final String Version

See Also:

Constant Field Values

Constructor Detail

Catalog

public Catalog(URI baseURI,
               String name,
               Map<String,Object> flds,
               List<DatasetBuilder> datasets)

Method Detail

getBaseURI

public URI getBaseURI()

getExpires

public CalendarDate getExpires()

getVersion

public String getVersion()

getServices

public List<Service> getServices()

hasService

public boolean hasService(String name)

findService

public Service findService(String serviceName)

findService

public Service findService(ServiceType type)

getProperties

public List<Property> getProperties()

findDatasetByID

public Dataset findDatasetByID(String id)

getAllDatasets

public Iterable<Dataset> getAllDatasets()

resolveUri

public URI resolveUri(String uriString)
               throws URISyntaxException

Resolve reletive URIs, using the catalog's base URI. If the uriString is not reletive, then no resolution is done. This also allows baseURI to be a file: scheme.

Parameters:

uriString - any url, reletive or absolute

Returns:

resolved url string, or null on error

Throws:

URISyntaxException - if uriString violates RFC 2396

resolveUri

public static URI resolveUri(URI baseURI,
                             String uriString)
                      throws URISyntaxException

Throws:

URISyntaxException

getUriString

public String getUriString()

subsetCatalogOnDataset

public Catalog subsetCatalogOnDataset(Dataset dataset)