basemaptemplate.java

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

package com.esri.solutions.jitk.common.templates.map;

/**
 * Defines basic functionality for a Map Template object.  This class
 * implements the getters and setters for the ID, Name, and Description
 * properties.  This class also implements a reference to the Map
 * Template Repository that this Map Template is a member of.
 */
public abstract class BaseMapTemplate implements IMapTemplate {

	/**
	 * Reference to the Map Template Repository that contains
	 * the Map Template.
	 */
	protected IMapTemplateRepository m_repo;
	
	/**
	 * ID of the Map Template
	 */
	protected String m_id;
	
	/**
	 * Name of the Map Template
	 */
	protected String m_name;
	
	/**
	 * Description of the Map Template
	 */
	protected String m_description;

	/*
	 * (non-Javadoc)
	 * @see com.esri.solutions.jitk.common.templates.map.IMapTemplate#getDescription()
	 */
	public String getDescription() {
		return m_description;
	}

	/*
	 * (non-Javadoc)
	 * @see com.esri.solutions.jitk.common.templates.map.IMapTemplate#getId()
	 */
	public String getId() {
		return m_id;
	}

	/*
	 * (non-Javadoc)
	 * @see com.esri.solutions.jitk.common.templates.map.IMapTemplate#getName()
	 */
	public String getName() {
		return m_name;
	}

	/*
	 * (non-Javadoc)
	 * @see com.esri.solutions.jitk.common.templates.map.IMapTemplate#getRepository()
	 */
	public IMapTemplateRepository getRepository() {
		return m_repo;
	}

	/**
	 * Sets the ID of the Map Template.  The ID is required and
	 * should not be <code>null</code>.  The ID uniquely identifies
	 * the Map Template with the Map Template Repository.
	 * 
	 * @param id  ID of the Map Template, cannot be <code>null</code>
	 * @throws NullPointerException		Thrown if the ID is 
	 * 									<code>null</code>.
	 */
	public void setId(String id) {
		if (id == null) {
			throw new NullPointerException ();
		}
		m_id = id;
	}

	/**
	 * Sets the Name of the Map Template.  The Name is required and
	 * should not be <code>null</code>.
	 * 
	 * @param name Name of the Map Template, cannot be <code>null</code>
	 * @throws NullPointerException		Thrown if the Name is <code>null</code>.
	 */
	public void setName(String name) {
		if (name == null) {
			throw new NullPointerException();
		}
		m_name = name;
	}

	/**
	 * Sets the Description of the Map Template.  The Description
	 * is optional and can be <code>null</code>.
	 * 
	 * @param description Description of Map Template, optional.
	 */
	public void setDescription(String description) {
		m_description = description;
	}

	/**
	 * Sets the reference to the Map Template Repository that
	 * contains this Map Template.
	 * 
	 * @param repo  Reference to Map Template Repository.
	 */
	public void setRepository(IMapTemplateRepository repo) {
		m_repo = repo;
	}

}