com.SIMRacingApps

Class Data

java.lang.Object

com.SIMRacingApps.Data

Direct Known Subclasses:

SessionData

public class Data
extends java.lang.Object

A container for all values returned from all Simulators.

It contains the following access get/set methods. Each set method returns "this", so you can chain them.

• Name - The name of the value.
• Value - The actual value untranslated
• UOM - Unit of Measure.
• UOMAbbr - The translated short abbreviation name for the UOM.
• UOMDescr - The translated long name for the UOM. Singular and Plural rules are applied.
• Format - A java format string using rules defined by String.format(Locale, String, Object...).
• FormattedValue - The value after it has been formated and translated.
• Lang - The locale used to translate and format the value returned in FormattedValue.
• State - A String value indicating the Value is within the range of a defined State.
• StatePercent - The percentage the value is between the range of the State.
• Type - The type the Value is as defined by Data.Type.
• isDirty - Compares new value to current, returns true if different. Initially true.

Multiple values can be added by name. The first named value added is called the default name. All of the access methods take "name" as an argument, but also there's an overloaded version that doesn't take a name and uses the default name.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Data.State Enumerates the States that are available, standard.
static class	Data.Type Defines the Type the Value is

Constructor Summary

Constructors

Constructor and Description
Data(Data data) Copy Constructor.
Data(java.lang.String name)
Data(java.lang.String name, java.lang.Object value)
Data(java.lang.String name, java.lang.Object value, java.lang.String UOM)
Data(java.lang.String name, java.lang.Object value, java.lang.String UOM, java.lang.String state) Constructor(s).

Method Summary

