core/org.eclipse.stem.definitions/src/org/eclipse/stem/definitions/labels/AreaLabelValue.java

// AreaLabelValue.java
package org.eclipse.stem.definitions.labels;

/******************************************************************************* 
 * Copyright (c) 2007 IBM Corporation and others. 
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0 
 * which accompanies this distribution, and is available at 
 * http://www.eclipse.org/legal/epl-v10.html 
 * 
 * Contributors: 
 *     IBM Corporation - initial API and implementation 
 *******************************************************************************/

import org.eclipse.stem.core.graph.LabelValue;

/**
 * This interface defines a class in an EMF model for a Area Label Value.
 * 
 * @model
 */
public interface AreaLabelValue extends LabelValue {

	/**
	 * @return the area in square Kilometers
	 * @model
	 */
	double getArea();
	
	/**
	 * @return the area in square Kilometers
	 * @model
	 */
	double getAverageExtent();

	/**
	 * Sets the value of the '{@link org.eclipse.stem.definitions.labels.AreaLabelValue#getAverageExtent <em>Average Extent</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * The Average Extent is just the square root of the area.
	 * It is necessary to retain this value as it is quite expenseive to commute.
	 * Average extent can be compared, for example, to an average commute distance.
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Average Extent</em>' attribute.
	 * @see #getAverageExtent()
	 * @generated
	 */
	void setAverageExtent(double value);

	/**
	 * Sets the value of the '{@link org.eclipse.stem.definitions.labels.AreaLabelValue#getArea <em>Area</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Area</em>' attribute.
	 * @see #getArea()
	 * @generated
	 */
	void setArea(double value);

} // AreaLabelValue