com.esri.core.geometry
Class AreaUnit

java.lang.Object
  com.esri.core.geometry.Unit
      com.esri.core.geometry.AreaUnit

All Implemented Interfaces:

Serializable

public class AreaUnit
extends Unit

The units to measure for areas.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

static interface

AreaUnit.Code Area unit codes.

Nested classes/interfaces inherited from class com.esri.core.geometry.Unit

Unit.EsriUnit, Unit.UnitType

Field Summary

Fields inherited from class com.esri.core.geometry.Unit

m_factor, mAbbreviation, mDisplayName, mID, mName, mPluralDisplayName, mWKID

Constructor Summary

AreaUnit(int WKID)

Method Summary

double	convertFromSquareMeters(double squareMeters) Converts square meters to the area units of the object.
double	convertToSquareMeters(double thisUnitValue) Converts the area units to square meters of the object.
boolean	equals(Object other) Indicates if this unit is the same type (linear, angular, or area) and the same unit(meter, degree, acre, etc.)as another.
String	getAbbreviation() Returns the abbreviated name of this unit.
double	getConversionFactor(Unit dstUnit) Returns a conversion factor from this unit to the destination unit.
String	getDisplayName() Returns the display name of this unit.
int	getID() Returns the unit's well-known ID.
String	getName() Returns the canonical name of the unit as defined in Projection Engine.
String	getPluralDisplayName() Returns the display name of this unit.
Unit.UnitType	getUnitType() Returns the unit type.

Methods inherited from class com.esri.core.geometry.Unit

convertUnits, convertUnits, create, getUnitToBaseFactor, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AreaUnit

public AreaUnit(int WKID)

Parameters:

WKID - well-known ID.

Since:

1.0

Method Detail

getName

public String getName()

Returns the canonical name of the unit as defined in Projection Engine.

Specified by:

getName in class Unit

Returns:

A string representation of Projection Engine unit name.

Since:

1.0

getDisplayName

public String getDisplayName()

Returns the display name of this unit.

Specified by:

getDisplayName in class Unit

Returns:

A string value of unit display name.

Since:

1.0

getPluralDisplayName

public String getPluralDisplayName()

Returns the display name of this unit.

Specified by:

getPluralDisplayName in class Unit

Returns:

string value of plural display name

Since:

1.0

getAbbreviation

public String getAbbreviation()

Returns the abbreviated name of this unit.

Specified by:

getAbbreviation in class Unit

Returns:

A string value of abbreviation for unit.

Since:

1.0

getID

public int getID()

Returns the unit's well-known ID.

Specified by:

getID in class Unit

Returns:

Integer value for wkid.

Since:

1.0

getConversionFactor

public double getConversionFactor(Unit dstUnit)

Returns a conversion factor from this unit to the destination unit.

Specified by:

getConversionFactor in class Unit

Parameters:

dstUnit - The destination unit.

Returns:

A double conversion factor.

Since:

1.0

equals

public boolean equals(Object other)

Indicates if this unit is the same type (linear, angular, or area) and the same unit(meter, degree, acre, etc.)as another.

Overrides:

equals in class Unit

Parameters:

other - The other object.

Returns:

true, if equals

Since:

1.0

getUnitType

public Unit.UnitType getUnitType()

Returns the unit type.

Specified by:

getUnitType in class Unit

Returns:

the unit type

Since:

1.0

convertFromSquareMeters

public double convertFromSquareMeters(double squareMeters)

Converts square meters to the area units of the object.

Parameters:

squareMeters - The value in square meters.

Returns:

The area unit value corresponding to the input parameter.

Since:

1.0

convertToSquareMeters

public double convertToSquareMeters(double thisUnitValue)

Converts the area units to square meters of the object.

Parameters:

thisUnitValue - The value in this area units to convert.

Returns:

The value in square meters corresponding to the input parameter.

Since:

1.0