tec.uom.se.format

Class SimpleUnitFormat.DefaultFormat

java.lang.Object

tec.uom.se.format.AbstractUnitFormat

tec.uom.se.format.SimpleUnitFormat

tec.uom.se.format.SimpleUnitFormat.DefaultFormat

All Implemented Interfaces:

javax.measure.format.UnitFormat

Direct Known Subclasses:

SimpleUnitFormat.ASCIIFormat

Enclosing class:

SimpleUnitFormat

protected static class SimpleUnitFormat.DefaultFormat
extends SimpleUnitFormat

This class represents the standard format.

Nested Class Summary

Nested classes/interfaces inherited from class tec.uom.se.format.SimpleUnitFormat

SimpleUnitFormat.ASCIIFormat, SimpleUnitFormat.DefaultFormat, SimpleUnitFormat.Flavor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.HashMap<java.lang.String,javax.measure.Unit<?>>	_nameToUnit Holds the name to unit mapping.
(package private) java.util.HashMap<javax.measure.Unit<?>,java.lang.String>	_unitToName Holds the unit to name mapping.
private static int	CLOSE_PAREN
private static int	DIVIDE
private static int	EOF
private static int	EXPONENT
private static int	FLOAT
private static int	IDENTIFIER
private static int	INTEGER
private static int	MULTIPLY
private static int	OPEN_PAREN
private static int	PLUS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultFormat()

Method Summary

Modifier and Type	Method and Description
void	alias(javax.measure.Unit<?> unit, java.lang.String alias) Attaches a system-wide alias to this unit.
private void	append(java.lang.Appendable appendable, java.lang.CharSequence symbol, int pow, int root)
private void	check(boolean expr, java.lang.String message, java.lang.CharSequence csq, int index)
java.lang.Appendable	format(javax.measure.Unit<?> unit, java.lang.Appendable appendable) Formats the specified unit.
protected SymbolMap	getSymbols() Returns the SymbolMap for this unit format.
(package private) static boolean	isUnitIdentifierPart(char ch)
boolean	isValidIdentifier(java.lang.String name) Indicates if the specified name can be used as unit identifier.
void	label(javax.measure.Unit<?> unit, java.lang.String label) Attaches a system-wide label to the specified unit.
java.lang.String	nameFor(javax.measure.Unit<?> unit)
private int	nextToken(java.lang.CharSequence csq, java.text.ParsePosition pos)
javax.measure.Unit<?>	parse(java.lang.CharSequence csq)
protected javax.measure.Unit<?>	parse(java.lang.CharSequence csq, int index) Parses a portion of the specified CharSequence from the specified position to produce a unit.
protected javax.measure.Unit<?>	parse(java.lang.CharSequence csq, java.text.ParsePosition cursor) Parses a portion of the specified CharSequence from the specified position to produce a unit.
javax.measure.Unit<? extends javax.measure.Quantity>	parseProductUnit(java.lang.CharSequence csq, java.text.ParsePosition pos) Parses a sequence of character to produce a unit or a rational product of unit.
javax.measure.Unit<? extends javax.measure.Quantity>	parseSingleUnit(java.lang.CharSequence csq, java.text.ParsePosition pos) Parses a sequence of character to produce a single unit.
private double	readDouble(java.lang.CharSequence csq, java.text.ParsePosition pos)
private SimpleUnitFormat.Exponent	readExponent(java.lang.CharSequence csq, java.text.ParsePosition pos)
private java.lang.String	readIdentifier(java.lang.CharSequence csq, java.text.ParsePosition pos)
private long	readLong(java.lang.CharSequence csq, java.text.ParsePosition pos)
javax.measure.Unit<?>	unitFor(java.lang.String name)

Methods inherited from class tec.uom.se.format.SimpleUnitFormat

format, getInstance, getInstance, isAllASCII, isLocaleSensitive, parseObject

Methods inherited from class tec.uom.se.format.AbstractUnitFormat

format, format

Methods inherited from class java.lang.Object

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

Field Detail

_nameToUnit

final java.util.HashMap<java.lang.String,javax.measure.Unit<?>> _nameToUnit

Holds the name to unit mapping.

_unitToName

final java.util.HashMap<javax.measure.Unit<?>,java.lang.String> _unitToName

Holds the unit to name mapping.

EOF

private static final int EOF

See Also:

Constant Field Values

IDENTIFIER

private static final int IDENTIFIER

See Also:

Constant Field Values

OPEN_PAREN

private static final int OPEN_PAREN

See Also:

Constant Field Values

CLOSE_PAREN

private static final int CLOSE_PAREN

See Also:

Constant Field Values

EXPONENT

private static final int EXPONENT

See Also:

Constant Field Values

MULTIPLY

private static final int MULTIPLY

See Also:

Constant Field Values

DIVIDE

private static final int DIVIDE

See Also:

Constant Field Values

PLUS

private static final int PLUS

See Also:

Constant Field Values

INTEGER

private static final int INTEGER

See Also:

Constant Field Values

FLOAT

private static final int FLOAT

See Also:

Constant Field Values

Constructor Detail

DefaultFormat

protected DefaultFormat()

Method Detail

label

public void label(javax.measure.Unit<?> unit,
                  java.lang.String label)

Description copied from class: SimpleUnitFormat

Attaches a system-wide label to the specified unit. For example: [code] SimpleUnitFormat.getInstance().label(DAY.multiply(365), "year"); SimpleUnitFormat.getInstance().label(METER.multiply(0.3048), "ft"); [/code] If the specified label is already associated to an unit the previous association is discarded or ignored.

Specified by:

label in interface javax.measure.format.UnitFormat

Specified by:

label in class SimpleUnitFormat

Parameters:

unit - the unit being labelled.

