thredds.catalog2.builder
Interface CatalogBuilder

All Superinterfaces:
ThreddsBuilder

public interface CatalogBuilder
extends ThreddsBuilder

_more_

Since:
4.0
Author:
edavis

Method Summary
 CatalogRefBuilder addCatalogRef(String name, URI reference)
           
 DatasetBuilder addDataset(String name)
           
 void addProperty(String name, String value)
           
 ServiceBuilder addService(String name, ServiceType type, URI baseUri)
           
 Catalog build()
          Generate the resulting Catalog.
 DatasetNodeBuilder findDatasetNodeBuilderByIdGlobally(String id)
           
 ServiceBuilder findServiceBuilderByNameGlobally(String name)
           
 DatasetNodeBuilder getDatasetNodeBuilderById(String id)
           
 List<DatasetNodeBuilder> getDatasetNodeBuilders()
           
 URI getDocBaseUri()
           
 DateType getExpires()
           
 DateType getLastModified()
           
 String getName()
           
 List<String> getPropertyNames()
           
 String getPropertyValue(String name)
           
 ServiceBuilder getServiceBuilderByName(String name)
           
 List<ServiceBuilder> getServiceBuilders()
           
 String getVersion()
           
 boolean removeDataset(DatasetNodeBuilder datasetNodeBuilder)
           
 boolean removeProperty(String name)
           
 boolean removeService(ServiceBuilder serviceBuilder)
           
 void setDocBaseUri(URI docBaseUri)
           
 void setExpires(DateType expires)
           
 void setLastModified(DateType lastModified)
           
 void setName(String name)
           
 void setVersion(String version)
           
 
Methods inherited from interface thredds.catalog2.builder.ThreddsBuilder
getIssues, isBuilt
 

Method Detail

getName

String getName()

setName

void setName(String name)

getDocBaseUri

URI getDocBaseUri()

setDocBaseUri

void setDocBaseUri(URI docBaseUri)

getVersion

String getVersion()

setVersion

void setVersion(String version)

getExpires

DateType getExpires()

setExpires

void setExpires(DateType expires)

getLastModified

DateType getLastModified()

setLastModified

void setLastModified(DateType lastModified)

addService

ServiceBuilder addService(String name,
                          ServiceType type,
                          URI baseUri)

removeService

boolean removeService(ServiceBuilder serviceBuilder)

getServiceBuilders

List<ServiceBuilder> getServiceBuilders()

getServiceBuilderByName

ServiceBuilder getServiceBuilderByName(String name)

findServiceBuilderByNameGlobally

ServiceBuilder findServiceBuilderByNameGlobally(String name)

addDataset

DatasetBuilder addDataset(String name)

addCatalogRef

CatalogRefBuilder addCatalogRef(String name,
                                URI reference)

removeDataset

boolean removeDataset(DatasetNodeBuilder datasetNodeBuilder)

getDatasetNodeBuilders

List<DatasetNodeBuilder> getDatasetNodeBuilders()

getDatasetNodeBuilderById

DatasetNodeBuilder getDatasetNodeBuilderById(String id)

findDatasetNodeBuilderByIdGlobally

DatasetNodeBuilder findDatasetNodeBuilderByIdGlobally(String id)

addProperty

void addProperty(String name,
                 String value)

removeProperty

boolean removeProperty(String name)

getPropertyNames

List<String> getPropertyNames()

getPropertyValue

String getPropertyValue(String name)

build

Catalog build()
              throws BuilderException
Generate the resulting Catalog.

Specified by:
build in interface ThreddsBuilder
Returns:
the resulting Catalog object.
Throws:
IllegalStateException - if any Catalog invariants are violated.
BuilderException - if this ThreddsBuilder is not in a valid state.


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.