thredds.catalog2.builder
Interface ThreddsBuilder

All Known Subinterfaces:
AccessBuilder, CatalogBuilder, CatalogRefBuilder, DatasetBuilder, DatasetNodeBuilder, MetadataBuilder, ServiceBuilder, ThreddsMetadataBuilder, ThreddsMetadataBuilder.ContributorBuilder, ThreddsMetadataBuilder.DatePointBuilder, ThreddsMetadataBuilder.DateRangeBuilder, ThreddsMetadataBuilder.DocumentationBuilder, ThreddsMetadataBuilder.GeospatialCoverageBuilder, ThreddsMetadataBuilder.GeospatialRangeBuilder, ThreddsMetadataBuilder.KeyphraseBuilder, ThreddsMetadataBuilder.ProjectNameBuilder, ThreddsMetadataBuilder.VariableBuilder, ThreddsMetadataBuilder.VariableGroupBuilder

public interface ThreddsBuilder

Parent type for all THREDDS builders.

Since:
4.0
Author:
edavis

Method Summary
 Object build()
          Generate the object being built by this ThreddsBuilder.
 BuilderIssues getIssues()
          Check whether the state of this ThreddsBuilder is such that build() will succeed.
 boolean isBuilt()
          Check whether this ThreddsBuilder has been built.
 

Method Detail

isBuilt

boolean isBuilt()
Check whether this ThreddsBuilder has been built.

Returns:
true if this ThreddsBuilder has already been built, false otherwise.

getIssues

BuilderIssues getIssues()
Check whether the state of this ThreddsBuilder is such that build() will succeed.

Returns:
true if this ThreddsBuilder is in a state where build() will succeed.

build

Object build()
             throws BuilderException
Generate the object being built by this ThreddsBuilder.

Returns:
the THREDDS catalog object being built by this ThreddsBuilder.
Throws:
BuilderException - if this ThreddsBuilder is not in a valid state.


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