TLcdDistanceFormat (LuciadLightspeed API documentation)

java.lang.Object
- java.text.Format
- - com.luciad.text.TLcdDistanceFormat

All Implemented Interfaces:

ILcdFormatter, ILcdParser, Serializable, Cloneable
```
public class TLcdDistanceFormat
extends Format
implements Serializable, ILcdFormatter, ILcdParser
```
Parses and formats distances. More specifically:

- it parses a string containing distances in any unit (or without any unit) into doubles of the chosen 'program' unit

- it formats a double of the given 'program' unit into a String containing the chosen 'user' unit

Example for user unit 'TLcdDistanceUnit.METRE_UNIT' and program unit 'TLcdDistanceUnit.KM_UNIT'

- Parsing '1000 m' will result in 1 (km)

- Formatting '20' (km) will result in '20000 m'
By using the ParsePosition, a string containing more than one distance can be parsed too. For instance, this string contains four distances:
```
" 12km 13 1mi3some text"
```
It can be parsed by calling parse four times with the same parse position instance. The parse position will be just before "some text". A distance format configured with km as its program unit and mi as its user unit will parse the following speeds, all in km: 12, 20.92..., 1.60..., and 4.82... A subsequent parse will return null, because "some text" cannot be parsed.
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.text.Format
  Format.Field

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NUMBER_FIELD` Indicates the field containing the number of the distance.
`static int`	`UNIT_FIELD` Indicates the field containing the unit short name.

Constructor Summary

Constructors
Constructor and Description
`TLcdDistanceFormat()` Create a distance format with user unit: `TLcdDistanceUnit.METRE_UNIT` program unit: `TLcdDistanceUnit.METRE_UNIT`
`TLcdDistanceFormat(TLcdDistanceUnit aUserUnit)` Create a distance format with program unit: `TLcdDistanceUnit.METRE_UNIT`
`TLcdDistanceFormat(TLcdDistanceUnit aProgramUnit, TLcdDistanceUnit aUserUnit)` Create a distance format.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`StringBuffer`	`format(Object aObject, StringBuffer aStringBufferToAppendTo, FieldPosition aFieldPosition)`
`String`	`formatDistance(double aDistance)` Format the distance as a String given the distance as a double (in program unit).
`StringBuffer`	`formatDistance(double aDistance, StringBuffer aToAppendToSFCT)` Format the distance (in program unit) as a String and append to the given StringBuffer.
`StringBuffer`	`formatDistance(double aDistance, StringBuffer aToAppendToSFCT, FieldPosition aFieldPosition)` Formats the given distance and appends that to the given string buffer.
`int`	`getFractionDigits()` Returns the number of fraction digits used to format the measurement.
`int`	`getMaximumFractionDigits()` Returns the maximum number of digits allowed in the fraction portion of a distance.
`int`	`getMinimumFractionDigits()` Returns the minimum number of digits allowed in the fraction portion of a distance.
`String`	`getNaNString()` Returns the string used for NaN values.
`TLcdDistanceUnit`	`getProgramUnit()` Returns the program unit.
`TLcdDistanceUnit`	`getUserUnit()` Returns the user unit.
`boolean`	`isAddUnitShortName()` Returns `true` if format will add the unit short name, `false` otherwise.
`Object`	`parse(String aString)` Parses a given `String` and creates a new `Object` with the corresponding type/properties.
`double`	`parseDistance(String aDistanceString)` Returns the distance (in program unit) given a distance as a string (in user unit).
`double`	`parseDistance(String aDistanceString, ParsePosition aParsePosition)` Returns the distance (in program unit) given a distance as a string (in user unit).
`Object`	`parseObject(String aString, ParsePosition aParsePosition)`
`void`	`setAddUnitShortName(boolean aAddUnitShortName)` Sets if format should add the unit short name.
`void`	`setFractionDigits(int aFractionDigitCount)` Sets the number of fraction digits that should be used when formatting the measurement.
`void`	`setMaximumFractionDigits(int aMaximumFractionDigits)` Sets the maximum number of digits allowed in the fraction portion of a distance.
`void`	`setMinimumFractionDigits(int aMinimumFractionDigits)` Sets the minimum number of digits allowed in the fraction portion of a distance.
`void`	`setNaNString(String aNaNString)` Sets the string that should be used for NaN values.
`void`	`setProgramUnit(TLcdDistanceUnit aProgramUnit)` Sets the program unit.
`void`	`setUserUnit(TLcdDistanceUnit aUserUnit)` Sets the user unit.
`String`	`toString()`

Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject

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

Methods inherited from interface com.luciad.util.ILcdFormatter
format

- Field Detail
  - NUMBER_FIELD
```
public static final int NUMBER_FIELD
```
    Indicates the field containing the number of the distance. It is, the distance without the unit short name. Use format with a FieldPosition with field NUMBER_FIELD to know the start and end index of the number.
    
    See Also:
    
    Constant Field Values
  - UNIT_FIELD
```
public static final int UNIT_FIELD
```
    Indicates the field containing the unit short name. Use format with a FieldPosition with field UNIT_FIELD to know the start and end index of the unit short name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLcdDistanceFormat
```
public TLcdDistanceFormat()
```
    Create a distance format with
    user unit: TLcdDistanceUnit.METRE_UNIT
    program unit: TLcdDistanceUnit.METRE_UNIT
  - TLcdDistanceFormat
```
public TLcdDistanceFormat(TLcdDistanceUnit aUserUnit)
```
    Create a distance format with
    program unit: TLcdDistanceUnit.METRE_UNIT
  - TLcdDistanceFormat
```
public TLcdDistanceFormat(TLcdDistanceUnit aProgramUnit,
                          TLcdDistanceUnit aUserUnit)