Modifier and Type	Method and Description
void	add(Data d) Adds all the named values from another Data instance.
void	add(java.lang.String name)
void	add(java.lang.String name, java.lang.Object value)
void	add(java.lang.String name, java.lang.Object value, java.lang.String UOM) Adds a new named value to this container Each argument is optional, except name which is required.
Data	addConversion(Data data) Add all the units from another data object.
Data	addConversion(java.lang.String fromUOM, java.lang.String toUOM, double factor) Add a unit of measure conversion directly to this object.
int	compare(Data data)
int	compare(Data data, java.lang.String name) Compares this instance to another Data instance.
Data	convertUOM(java.lang.String UOM)
Data	convertUOM(java.lang.String name, java.lang.String UOM)
boolean	equals(boolean b)
boolean	equals(Data pData)
boolean	equals(double d)
boolean	equals(float f)
boolean	equals(int i)
boolean	equals(long l)
boolean	equals(java.lang.String s)
boolean	equals(java.lang.String name, boolean b)
boolean	equals(java.lang.String name, double d)
boolean	equals(java.lang.String name, float f)
boolean	equals(java.lang.String name, int i)
boolean	equals(java.lang.String name, long l)
boolean	equals(java.lang.String name, java.lang.String s)
boolean	equalsIgnoreCase(java.lang.String s)
boolean	equalsIgnoreCase(java.lang.String name, java.lang.String s)
boolean	getBoolean()
boolean	getBoolean(java.lang.String name) Returns the value as a boolean.
java.util.ArrayList<java.lang.Boolean>	getBooleanArray()
java.util.ArrayList<java.lang.Boolean>	getBooleanArray(java.lang.String name) Returns the value as an array of boolean.
double	getDouble()
double	getDouble(java.lang.String name) Returns the value as a double.
java.util.ArrayList<java.lang.Double>	getDoubleArray()
java.util.ArrayList<java.lang.Double>	getDoubleArray(java.lang.String name) Returns the value as an array of doubles.
float	getFloat()
java.lang.Float	getFloat(java.lang.String name) Returns the value as a float.
java.lang.String	getFormat()
java.lang.String	getFormat(java.lang.String name) Returns the format string.
java.lang.String	getId() Returns the Id of this instance.
int	getInteger()
int	getInteger(java.lang.String name) Returns the value as an integer.
long	getInterval()
long	getInterval(java.lang.String name) Returns the interval in milliseconds used by isDataStale(String).
java.lang.String	getLang()
java.lang.String	getLang(java.lang.String name) Returns the language that this container will use for translations and formatting.
long	getLong()
java.lang.Long	getLong(java.lang.String name) Returns the value as a long.
java.lang.String	getName() Returns the default name.
java.lang.String[]	getNames() Returns an array of all of the names for the named values that are in this container.
java.lang.String	getRequestedUOM()
java.lang.String	getRequestedUOM(java.lang.String name) Returns the Requested Unit of Measure.
java.lang.String	getState()
java.lang.String	getState(java.lang.String name) Returns the current State as defined by Data.State.
double	getStatePercent()
double	getStatePercent(java.lang.String name) Returns the percentage of where the current value lies within the range of the State.
java.lang.String	getString()
java.lang.String	getString(java.lang.String name) Returns the value as a string.
java.lang.String	getStringFormatted(java.lang.String format)
java.lang.String	getStringFormatted(java.lang.String name, java.lang.String format) Returns the value formatted using the passed in format instead of the internal one.
java.lang.String	getStringTranslated()
java.lang.String	getStringTranslated(java.lang.String name) Returns the value as a String, translated.
long	getTimeStamp()
long	getTimeStamp(java.lang.String name) Returns the time stamp that was set by updateTimeStamp(String).
Data.Type	getType()
Data.Type	getType(java.lang.String name) Returns the Type as defined by Data.Type.
java.lang.String	getUOM()
java.lang.String	getUOM(java.lang.String name) Returns the unit of measure.
java.lang.String	getUOMAbbr()
java.lang.String	getUOMAbbr(java.lang.String name) Returns a translated abbreviation of the unit of measure.
java.lang.String	getUOMAbbrTranslated()
java.lang.String	getUOMAbbrTranslated(java.lang.String name) Returns the unit of measure abbreviation as a String, translated.
java.lang.String	getUOMDesc()
java.lang.String	getUOMDesc(java.lang.String name) Returns a translated long description of the unit of measure.
java.lang.String	getUOMDescTranslated()
java.lang.String	getUOMDescTranslated(java.lang.String name) Returns the unit of measure long description as a String, translated.
java.lang.Object	getValue()
java.lang.Object	getValue(java.lang.String name) Returns the value as an Object.
java.lang.String	getValueFormatted()
java.lang.String	getValueFormatted(java.lang.String name) Returns the value formatted using the format string and translated.
boolean	isDataStale()
boolean	isDataStale(java.lang.String name) Returns true if the value is older than the specified interval.
boolean	isDirty() Returns true if the Data has changed.
boolean	isEmpty()
boolean	isEmpty(java.lang.String name) Returns true if the value is considered empty.
void	remove(java.lang.String name) Removes a named value from the container.
void	set(Data d) Copies all the named values from another Data instance as if it was cloning it.
Data	setDirty(java.lang.Boolean dirty) Sets the dirty flag.
Data	setFormat(java.lang.String format)
Data	setFormat(java.lang.String name, java.lang.String format) Sets the format using the same syntax as String.format(Locale, String, Object...).
Data	setId(java.lang.String id) Sets the Id for this instance.
Data	setInterval(java.lang.Long value)
Data	setInterval(java.lang.String name, java.lang.Long interval) Sets the interval in milliseconds used by isDataStale(String).
Data	setLang(java.lang.String lang)
Data	setLang(java.lang.String name, java.lang.String lang) Sets the language to be used for translations and formatting of this value.
Data	setName(java.lang.String name) Sets or updates the default name.
Data	setRequestedUOM(java.lang.String UOM)
Data	setRequestedUOM(java.lang.String name, java.lang.String UOM) Sets the Requested Unit of Measure.
Data	setState(java.lang.String state)
Data	setState(java.lang.String name, java.lang.String state) Sets the State.
Data	setStatePercent(java.lang.Double statepercent)
Data	setStatePercent(java.lang.String name, java.lang.Double statepercent) Sets the State Percentage.
Data	setUOM(java.lang.String UOM)
Data	setUOM(java.lang.String name, java.lang.String UOM) Sets the unit of measure.
Data	setValue(java.lang.Object value)
Data	setValue(java.lang.Object value, java.lang.String UOM)
Data	setValue(java.lang.Object value, java.lang.String UOM, java.lang.String state)
Data	setValue(java.lang.Object value, java.lang.String UOM, java.lang.String state, java.lang.Double pct) As well as the standard setValue(String, Object), I have overloaded it to take value and UOM together as well as optionally, State and Percentage when setting for the default name.
Data	setValue(java.lang.String name, java.lang.Object value) Sets the value for the object.
java.lang.String	toString() Returns the contents of all the named values of this instance as a JSON formatted string.
java.lang.String	toString(java.lang.String name) Returns the contents of this instances' named value as a JSON formatted string.
Data	updateTimeStamp()
Data	updateTimeStamp(java.lang.String name) Updates the time stamp to the current time in milliseconds

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Data

