bookmark.java

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

package com.esri.solutions.jitk.web.tasks.navigation.bookmark;

import com.esri.adf.web.data.geometry.WebExtent;
import com.esri.adf.web.data.geometry.WebSpatialReference;

/**
 * The contract of the notion of a bookmark. Note that while the underlying
 * itself can (should?) also have a spatial reference as a WebSpatialReference
 * instance, this bookmark contract can have its own spatial reference.
 * Furthermore, the notion of spatial reference can be represented as a Factory
 * ID (numeric) value, or it can be an ADF instance of a WebSpatialReference.
 * 
 */
public interface Bookmark {

	/**
	 * Getter for a perhaps long-winded description of this bookmark.
	 * 
	 * @return the description, if any
	 */
	public abstract String getDescription();

	/**
	 * Corresponding setter
	 * 
	 * @param description
	 *            whatever the caller wants, if anything
	 */
	public abstract void setDescription(String description);

	/**
	 * The ADF-notion extent that defines the area or envelope of interest; can
	 * have its own spatial reference.
	 * 
	 * @return the WebExtent
	 */
	public abstract WebExtent getExtent();

	/**
	 * Corresponding setter.
	 * 
	 * @param extent
	 *            with or possibly without its own WebSpatialReference
	 */
	public abstract void setExtent(WebExtent extent);

	/**
	 * The simple, perhaps shortish name of this bookmark
	 * 
	 * @return that name
	 */
	public abstract String getName();

	/**
	 * Corresponding setter
	 * 
	 * @param name
	 *            whatever the caller wants, if anything
	 */
	public abstract void setName(String name);

	/**
	 * Getter for this bookmark's spatial reference, if any (there ought to be,
	 * but the caller must manage these things).
	 * 
	 * @return the specified WebSpatialReference, if any
	 */
	public abstract WebSpatialReference getSpatialReference();

	/**
	 * Corresponding setter
	 * @param spatialReference whatever the caller wants, if anything (should be consistent with
	 * what referenceID the sref has, but the burden rests on the caller and/or implementor
	 * to manage that aspect).
	 */
	public abstract void setSpatialReference(
			WebSpatialReference spatialReference);

	/**
	 * The factory ID of the spatial reference of this bookmark.
	 * 
	 * @return the factory ID
	 */
	public abstract Integer getSpatialReferenceId();

	/**
	 * Setter of the factory ID of the spatial reference.
	 * 
	 * @param spatialReferenceId
	 */
	public abstract void setSpatialReferenceId(Integer spatialReferenceId);

}