```
    Create a distance format.
- Method Detail
  - getProgramUnit
```
public TLcdDistanceUnit getProgramUnit()
```
    Returns the program unit.
    
    Returns:
    
    the program unit.
    
    See Also:
    
    setProgramUnit(com.luciad.util.TLcdDistanceUnit)
  - setProgramUnit
```
public void setProgramUnit(TLcdDistanceUnit aProgramUnit)
```
    Sets the program unit. Format will assume the given distance is in this unit. Parse will convert the parsed number to this unit.
    
    Parameters:
    
    aProgramUnit - The program unit.
    
    See Also:
    
    getProgramUnit()
  - getUserUnit
```
public TLcdDistanceUnit getUserUnit()
```
    Returns the user unit.
    
    Returns:
    
    the user unit.
    
    See Also:
    
    setUserUnit(com.luciad.util.TLcdDistanceUnit)
  - setUserUnit
```
public void setUserUnit(TLcdDistanceUnit aUserUnit)
```
    Sets the user unit. Format.format(Object) will convert the given measurement to this unit. Format.parseObject(String) will detect and parse the user unit as well as other units of the same measure type. When no unit name is provided the format assumes the value is in the user unit.
    
    Parameters:
    
    aUserUnit - The user unit.
    
    See Also:
    
    getUserUnit()
  - isAddUnitShortName
```
public boolean isAddUnitShortName()
```
    Returns true if format will add the unit short name, false otherwise.
    
    Returns:
    
    true if format will add the unit short name, false otherwise.
    
    See Also:
    
    setAddUnitShortName(boolean)
  - setAddUnitShortName
```
public void setAddUnitShortName(boolean aAddUnitShortName)
```
    Sets if format should add the unit short name. Note that parsing ignores this setting.
    
    Parameters:
    
    aAddUnitShortName - true if unit short name should be added, false otherwise.
    
    See Also:
    
    isAddUnitShortName()
  - getFractionDigits
```
public int getFractionDigits()
```
    Returns the number of fraction digits used to format the measurement. This is the same value as the getMinimumFractionDigits returns.
    
    Returns:
    
    the number of fraction digits used to format the measurement.
    
    See Also:
    
    setFractionDigits(int), getMinimumFractionDigits()
  - setFractionDigits
```
public void setFractionDigits(int aFractionDigitCount)
```
    Sets the number of fraction digits that should be used when formatting the measurement. This sets both the minimum and the maximum fraction digits.
    
    Parameters:
    
    aFractionDigitCount - The number of fraction digits.
    
    See Also:
    
    getFractionDigits(), setMinimumFractionDigits(int), setMaximumFractionDigits(int)
  - setMinimumFractionDigits
```
public void setMinimumFractionDigits(int aMinimumFractionDigits)
```
    Sets the minimum number of digits allowed in the fraction portion of a distance.
    
    Parameters:
    
    aMinimumFractionDigits - the minimum number of fraction digits to be shown; if less than zero, then zero is used.
    
    See Also:
    
    getMinimumFractionDigits()
  - getMinimumFractionDigits
```
public int getMinimumFractionDigits()
```
    Returns the minimum number of digits allowed in the fraction portion of a distance.
    
    Returns:
    
    the minimum number of digits allowed in the fraction portion of a distance
    
    See Also:
    
    setMinimumFractionDigits(int)
  - setMaximumFractionDigits
```
public void setMaximumFractionDigits(int aMaximumFractionDigits)
```
    Sets the maximum number of digits allowed in the fraction portion of a distance.
    
    Parameters:
    
    aMaximumFractionDigits - the maximum number of fraction digits to be shown; if less than zero, then zero is used.
    
    See Also:
    
    getMaximumFractionDigits()
  - getMaximumFractionDigits
```
public int getMaximumFractionDigits()
```
    Returns the maximum number of digits allowed in the fraction portion of a distance.
    
    Returns:
    
    the maximum number of digits allowed in the fraction portion of a distance.
    
    See Also:
    
    setMaximumFractionDigits(int)
  - getNaNString
```
public String getNaNString()
```
    Returns the string used for NaN values.
    
    Returns:
    
    the string used for NaN values.
    
    See Also:
    
    setNaNString(String)
  - setNaNString
```
public void setNaNString(String aNaNString)
```
    Sets the string that should be used for NaN values.
    
    Parameters:
    
    aNaNString - the string to use.
    
    See Also:
    
    getNaNString()
  - format
```
public StringBuffer format(Object aObject,
                           StringBuffer aStringBufferToAppendTo,
                           FieldPosition aFieldPosition)