public Data(java.lang.String name,
            java.lang.Object value,
            java.lang.String UOM,
            java.lang.String state)

Constructor(s). Each argument is optional, except name which is required.

Parameters:

name - The name of the value. Becomes the default name.

value - (Optional), the value. Default is "".

UOM - (Optional), the Unit of Measure of the value. Default is "".

state - (Optional), the initial State of the value. Default is "OFF".

Data

public Data(java.lang.String name,
            java.lang.Object value,
            java.lang.String UOM)

Data

public Data(java.lang.String name,
            java.lang.Object value)

Data

public Data(java.lang.String name)

Data

public Data(Data data)

Copy Constructor.

Parameters:

data - The Data instance to copy.

Method Detail

add

public void add(java.lang.String name,
                java.lang.Object value,
                java.lang.String UOM)

Adds a new named value to this container Each argument is optional, except name which is required.

Parameters:

name - The name of the value. Becomes the default name.

value - (Optional), the value. Default is "".

UOM - (Optional), the Unit of Measure of the value. Default is "".

add

public void add(java.lang.String name,
                java.lang.Object value)

add

public void add(java.lang.String name)

add

public void add(Data d)

Adds all the named values from another Data instance.

Parameters:

d - The Data instance to copy from.

set

public void set(Data d)

Copies all the named values from another Data instance as if it was cloning it. This differs from the copy constructor by the fact that a new object is not created.

Parameters:

d - The Data instance to copy from.

remove

public void remove(java.lang.String name)

Removes a named value from the container.

Parameters:

name - The name of the value.

addConversion

public Data addConversion(java.lang.String fromUOM,
                          java.lang.String toUOM,
                          double factor)

Add a unit of measure conversion directly to this object. Useful for non-generic conversions like, weight to volume. This can also me used to override the generic conversions as it is checked first.

Parameters:

fromUOM - The from unit of measure

toUOM - The to unit of measure

factor - The conversion factor to convert from to to.

Returns:

this

addConversion

public Data addConversion(Data data)

Add all the units from another data object. Existing conversions will be overridden.

Parameters:

data - The data object to copy conversions from

Returns:

this

isDirty

public boolean isDirty()

Returns true if the Data has changed. It is up to you to call setDirty(false), to detect changes. Initially, a Data instance is dirty.

Returns:

true if dirty

setDirty

public Data setDirty(java.lang.Boolean dirty)

Sets the dirty flag.

Parameters:

dirty - The dirty flag.

Returns:

A reference to this.

isDataStale

public boolean isDataStale(java.lang.String name)

Returns true if the value is older than the specified interval.

Parameters:

name - (Optional), the name of the value.

Returns:

true if data is old, false if not.

isDataStale

public boolean isDataStale()

isEmpty

public boolean isEmpty(java.lang.String name)

Returns true if the value is considered empty. Numerics are considered empty if the value is Not A Number or zero for integers.

Parameters:

name - (Optional), the name of the value.

Returns:

true if empty

isEmpty

public boolean isEmpty()

getId

public java.lang.String getId()

Returns the Id of this instance. This is not the default name, it is a separate attribute.

Returns:

The Id.

setId

public Data setId(java.lang.String id)

Sets the Id for this instance.

Parameters:

id - The Id.

Returns:

A reference to this.

getNames

public java.lang.String[] getNames()

Returns an array of all of the names for the named values that are in this container.

Returns:

An Array of names.

getName

public java.lang.String getName()

Returns the default name.

Returns:

The default name.

setName

public Data setName(java.lang.String name)

Sets or updates the default name.

Parameters:

name - The new name

Returns:

A reference to this.

getValue

public java.lang.Object getValue(java.lang.String name)

Returns the value as an Object.

Parameters:

name - (Optional), the name of the value.

Returns:

The value.

getValue

public java.lang.Object getValue()

setValue

public Data setValue(java.lang.String name,
                     java.lang.Object value)

Sets the value for the object. If the value is different from the current value, then the dirty flag is set to true.

Parameters:

name - (Optional), The name of the value.

value - The value

Returns:

A reference to this.

setValue

public Data setValue(java.lang.Object value)

setValue

public Data setValue(java.lang.Object value,
                     java.lang.String UOM,
                     java.lang.String state,
                     java.lang.Double pct)