label - the new label for this unit.

alias

public void alias(javax.measure.Unit<?> unit,
                  java.lang.String alias)

Description copied from class: SimpleUnitFormat

Attaches a system-wide alias to this unit. Multiple aliases may be attached to the same unit. Aliases are used during parsing to recognize different variants of the same unit. For example: [code] SimpleUnitFormat.getInstance().alias(METER.multiply(0.3048), "foot"); SimpleUnitFormat.getInstance().alias(METER.multiply(0.3048), "feet"); SimpleUnitFormat.getInstance().alias(METER, "meter"); SimpleUnitFormat.getInstance().alias(METER, "metre"); [/code] If the specified label is already associated to an unit the previous association is discarded or ignored.

Specified by:

alias in class SimpleUnitFormat

Parameters:

unit - the unit being aliased.

alias - the alias attached to this unit.

isValidIdentifier

public boolean isValidIdentifier(java.lang.String name)

Description copied from class: SimpleUnitFormat

Indicates if the specified name can be used as unit identifier.

Specified by:

isValidIdentifier in class SimpleUnitFormat

Parameters:

name - the identifier to be tested.

Returns:

true if the name specified can be used as label or alias for this format;false otherwise.

isUnitIdentifierPart

static boolean isUnitIdentifierPart(char ch)

nameFor

public java.lang.String nameFor(javax.measure.Unit<?> unit)

unitFor

public javax.measure.Unit<?> unitFor(java.lang.String name)

parseSingleUnit

public javax.measure.Unit<? extends javax.measure.Quantity> parseSingleUnit(java.lang.CharSequence csq,
                                                                            java.text.ParsePosition pos)
                                                                     throws javax.measure.format.ParserException

Description copied from class: SimpleUnitFormat

Parses a sequence of character to produce a single unit.

Specified by:

parseSingleUnit in class SimpleUnitFormat

Parameters:

csq - the CharSequence to parse.

pos - an object holding the parsing index and error position.

Returns:

an Unit parsed from the character sequence.

Throws:

javax.measure.format.ParserException

parseProductUnit

public javax.measure.Unit<? extends javax.measure.Quantity> parseProductUnit(java.lang.CharSequence csq,
                                                                             java.text.ParsePosition pos)
                                                                      throws javax.measure.format.ParserException

Description copied from class: SimpleUnitFormat

Parses a sequence of character to produce a unit or a rational product of unit.

Specified by:

parseProductUnit in class SimpleUnitFormat

Parameters:

csq - the CharSequence to parse.

pos - an object holding the parsing index and error position.

Returns:

an Unit parsed from the character sequence.

Throws:

javax.measure.format.ParserException

nextToken

private int nextToken(java.lang.CharSequence csq,
                      java.text.ParsePosition pos)

check

private void check(boolean expr,
                   java.lang.String message,
                   java.lang.CharSequence csq,
                   int index)
            throws javax.measure.format.ParserException

Throws:

javax.measure.format.ParserException

readExponent

private SimpleUnitFormat.Exponent readExponent(java.lang.CharSequence csq,
                                               java.text.ParsePosition pos)

readLong

private long readLong(java.lang.CharSequence csq,
                      java.text.ParsePosition pos)

readDouble

private double readDouble(java.lang.CharSequence csq,
                          java.text.ParsePosition pos)

readIdentifier

private java.lang.String readIdentifier(java.lang.CharSequence csq,
                                        java.text.ParsePosition pos)

format

public java.lang.Appendable format(javax.measure.Unit<?> unit,
                                   java.lang.Appendable appendable)
                            throws java.io.IOException

Description copied from class: SimpleUnitFormat

Formats the specified unit.

Specified by:

format in interface javax.measure.format.UnitFormat

Specified by:

format in class SimpleUnitFormat

Parameters:

unit - the unit to format.

appendable - the appendable destination.

Returns:

The appendable destination passed in as appendable, with formatted text appended.

Throws:

java.io.IOException - if an error occurs.

append

private void append(java.lang.Appendable appendable,
                    java.lang.CharSequence symbol,
                    int pow,
                    int root)
             throws java.io.IOException

Throws:

java.io.IOException

parse

public javax.measure.Unit<?> parse(java.lang.CharSequence csq)
                            throws javax.measure.format.ParserException

Throws:

javax.measure.format.ParserException

getSymbols

protected SymbolMap getSymbols()

Description copied from class: AbstractUnitFormat

Returns the SymbolMap for this unit format.

Specified by:

getSymbols in class AbstractUnitFormat

Returns:

the symbol map used by this format.

parse

protected javax.measure.Unit<?> parse(java.lang.CharSequence csq,
                                      int index)
                               throws java.lang.IllegalArgumentException

Description copied from class: AbstractUnitFormat

Parses a portion of the specified CharSequence from the specified position to produce a unit. If there is no unit to parse AbstractUnit.ONE is returned.

Specified by:

parse in class AbstractUnitFormat

Parameters:

csq - the CharSequence to parse.

index - the current parsing index.

Returns:

the unit parsed from the specified character sub-sequence.

Throws:

java.lang.IllegalArgumentException - if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

parse

protected javax.measure.Unit<?> parse(java.lang.CharSequence csq,
                                      java.text.ParsePosition cursor)
                               throws java.lang.IllegalArgumentException

Description copied from class: AbstractUnitFormat

Parses a portion of the specified CharSequence from the specified position to produce a unit. If there is no unit to parse AbstractUnit.ONE is returned.

Specified by:

parse in class AbstractUnitFormat

Parameters:

csq - the CharSequence to parse.

cursor - the cursor holding the current parsing index.

Returns:

the unit parsed from the specified character sub-sequence.

Throws:

java.lang.IllegalArgumentException - if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).