```
    Specified by:
    
    format in class Format
  - parse
```
public Object parse(String aString)
             throws IllegalArgumentException
```
    Description copied from interface: ILcdParser
    
    Parses a given String and creates a new Object with the corresponding type/properties.
    
    Specified by:
    
    parse in interface ILcdParser
    
    Parameters:
    
    aString - the String to be parsed.
    
    Returns:
    
    the resulting new Object.
    
    Throws:
    
    IllegalArgumentException - if the String can't be parsed.
  - parseObject
```
public Object parseObject(String aString,
                          ParsePosition aParsePosition)
```
    Specified by:
    
    parseObject in class Format
  - formatDistance
```
public String formatDistance(double aDistance)
```
    Format the distance as a String given the distance as a double (in program unit).
    
    Parameters:
    
    aDistance - the distance as a double (in program unit).
    
    Returns:
    
    the String representation of the distance.
  - formatDistance
```
public StringBuffer formatDistance(double aDistance,
                                   StringBuffer aToAppendToSFCT)
```
    Format the distance (in program unit) as a String and append to the given StringBuffer.
    
    Parameters:
    
    aDistance - the distance as a double (in program unit).
    
    aToAppendToSFCT - The string buffer to append to.
    
    Returns:
    
    The given StringBuffer: aToAppendToSFCT
  - formatDistance
```
public StringBuffer formatDistance(double aDistance,
                                   StringBuffer aToAppendToSFCT,
                                   FieldPosition aFieldPosition)
```
    Formats the given distance and appends that to the given string buffer. The distance (in program unit) will be converted to user unit.
    
    Parameters:
    
    aDistance - Must be instance of Number.
    
    aToAppendToSFCT - The string buffer where the formatted distance will be appended to.
    
    aFieldPosition - NUMBER_FIELD or USER_FIELD. Can be used to retrieve the indices of the unit or of the number.
    
    Returns:
    
    The given StringBuffer: aStringBufferToAppendTo
  - parseDistance
```
public double parseDistance(String aDistanceString)
                     throws ParseException
```
    Returns the distance (in program unit) given a distance as a string (in user unit).
    
    Parameters:
    
    aDistanceString - The string to parse, assumed to be in the user unit.
    
    Returns:
    
    A Double with the distance converted to the program unit.
    
    Throws:
    
    ParseException - If the given string cannot be parsed.
  - parseDistance
```
public double parseDistance(String aDistanceString,
                            ParsePosition aParsePosition)
                     throws ParseException
```
    Returns the distance (in program unit) given a distance as a string (in user unit).
    
    Parameters:
    
    aDistanceString - The string to parse, assumed to be in the user unit.
    
    aParsePosition - The position to start the parsing at.
    
    Returns:
    
    A Double with the distance converted to the program unit.
    
    Throws:
    
    ParseException - If the given string cannot be parsed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Format

LuciadLightspeedClass TLcdDistanceFormat

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.text.Format

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.util.ILcdFormatter

Field Detail

NUMBER_FIELD

UNIT_FIELD

Constructor Detail

TLcdDistanceFormat

TLcdDistanceFormat

TLcdDistanceFormat

Method Detail

getProgramUnit

setProgramUnit

getUserUnit

setUserUnit

isAddUnitShortName

setAddUnitShortName

getFractionDigits

setFractionDigits

setMinimumFractionDigits

getMinimumFractionDigits

setMaximumFractionDigits

getMaximumFractionDigits

getNaNString

setNaNString

format

parse

parseObject

formatDistance

formatDistance

formatDistance

parseDistance

parseDistance

toString

clone