As well as the standard setValue(String, Object), I have overloaded it to take value and UOM together as well as optionally, State and Percentage when setting for the default name.

Parameters:

value - The value.

UOM - The unit of measure.

state - (Optionally), The State.

pct - (Optionally), The state percentage

Returns:

A reference to this.

setValue

public Data setValue(java.lang.Object value,
                     java.lang.String UOM,
                     java.lang.String state)

setValue

public Data setValue(java.lang.Object value,
                     java.lang.String UOM)

getUOM

public java.lang.String getUOM(java.lang.String name)

Returns the unit of measure.

Parameters:

name - (Optional), the name of the value.

Returns:

The unit of measure

getUOM

public java.lang.String getUOM()

setUOM

public Data setUOM(java.lang.String name,
                   java.lang.String UOM)

Sets the unit of measure. NOTE: It does not convert the existing value to this unit of measure

Parameters:

name - The name of the value

UOM - The unit of measure

Returns:

A reference to this.

setUOM

public Data setUOM(java.lang.String UOM)

getRequestedUOM

public java.lang.String getRequestedUOM(java.lang.String name)

Returns the Requested Unit of Measure. This is a separate attribute from the UOM so that you can track what unit of measure you want, without having to store it somewhere else.

Parameters:

name - (Optional), The name of the value.

Returns:

The requested unit of measure

getRequestedUOM

public java.lang.String getRequestedUOM()

setRequestedUOM

public Data setRequestedUOM(java.lang.String name,
                            java.lang.String UOM)

Sets the Requested Unit of Measure.

Parameters:

name - (Optional), The name of the value.

UOM - The unit of measure.

Returns:

A reference to this.

setRequestedUOM

public Data setRequestedUOM(java.lang.String UOM)

getUOMAbbr

public java.lang.String getUOMAbbr(java.lang.String name)

Returns a translated abbreviation of the unit of measure.

Parameters:

name - (Optional), The name of the value.

Returns:

The unit of measure abbreviation.

getUOMAbbr

public java.lang.String getUOMAbbr()

getUOMDesc

public java.lang.String getUOMDesc(java.lang.String name)

Returns a translated long description of the unit of measure. It will reflect singular and plural version depending on the value.

Parameters:

name - (Optional), The name of the value.

Returns:

The unit of measure description.

getUOMDesc

public java.lang.String getUOMDesc()

getType

public Data.Type getType(java.lang.String name)

Returns the Type as defined by Data.Type.

Parameters:

name - (Optional), The name of the value.

Returns:

The Type.

getType

public Data.Type getType()

getFormat

public java.lang.String getFormat(java.lang.String name)

Returns the format string.

Parameters:

name - (Optional), The name of the value.

Returns:

The format string.

getFormat

public java.lang.String getFormat()

setFormat

public Data setFormat(java.lang.String name,
                      java.lang.String format)

Sets the format using the same syntax as String.format(Locale, String, Object...).

Parameters:

name - (Optionally), The name of the value.

format - The format string.

Returns:

A reference to this.

setFormat

public Data setFormat(java.lang.String format)

getState

public java.lang.String getState(java.lang.String name)

Returns the current State as defined by Data.State. Note: Other states can be added, it is just a string.

Parameters:

name - (Optional), The name of the value.

Returns:

The State

getState

public java.lang.String getState()

setState

public Data setState(java.lang.String name,
                     java.lang.String state)

Sets the State.

Parameters:

name - (Optionally), The name of the value.

state - The State

Returns:

A reference to this.

setState

public Data setState(java.lang.String state)

getStatePercent

public double getStatePercent(java.lang.String name)

Returns the percentage of where the current value lies within the range of the State.

Parameters:

name - (Optional), The name of the value.

Returns:

The percentage of the State.

getStatePercent

public double getStatePercent()

setStatePercent

public Data setStatePercent(java.lang.String name,
                            java.lang.Double statepercent)

Sets the State Percentage. Note: You have to calculate this percentage and call this function to set it. No ranges are stored within this object. Should be a value that is between 0.0 and 100.0, but doesn't have to be.

Parameters:

name - (Optionally), The name of the value.

statepercent - The State Percentage

Returns:

A reference to this.

setStatePercent

public Data setStatePercent(java.lang.Double statepercent)

getLang

public java.lang.String getLang(java.lang.String name)

Returns the language that this container will use for translations and formatting.

