org.sweble.wikitext.engine.ext.convert

Class Convert

java.lang.Object

org.sweble.wikitext.engine.ParserFunctionBase

org.sweble.wikitext.engine.ext.convert.Convert

All Implemented Interfaces:

Serializable, Comparable<ParserFunctionBase>

public class Convert
extends ParserFunctionBase

Template which converts a measurement unit into another. (e.g. {{convert|1|m}} -> "1 metre (3 ft 3 in)")

See Also:

https://en.wikipedia.org/wiki/Template:Convert/doc, https://en.wikipedia.org/wiki/Help:Convert, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sweble.wikitext.engine.ParserFunctionBase

ParserFunctionBase.ParserFunctionAdapter, ParserFunctionBase.ParserFunctionRef

Constructor Summary

Constructors

Constructor and Description
Convert()
Convert(WikiConfig wikiConfig)

Method Summary

Modifier and Type	Method and Description
protected static String	convertBaseTo(double siBaseValue, Units destUnit, org.sweble.wikitext.engine.ext.convert.Convert.AbbreviationMode abbreviationMode, int sigFig, boolean isUsNameUsed) Converts a SI base value to the given destination unit and returns the default formated Number with unit descriptor.
protected static String	convertToDefaultUnit(double value, Units srcUnit, org.sweble.wikitext.engine.ext.convert.Convert.AbbreviationMode abbreviationMode, int sigFig, boolean isUsNameUsed) Converts the given source unit value to its default destination unit.
WtNode	invoke(WtNode pnf, ExpansionFrame frame, List<? extends WtNode> args) WtNode can either be a WtTemplate or a WtPageSwitch

Methods inherited from class org.sweble.wikitext.engine.ParserFunctionBase

compareTo, equals, getArgMode, getId, getWikiConfig, hashCode, isPageSwitch, nf, setWikiConfig, toString, tu

Methods inherited from class java.lang.Object

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

Constructor Detail

Convert

public Convert()

Convert

public Convert(WikiConfig wikiConfig)

Method Detail

invoke

public WtNode invoke(WtNode pnf,
                     ExpansionFrame frame,
                     List<? extends WtNode> args)

Description copied from class: ParserFunctionBase

WtNode can either be a WtTemplate or a WtPageSwitch

Specified by:

invoke in class ParserFunctionBase

convertToDefaultUnit

protected static String convertToDefaultUnit(double value,
                                             Units srcUnit,
                                             org.sweble.wikitext.engine.ext.convert.Convert.AbbreviationMode abbreviationMode,
                                             int sigFig,
                                             boolean isUsNameUsed)

Converts the given source unit value to its default destination unit. This is necessary when no target unit was given via arguments.

Parameters:

value - The value to convert.

srcUnit - The unit type of the given value.

abbreviationMode - Determines the way to describe the unit (symbol or name).

sigFig - The count of significant figures to round.

isUsNameUsed -

Returns:

The converted and default formated number as String including the unit descriptor (symbol or name), or null on error.

See Also:

convertBaseTo()

convertBaseTo

protected static String convertBaseTo(double siBaseValue,
                                      Units destUnit,
                                      org.sweble.wikitext.engine.ext.convert.Convert.AbbreviationMode abbreviationMode,
                                      int sigFig,
                                      boolean isUsNameUsed)

Converts a SI base value to the given destination unit and returns the default formated Number with unit descriptor.

Parameters:

siBaseValue - The value given in a SI base unit.

destUnit - The unit the value gets converted to.

abbreviationMode - Determines whether the unit symbol or the entire name is used as descriptor.

sigFig - The count of significant figures to round.

isUsNameUsed - Determines whether the US name is used or not (e.g. "meter" instead of "metre").

Returns:

The converted and default formated number as String including the unit descriptor (symbol or name), or null on error.