org.geotools.catalog
Interface Catalog

All Superinterfaces:
Discovery

public interface Catalog
extends Discovery

A collection of catalog entries that is organized to assist in the discovery, access, and retrieval of geospatial resources or services that are of interest to the user, especially when the existence or whereabouts of the resource are not know to the user.

Being a collection of catalog entries, a catalog should be able to enumerate each of its entries, and should allow entries to be added or removed. It should also support queries that will enable the user to obtain entries of interest based on specified criteria.

NOTE: The specification Catalog Services 1.1.1 does not specify the methods of the Catalog interface. The methods in this interface were inferred from reading the abstract catalog specification: Catalog Services section 3.1.1

Version:
Catalog Services 1.1.1
Author:
OpenGIS® consortium

Method Summary
 void add(CatalogEntry entry)
          Adds a catalog entry to the catalog.
 void remove(CatalogEntry entry)
          Removes a catalog entry from the catalog.
 
Methods inherited from interface org.geotools.catalog.Discovery
entries, search
 

Method Detail

add

public void add(CatalogEntry entry)
         throws java.lang.UnsupportedOperationException
Adds a catalog entry to the catalog. Not all catalogs can provide this functionality so an exception may be throws. For example A GridCoverageExchange implementation maybe implement catalog as well, however it may not be possible for for GridCoverageExchange to remove or add to its catalog because it maybe dependent on another resource such as a database.

Parameters:
entry - Catalog entry to add.
Throws:
java.lang.UnsupportedOperationException - if the catalog does not provide this functionality.

remove

public void remove(CatalogEntry entry)
            throws java.lang.UnsupportedOperationException
Removes a catalog entry from the catalog. Not all catalogs can provide this functionality so an exception may be throws. For example A GridCoverageExchange implementation maybe implement catalog as well, however it may not be possible for for GridCoverageExchange to remove or add to its catalog because it maybe dependent on another resource such as a database.

Parameters:
entry - Catalog entry to remove
Throws:
java.lang.UnsupportedOperationException - if the catalog does not provide this functionality.


Copyright © GeoTools. All Rights Reserved.