IlvUnit (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.maps.IlvUnit

All Implemented Interfaces:: IlvPersistentObject, Serializable

Direct Known Subclasses:: IlvAngularUnit, IlvLinearUnit

public abstract class IlvUnit
extends Object
implements IlvPersistentObject

The base class for all the units used in the maps package. All derived units are required to be convertible to a kernel unit. This allows values specified in any unit to be automatically converted as needed. The kernel units for all quantities are those defined by the International System of Units (SI). For example:

for lengths : meters,
for time : seconds,
for angles : radians,
etc...

Registered units can be retrieved using the GetRegisteredUnit method or listed using the GetRegisteredUnits method.
The default registered list of linear units includes:

Unit name	Unit abbreviation	Meters per unit
Kilometer	km	1000
Meter	m	1
Decimeter	dm	0.1
Centimeter	cm	0.01
Millimeter	mm	0.001
International Nautical Mile	kmi	1852
International Inch	in	0.0254
International Foot	ft	0.3048
International Yard	yd	0.9144
International Statute Mile	mi	1609.344
International Fathom	fath	1.8288
International Chain	ch	20.1168
International Link	link	0.201168
U.S. Surveyor's Inch	us-in	1./39.37
U.S. Surveyor's Foot	us-ft	0.304800609601219
U.S. Surveyor's Yard	us-yd	0.914401828803658
U.S. Surveyor's Chain	us-ch	20.11684023368047
U.S. Surveyor's Statute Mile	us-mi	1609.347218694437
Indian Yard	ind-yd	0.91439523
Indian Foot	ind-ft	0.30479841

Since:: JViews 5.0
See Also:: Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IlvUnit(IlvInputStream stream)` Reads the object from an `IlvInputStream` object.
`protected`	`IlvUnit(IlvUnit source)` Constructs a new unit by copying an existing one.
`protected`	`IlvUnit(String name, String abbreviation)` Constructs a new unit with the specified name and abbreviation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` Returns `true` if the specified object is another unit equal to this unit.
`abstract boolean`	`equivalent(IlvUnit unit)` Returns `true` if the specified unit is equivalent to this one.
`abstract double`	`fromKernel(double value)` Converts the value specified in the kernel unit of the quantity measured by this unit, to values in this unit.
`String`	`getAbbreviation()` Returns an abbreviation for the unit.
`String`	`getLocalizedAbbreviation(Locale locale)` Returns the abbreviation of the unit.
`String`	`getLocalizedName(Locale locale)` Returns the name of the unit.
`String`	`getName()` Returns the name of the unit.
`static IlvUnit`	`GetRegisteredUnit(String abbreviation)` Returns the registered unit whose abbreviation is specified as argument.
`static Enumeration<IlvUnit>`	`GetRegisteredUnits()` Returns a list of all registered units.
`abstract double`	`toKernel(double value)` Converts the value specified in the units of this `IlvUnit` to the kernel unit (for example, meters for linear units and radians for angular units).
`String`	`toString()` Returns a string representation of this `IlvUnit`.
`void`	`write(IlvOutputStream stream)` Writes the object to the specified `IlvOutputStream`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IlvUnit
```
protected IlvUnit(String name,
                  String abbreviation)
```
    Constructs a new unit with the specified name and abbreviation. The unit name is the full name of the unit (for example, "International Nautical Mile"). The abbreviation is the abbreviation used for this unit (for example, "kmi").
    
    Parameters:
    
    name - The name of the unit.
    
    abbreviation - The abbreviation of the unit.
  - IlvUnit
```
protected IlvUnit(IlvUnit source)
```
    Constructs a new unit by copying an existing one.
    
    Parameters:
    
    source - The unit to copy.
  - IlvUnit
```
protected IlvUnit(IlvInputStream stream)
           throws IlvReadFileException
```
    Reads the object from an IlvInputStream object.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - If the format is not correct.
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the object to the specified IlvOutputStream.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - The stream to write this unit to.
    
    Throws:
    
    IOException - If an I/O error occurs.
  - getName
```
public String getName()
```
    Returns the name of the unit.
  - getLocalizedName
```
public String getLocalizedName(Locale locale)
```
    Returns the name of the unit.
    
    Since:
    
    JViews 8.7
  - getAbbreviation
```
public String getAbbreviation()
```
    Returns an abbreviation for the unit.
  - getLocalizedAbbreviation
```
public String getLocalizedAbbreviation(Locale locale)
```
    Returns the abbreviation of the unit.
    
    Since:
    
    JViews 8.8
  - toString
```
public String toString()
```
    Returns a string representation of this IlvUnit. Usually, the representation is the abbreviation of a unit.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The abbreviation of the unit or the void string if there is no abbreviation.
  - toKernel
```
public abstract double toKernel(double value)
```
    Converts the value specified in the units of this IlvUnit to the kernel unit (for example, meters for linear units and radians for angular units).
    
    Parameters:
    
    value - The value to convert.
    
    Returns:
    
    The value converted to kernel units.
  - fromKernel
```
public abstract double fromKernel(double value)
```
    Converts the value specified in the kernel unit of the quantity measured by this unit, to values in this unit.
    
    Parameters:
    
    value - The value expressed in kernel units.
    
    Returns:
    
    The value converted to the units represented by this object.
  - equivalent
```
public abstract boolean equivalent(IlvUnit unit)
```
    Returns true if the specified unit is equivalent to this one. Two units are equivalent if :
    - They measure the same physical quantity.
    - The same value in each unit is converted to the same kernel unit.
    Parameters:
    
    unit - The unit to compare to.
    
    Returns:
    
    true if the two units are equivalent.
  - equals
```
public boolean equals(Object object)
```
    Returns true if the specified object is another unit equal to this unit. This default implementation returns true if the two units are equivalent and if they have the same name and abbreviations.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The object to compare to.
    
    Returns:
    
    true if the two units are equal.
  - GetRegisteredUnit
```
public static IlvUnit GetRegisteredUnit(String abbreviation)
```
    Returns the registered unit whose abbreviation is specified as argument.
    
    Parameters:
    
    abbreviation - The abbreviation of the measurement unit.
    
    Returns:
    
    null if the unit converter is not registered.
    
    See Also:
    
    GetRegisteredUnits()
  - GetRegisteredUnits
```
public static Enumeration<IlvUnit> GetRegisteredUnits()
```
    Returns a list of all registered units.
    
    Returns:
    
    An enumeration. The elements of the enumeration are instances of IlvLinearUnit.
    
    See Also:
    
    GetRegisteredUnit(java.lang.String)

Class IlvUnit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvUnit

IlvUnit

IlvUnit

Method Detail

write

getName

getLocalizedName

getAbbreviation

getLocalizedAbbreviation

toString

toKernel

fromKernel

equivalent

equals

GetRegisteredUnit

GetRegisteredUnits