Parameters:

name - (Optional), The name of the value.

Returns:

The language

getLang

public java.lang.String getLang()

setLang

public Data setLang(java.lang.String name,
                    java.lang.String lang)

Sets the language to be used for translations and formatting of this value. This must be a Java supported language.

Parameters:

name - (Optional), The name of the value.

lang - The language formatted as {language}_{country}.

Returns:

A reference to this.

setLang

public Data setLang(java.lang.String lang)

getInterval

public long getInterval(java.lang.String name)

Returns the interval in milliseconds used by isDataStale(String).

Parameters:

name - (Optional), The name of the value.

Returns:

The interval in milliseconds.

getInterval

public long getInterval()

setInterval

public Data setInterval(java.lang.String name,
                        java.lang.Long interval)

Sets the interval in milliseconds used by isDataStale(String).

Parameters:

name - (Optional), The name of the value.

interval - milliseconds

Returns:

A reference to this.

setInterval

public Data setInterval(java.lang.Long value)

getTimeStamp

public long getTimeStamp(java.lang.String name)

Returns the time stamp that was set by updateTimeStamp(String).

Parameters:

name - (Optional), The name of the value.

Returns:

The time stamp in milliseconds.

getTimeStamp

public long getTimeStamp()

updateTimeStamp

public Data updateTimeStamp(java.lang.String name)

Updates the time stamp to the current time in milliseconds

Parameters:

name - (Optional), The name of the value.

Returns:

A reference to this.

updateTimeStamp

public Data updateTimeStamp()

getValueFormatted

public java.lang.String getValueFormatted(java.lang.String name)

Returns the value formatted using the format string and translated.

Parameters:

name - The name of the value.

Returns:

The formatted value.

getValueFormatted

public java.lang.String getValueFormatted()

getString

public java.lang.String getString(java.lang.String name)

Returns the value as a string. Numbers are converted to a string by calling the toString() method. Therefore, it is not formatted. Use getValueFormatted(), which always returns a string.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as a String.

getString

public java.lang.String getString()

getStringTranslated

public java.lang.String getStringTranslated(java.lang.String name)

Returns the value as a String, translated. Note: This is yet to be done.

Parameters:

name - The name of the value.

Returns:

The value as a string, translated.

getStringTranslated

public java.lang.String getStringTranslated()

getUOMAbbrTranslated

public java.lang.String getUOMAbbrTranslated(java.lang.String name)

Returns the unit of measure abbreviation as a String, translated. Note: This is yet to be done.

Parameters:

name - The name of the value.

Returns:

The value as a string, translated.

getUOMAbbrTranslated

public java.lang.String getUOMAbbrTranslated()

getUOMDescTranslated

public java.lang.String getUOMDescTranslated(java.lang.String name)

Returns the unit of measure long description as a String, translated. Note: This is yet to be done.

Parameters:

name - The name of the value.

Returns:

The value as a string, translated.

getUOMDescTranslated

public java.lang.String getUOMDescTranslated()

getStringFormatted

public java.lang.String getStringFormatted(java.lang.String name,
                                           java.lang.String format)

Returns the value formatted using the passed in format instead of the internal one. The format syntax is defined by String.format(Locale, String, Object...). If there is an error with the format syntax, that error is returned instead of the formatted value.

Parameters:

name - (Optional), The name of the value.

format - The format string. If blank, a default appropriate for the Type is used.

Returns:

The formatted string.

getStringFormatted

public java.lang.String getStringFormatted(java.lang.String format)

getBooleanArray

public java.util.ArrayList<java.lang.Boolean> getBooleanArray(java.lang.String name)

Returns the value as an array of boolean. If a String fails to parse to a boolean, false is returned. It is a copy of the array, so modifying it will not modify the original. You can modify it my doing a setValue() call with the modified array.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as a double.

getBooleanArray

public java.util.ArrayList<java.lang.Boolean> getBooleanArray()

getDoubleArray

public java.util.ArrayList<java.lang.Double> getDoubleArray(java.lang.String name)

Returns the value as an array of doubles. If a String fails to parse to a double, Double.NaN is returned. It is a copy of the array, so modifying it will not modify the original. You can modify it my doing a setValue() call with the modified array.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as a double.

getDoubleArray

public java.util.ArrayList<java.lang.Double> getDoubleArray()

getBoolean

public boolean getBoolean(java.lang.String name)

