com.esri.sde.sdk.pe
Class PeUnit

java.lang.Object
  extended by com.esri.sde.sdk.pe.PeObject
      extended by com.esri.sde.sdk.pe.PeUnit
All Implemented Interfaces:
java.lang.Cloneable

public final class PeUnit
extends PeObject

This class defines a unit object.


Constructor Summary
PeUnit(java.lang.String str)
          Constructor.
PeUnit(java.lang.String name, double factor)
          Constructor.
 
Method Summary
 java.lang.Object clone()
          Clone a unit.
 void delete()
          Deconstructor.
static PeUnit fromString(java.lang.String str)
          Create a unit from a string.
 PeAuthority getAuth()
          Retrieve a units's authority.
 int getCode()
           
 java.lang.String getName()
          Retrieve a unit's name.
 int getStatus()
          Retrieve a unit's status.
 int getType()
          Retrieve a unit's type.
 double getUnitFactor()
          Retrieve's a unit's conversion factor.
 boolean isEqual(PeObject peobj)
          Check if both objects are equal.
 boolean isEqual(PeUnit unit)
          Test if two units are identical.
 void setAuth(PeAuthority authority)
          Store a authority in a unit.
 java.lang.String toString()
          Retrieve the external representation of a unit.
 java.lang.String toString(int mode)
          Retrieve the extended external representation of a unit.
 
Methods inherited from class com.esri.sde.sdk.pe.PeObject
fromAnyString, fromStringByType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PeUnit

public PeUnit(java.lang.String name,
              double factor)
       throws PeProjectionException
Constructor.

Throws:
PeProjectionException

PeUnit

public PeUnit(java.lang.String str)
       throws PeProjectionException
Constructor.

Throws:
PeProjectionException
Method Detail

fromString

public static PeUnit fromString(java.lang.String str)
                         throws PeProjectionException
Create a unit from a string.

Throws:
PeProjectionException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone a unit.

Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

delete

public void delete()
Deconstructor.

Specified by:
delete in class PeObject

getName

public java.lang.String getName()
Retrieve a unit's name.

Specified by:
getName in class PeObject

getType

public int getType()
Retrieve a unit's type.

Specified by:
getType in class PeObject

getStatus

public int getStatus()
Retrieve a unit's status.

Specified by:
getStatus in class PeObject

isEqual

public boolean isEqual(PeObject peobj)
Check if both objects are equal.

Specified by:
isEqual in class PeObject

isEqual

public boolean isEqual(PeUnit unit)
Test if two units are identical.


toString

public java.lang.String toString()
Retrieve the external representation of a unit.

Specified by:
toString in class PeObject

toString

public java.lang.String toString(int mode)
Retrieve the extended external representation of a unit.

Specified by:
toString in class PeObject

getAuth

public PeAuthority getAuth()
Retrieve a units's authority.

Specified by:
getAuth in class PeObject

setAuth

public void setAuth(PeAuthority authority)
Store a authority in a unit.

Specified by:
setAuth in class PeObject

getUnitFactor

public double getUnitFactor()
Retrieve's a unit's conversion factor.


getCode

public int getCode()
Specified by:
getCode in class PeObject