iresourcemetadataregistry.java

esri的ArcGIS Server超级学习模板程序（for java）

package com.esri.solutions.jitk.common.metadata;

import java.util.Map;

import com.esri.adf.web.data.GISResource;

/**
 * Defines an interface that allows an object to be a registry of metadata for
 * {@link GISResource GISResources}.
 */
public interface IResourceMetadataRegistry {

	/**
	 * Adds the contents of a {@code Map<IMetadataID, GISResource>} to the registry.
     * 
	 * @param registry
	 *            The {@code Map<IMetadataID, GISResource>} whose contents should be
	 *            added; cannot be {@code null}.
	 */
	public void setRegistry(Map<IMetadataID, GISResource> registry);

	/**
	 * Registers a {@link GISResource}, keyed by its {@link IMetadataID}, with
	 * this registry.
	 * <p>
	 * If called when no metadata is currently registered for the
	 * {@link GISResource} this method will create a new registry entry. If
	 * metadata is currently registered, this method will replace the existing
	 * mapping with the new one. If this behavior is not desired, then the
	 * client should utilize {@link #metadataExists(IMetadataID)} or
	 * {@link #metadataExists(GISResource)} to determine if metadata has already
	 * been registered before invoking this method.
	 * </p>
	 * 
	 * @param id
	 *            The {@link IMetadataID} representing the {@link GISResource},
	 *            cannot be {@code null}.
	 * @param resource
	 *            The {@link GISResource} to register, cannot be {@code null}.
	 */
	public void register(IMetadataID id, GISResource resource);

	/**
	 * Removes the {@link GISResource}, with the corresponding
	 * {@link IMetadataID}, from this registry.
	 * 
	 * @param id
	 *            The {@link IMetadataID} representing the {@link GISResource},
	 *            cannot be {@code null}.
	 */
	public void unregister(IMetadataID id);

	/**
	 * Removes a {@link GISResource} from this registry.
	 * 
	 * @param id
	 *            The {@link GISResource} to remove, cannot be {@code null}.
	 */
	public void unregister(GISResource resource);

	/**
	 * Checks the registry to see if a {@link GISResource} has been registered
	 * with the given {@link IMetadataID}.
	 * 
	 * @param id
	 *            The {@link IMetadataID} for which the registry should be
	 *            checked. Cannot be {@code null}.
	 * @return {@code true} if a {@link GISResource} with the given
	 *         {@link IMetadataID} has been registered; {@code false} otherwise.
	 */
	public boolean metadataExists(IMetadataID id);

	/**
	 * Checks the registry to see if the given {@link GISResource} has been
	 * registered.
	 * 
	 * @param id
	 *            The {@link GISResource} whose registration should be
	 *            determined. Cannot be {@code null}.
	 * @return {@code true} if a {@link GISResource} has been registered;
	 *         {@code false} otherwise.
	 */
	public boolean metadataExists(GISResource resource);

	/**
	 * Retrieves the {@link IMetadataID} that represents the given
	 * {@link GISResource}.
	 * 
	 * @param resource
	 *            {@link GISResource} for which its {@link IMetadataID} should
	 *            be retrieved, cannot be {@code null}.
	 * @return the {@link IMetadataID}, which could potentially be {@code null}
	 *         if no metadata exists for that resource.
	 */
	public IMetadataID getMetadataID(GISResource resource);

	/**
	 * Retrieves the {@link IMetadataID} that represents the given
	 * {@link GISResource}.
	 * 
	 * @param resource
	 *            {@link GISResource} for which its {@link IMetadataID} should
	 *            be retrieved, cannot be {@code null}.
	 * @return the {@link GISResource}, which should not be {@code null}, but
	 *         could be if its metadata has not been registered.
	 */
	public GISResource getGISResource(IMetadataID id);
}