Returns the value as a boolean. For Strings, this means it cannot be blank, but if must be one of (Y,YES,T,TRUE). All other values will return false. For numeric values, any non-zero value returns true.

Parameters:

name - (Optional), The name of the value.

Returns:

true or false

getBoolean

public boolean getBoolean()

getDouble

public double getDouble(java.lang.String name)

Returns the value as a double. If a String fails to parse to a double, Double.NaN is returned.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as a double.

getDouble

public double getDouble()

getFloat

public java.lang.Float getFloat(java.lang.String name)

Returns the value as a float. If a String fails to parse to a float, Float.NaN is returned.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as a float.

getFloat

public float getFloat()

getInteger

public int getInteger(java.lang.String name)

Returns the value as an integer. If a String fails to parse to an integer, zero(0) is returned. If the value was a decimal, it is not rounded, it is floored.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as an integer.

getInteger

public int getInteger()

getLong

public java.lang.Long getLong(java.lang.String name)

Returns the value as a long. If a String fails to parse to a long, zero(0L) is returned. If the value was a decimal, it is not rounded, it is floored.

Parameters:

name - (Optional), The name of the value.

Returns:

The value as an integer.

getLong

public long getLong()

convertUOM

public Data convertUOM(java.lang.String name,
                       java.lang.String UOM)

convertUOM

public Data convertUOM(java.lang.String UOM)

compare

public int compare(Data data,
                   java.lang.String name)

Compares this instance to another Data instance. If this instance contains multiple named values, then each one is compared in a non-predictable order. Only the values are compared based on the Type. If Type is UNKNOWN, then only equals() is used to return 0 if equal, 1 if not. An attempt is made to convert them to the same unit of measure to do the comparison.

Parameters:

data - The Data instance to compare to.

name - (Optional) The specific named value to compare.

Returns:

-1 if this instance is less than, +1 if this instance is greater than, and 0 if they are equal.

compare

public int compare(Data data)

equals

public boolean equals(Data pData)

equals

public boolean equals(java.lang.String name,
                      double d)

equals

public boolean equals(double d)

equals

public boolean equals(java.lang.String name,
                      boolean b)

equals

public boolean equals(boolean b)

equals

public boolean equals(java.lang.String name,
                      float f)

equals

public boolean equals(float f)

equals

public boolean equals(java.lang.String name,
                      int i)

equals

public boolean equals(int i)

equals

public boolean equals(java.lang.String name,
                      long l)

equals

public boolean equals(long l)

equals

public boolean equals(java.lang.String name,
                      java.lang.String s)

equals

public boolean equals(java.lang.String s)

equalsIgnoreCase

public boolean equalsIgnoreCase(java.lang.String name,
                                java.lang.String s)

equalsIgnoreCase

public boolean equalsIgnoreCase(java.lang.String s)

toString

public java.lang.String toString(java.lang.String name)

Returns the contents of this instances' named value as a JSON formatted string. The format will be as follows:

 {
     "Name": "{Name}",
     "Type": "{Type}",
     "Value": "{Value}",
     "Format": "{Format}",
     "UOM": "{UOM}",
     "UOMAbbr": "{UOMAbbr}",
     "UOMDescr": "{UOMDescr}",
     "Lang": "{Lang}",
     "State": "{State}",
     "StatePercent": "{StatePercent}",
     "ValueFormatted": "{ValueFormatted}"
 }
 

Parameters:

name - The name of the value.

Returns:

A JSON formatted String.

toString

public java.lang.String toString()

Returns the contents of all the named values of this instance as a JSON formatted string. Each name will be used as the key to the attributes for that name. The format will be as follows:

 {
     "__Id": "{m_id}",
     "__DefaultName": "{m_defaultname}",
     "{Name1}": {
         "Name": "{Name1.Name}",
         "Type": "{Name1.Type}",
         "Value": "{Name1.Value}",
         "Format": "{Name1.Format}",
         "UOM": "{Name1.UOM}",
         "UOMAbbr": "{Name1.UOMAbbr}",
         "UOMDescr": "{Name1.UOMDescr}",
         "Lang": "{Name1.Lang}",
         "State": "{Name1.State}",
         "StatePercent": "{Name1.StatePercent}",
         "ValueFormatted": "{Name1.ValueFormatted}"
     }
     , "{NameX}": {
          "Name": "{NameX.Name}",
          ...
     }
 }
 

Overrides:

toString in class java.lang.Object

Returns:

A JSON formatted String.