INumber (PhysPics Tools API)

java.lang.Object
- com.physpics.tools.ui.INumber

```
public class INumber
extends java.lang.Object
```
Sequential value objects. Conceptually, an INumber is just one in a sequence of values. It has methods to compute the successor INumber and to format itself for a String. See getFormat(). Usages: parse number string after $@ parse page number in note number of form $@111n222 parse chapter number to capture prefix: @chapter: name111.txt (the suffix .txt must be removed first) number strings may have a prefix; for "111n222" it is "111n"

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.regex.Pattern`	`DECIMAL_PAT` Pattern for findNumb() that finds decimal numbers.
`static int`	`DECIMAL_PAT_WHICH` Which-paren-is-value for decimal pat
`static java.util.regex.Pattern`	`LEFT_PAT` Pattern for findNumb() that finds decimal numbers on the left-end of a string -- "\\A\\s*([0-9]+)"
`static int`	`LEFT_PAT_WHICH` Which-paren-is-value for leftPat
`static int`	`NUMB_ARABIC`
`static int`	`NUMB_DIGITS`
`static int`	`NUMB_LETTER`
`static int`	`NUMB_MARKER`
`static int`	`NUMB_NOTE`
`static int`	`NUMB_NOTE_NUM`
`static int`	`NUMB_NOTE_PAGE`
`static int`	`NUMB_NUMBER`
`static java.util.regex.Pattern`	`NUMB_PAT` A pattern to parse an INumber value.
`static int`	`NUMB_PRE`
`static int`	`NUMB_ROMAN`
`static java.util.regex.Pattern`	`RIGHT_PAT` Pattern for findNumb() that finds decimal numbers on the right-end of a string -- "(.[^0-9])?([0-9]+)\\s\\z"
`static int`	`RIGHT_PAT_WHICH` Which-paren-is-value for rightPat
`static java.util.regex.Pattern`	`ROMAN_PAT` Pattern for findNumb() that finds roman numbers.
`static int`	`ROMAN_PAT_WHICH` Which-paren-is-value for romanPat

Constructor Summary

Constructors
Constructor and Description
`INumber()` Returns an INumber for 0, with no prefix.
`INumber(INumber src)` Construct an INumber duplicating the argument.
`INumber(java.lang.String pref)` Returns an INumber for 0, with the given prefix.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`arabicToInt(java.lang.String arabic, INumber nVal)` Convert a value in arabic digits to an int.
`static INumber`	`checkSign(INumber v)` If prefix is solely a minus sign, change sign of value
`INumber`	`decr()` Decrement the retained value by 1.
`static INumber`	`findNumb(java.lang.String text, java.util.regex.Pattern pat, int which)` Find a number within a string according to a supplied pattern.
`static INumber`	`findNumb(java.lang.String text, java.lang.String pat, int which)` Like findNumb, but pattern is a String.
`char`	`getFormat()` The following numeric formats are supported: 1 - 1, 2, 3, ...
`java.lang.String`	`getFormatName()` The following numeric formats are supported: 1 - 1, 2, 3, ...
`java.lang.String`	`getPrefix()`
`int`	`getVal()`
`java.lang.String`	`getValText()`
`INumber`	`incr()` Increment the retained value by 1.
`static INumber`	`parseNumb(java.lang.String text)` Parse a string to generate an INumber value.
`static INumber`	`parseNumb(java.lang.String text, boolean singleIsRoman)` Parse a String to generate an INumber value.
`static int`	`romanToInt(java.lang.String r)`
`void`	`setPrefix(java.lang.String prefix)`
`static java.lang.String`	`toArabic(int val, char one)` Convert an integer value to a string of arabic digits.
`static java.lang.String`	`toRoman(int i)`
`java.lang.String`	`toString()` Convert value to a number string.
`java.lang.String`	`value()` Convert value to a number string, without prefix.

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

- Field Detail
  - NUMB_PAT
```
public static final java.util.regex.Pattern NUMB_PAT
```
    A pattern to parse an INumber value. The prefix is everything before the first digit of the last digit sequence. A digit sequence is digits, roman numerals, or a single letter. The numeric value is that of that last digit sequence. White space may follow the digit sequence; it is ignored. The prefix must not end with a letter or decimal digit. string =~= prefix value prefix-111 =~= "prefix-" 111 prefix/cdvi =~= "prefix/" 406 prefix.a =~= "prefix." , a is single letter Unfortunately, single letter Roman numerals are ambiguous. This is resolved with the defaultAlphaNumberFormat option. Number values for "notes" are digits, an 'n', and more digits: The first set of digits and the 'n' are made part of the prefix. prefix_123n456 =~= "prefix_123n" 456
  - NUMB_MARKER
```
public static final int NUMB_MARKER
```
    See Also:
    
    Constant Field Values
  - NUMB_PRE
```
public static final int NUMB_PRE
```
    See Also:
    
    Constant Field Values
  - NUMB_NUMBER
```
public static final int NUMB_NUMBER
```
    See Also:
    
    Constant Field Values
  - NUMB_DIGITS
```
public static final int NUMB_DIGITS
```
    See Also:
    
    Constant Field Values
  - NUMB_ARABIC
```
public static final int NUMB_ARABIC
```
    See Also:
    
    Constant Field Values
  - NUMB_ROMAN
```
public static final int NUMB_ROMAN
```
    See Also:
    
    Constant Field Values
  - NUMB_LETTER
```
public static final int NUMB_LETTER
```
    See Also:
    
    Constant Field Values
  - NUMB_NOTE
```
public static final int NUMB_NOTE
```
    See Also:
    
    Constant Field Values
  - NUMB_NOTE_PAGE
```
public static final int NUMB_NOTE_PAGE
```
    See Also:
    
    Constant Field Values
  - NUMB_NOTE_NUM
```
public static final int NUMB_NOTE_NUM
```
    See Also:
    
    Constant Field Values
  - DECIMAL_PAT
```
public static final java.util.regex.Pattern DECIMAL_PAT
```
    Pattern for findNumb() that finds decimal numbers. -- "\\s*([0-9]+)"
  - DECIMAL_PAT_WHICH
```
public static final int DECIMAL_PAT_WHICH
```
    Which-paren-is-value for decimal pat
    
    See Also:
    
    Constant Field Values
  - LEFT_PAT
```
public static final java.util.regex.Pattern LEFT_PAT
```
    Pattern for findNumb() that finds decimal numbers on the left-end of a string -- "\\A\\s*([0-9]+)"
  - LEFT_PAT_WHICH
```
public static final int LEFT_PAT_WHICH
```
    Which-paren-is-value for leftPat
    
    See Also:
    
    Constant Field Values
  - RIGHT_PAT
```
public static final java.util.regex.Pattern RIGHT_PAT
```
    Pattern for findNumb() that finds decimal numbers on the right-end of a string -- "(.*[^0-9])?([0-9]+)\\s\*\z"
  - RIGHT_PAT_WHICH
```
public static final int RIGHT_PAT_WHICH
```
    Which-paren-is-value for rightPat
    
    See Also:
    
    Constant Field Values
  - ROMAN_PAT
```
public static final java.util.regex.Pattern ROMAN_PAT
```
    Pattern for findNumb() that finds roman numbers. -- "\\s*([mMdDcClLxXvViI]+)"
  - ROMAN_PAT_WHICH
```
public static final int ROMAN_PAT_WHICH
```
    Which-paren-is-value for romanPat
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - INumber
```
public INumber()
```
    Returns an INumber for 0, with no prefix.
  - INumber
```
public INumber(java.lang.String pref)
```
    Returns an INumber for 0, with the given prefix.
    
    Parameters:
    
    pref - The prefix
  - INumber
```
public INumber(INumber src)
```
    Construct an INumber duplicating the argument. Useful for getting an incremented value without disturbing the original: new INumber(original).incr()
    
    Parameters:
    
    src - The INumber to copy
- Method Detail
  - getPrefix
```
public java.lang.String getPrefix()
```
    Returns:
    
    the prefix
  - setPrefix
```
public void setPrefix(java.lang.String prefix)
```
    Parameters:
    
    prefix - the prefix to set
  - getVal
```
public int getVal()
```
    Returns:
    
    the val
  - getValText
```
public java.lang.String getValText()
```
    Returns:
    
    the valText
  - getFormat
```
public char getFormat()
```
    The following numeric formats are supported: 1 - 1, 2, 3, ... i - i, ii, iii, ... I - I, II, III, ... a - a, b, c, ... A - A, B, C, ... ٠ - Ù© ,Ù¨ ,Ù§ ,Ù¦ ,Ù¥ ,Ù¤ ,Ù£ ,Ù¢ ,Ù¡ ,Ù - // Eastern arabic numerals; (beware commas are left-right and arabic digits are right-to-left) when in integers, arabic digits have the high-order digit at the LEFT (same order as western digits) ۰ - similar to the above; India, Pakistan, Iran differ in symbols for 4, 5, 6: Û´, Ûµ, Û¶
    
    Returns:
    
    the format
  - getFormatName
```
public java.lang.String getFormatName()
```
    The following numeric formats are supported: 1 - 1, 2, 3, ... i - i, ii, iii, ... I - I, II , III, ... a - a, b, c, ... A - A, B, C, ... ٠ - Ù© ,Ù¨ ,Ù§ ,Ù¦ ,Ù¥ ,Ù¤ ,Ù£ ,Ù¢ ,Ù¡ ,Ù - // arabic numerals; (beware commas are left-right and arabic digits are right-to-left) when in integers, arabic digits have the high-order digit at the LEFT (same order as western digits)Ù¢â Ù£ ۰ - similar to the above; India, Pakistan, Iran differ in symbols for 4, 5, 6: Û´, Ûµ, Û¶
    
    Returns:
    
    the format
  - findNumb
```
public static INumber findNumb(java.lang.String text,
                               java.lang.String pat,
                               int which)
```
    Like findNumb, but pattern is a String. If called many times, the Pattern version should be used to avoid repeated recompilation of the pattern.
    
    Parameters:
    
    text - Text to be parsed
    
    pat - Pattern to match
    
    which - Index of the paren in the pattern which brackets the number to parse
    
    Returns:
    
    An appropriate INumber; see findNumb(String, Pattern, int)
  - findNumb
```
public static INumber findNumb(java.lang.String text,
                               java.util.regex.Pattern pat,
                               int which)
```
    Find a number within a string according to a supplied pattern. Typical patterns and their 'which' values: for a decimal integer at the left of a line: "\\A\\s*([0-9]+)", 1 for a decimal integer at the right end of a line: "(.*[^0-9])?([0-9]+)\\s\*\Z", 2 for a roman numeral "\\s*([mMdDcClLxXvViI]+)", 1 for a simple decimal value "\\s*([0-9]+)", 1
    
    Parameters:
    
    text - The String to be searched. It is searched from left to right, so the leftmost instance of the pattern is reported.
    
    pat - A Pattern object describing the number. The numeric portion must be surrounded with parentheses.
    
    which - Index of the left paren in pat which corresponds to the number. Left parens are numbered from left to right, starting with ONE.
    
    Returns:
    
    An INumber for the number. The valText field is the contents of the which'th parentheses. The prefix field is everything before that which'th paren. The val field is derived by parsing the valText with INumber.parseNumb. If that parse fails, the value is zero and the format is 'u'. Otherwise the format is as deduced by parseNumb. If ambiguous, single letter values are treated as roman numerals.
  - parseNumb
```
public static INumber parseNumb(java.lang.String text)
```
    Parse a string to generate an INumber value. Same as the two argument form, and assumes that single letter numbers are roman.
    
    Parameters:
    
    text - The string to parse.
    
    Returns:
    
    an INumber representing the string or null if there is no numeric portion
  - parseNumb
```
public static INumber parseNumb(java.lang.String text,
                                boolean singleIsRoman)
```
    Parse a String to generate an INumber value. See NUMB_PAT pattern.
    
    Parameters:
    
    text - The string to parse.
    
    singleIsRoman - true if a single mdclxvi is to be considered a roman numeral; otherwise it is a letter.
    
    Returns:
    
    an INumber representing the string. If there is no number, the value is null.
  - checkSign
```
public static INumber checkSign(INumber v)
```
    If prefix is solely a minus sign, change sign of value
    
    Parameters:
    
    v - The INumber value
    
    Returns:
    
    The input value with negative transferred from string to value.
  - incr
```
public INumber incr()
```
    Increment the retained value by 1.
    
    Returns:
    
    This INumber itself. For use in incr().toString();
  - decr
```
public INumber decr()
```
    Decrement the retained value by 1.
    
    Returns:
    
    This INumber itself. For use in, e.g., decr().toString();
  - value
```
public java.lang.String value()
```
    Convert value to a number string, without prefix. May produce bogus values if using single letters
    
    Returns:
    
    The converted string.
  - toString
```
public java.lang.String toString()
```
    Convert value to a number string. May produce bogus values if using single letters
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The converted string.
  - arabicToInt
```
public static void arabicToInt(java.lang.String arabic,
                               INumber nVal)
```
    Convert a value in arabic digits to an int.
    
    Parameters:
    
    arabic - The string of arabic digits. Leftmost is high-order digit.
    
    nVal - A destination to store the integer.
  - toArabic
```
public static java.lang.String toArabic(int val,
                                        char one)
```
    Convert an integer value to a string of arabic digits. The choice between the Arabic sequence and the similar Indian sequence is made by the second argument, which must be the character for integer 1. More generally, any ten consecutive Unicode characters can be used as digits by passing the character to stand as digit 1.
    
    Parameters:
    
    val - The integer to encode.
    
    one - The character to encode digit one (1). For Arabic digits this should be ١; for Indian digits it should be ۱
    
    Returns:
    
    the resulting string of arabic digits
  - toRoman
```
public static java.lang.String toRoman(int i)
```
  - romanToInt
```
public static int romanToInt(java.lang.String r)
```

Class INumber

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NUMB_PAT

NUMB_MARKER

NUMB_PRE

NUMB_NUMBER

NUMB_DIGITS

NUMB_ARABIC

NUMB_ROMAN

NUMB_LETTER

NUMB_NOTE

NUMB_NOTE_PAGE

NUMB_NOTE_NUM

DECIMAL_PAT

DECIMAL_PAT_WHICH

LEFT_PAT

LEFT_PAT_WHICH

RIGHT_PAT

RIGHT_PAT_WHICH

ROMAN_PAT

ROMAN_PAT_WHICH

Constructor Detail

INumber

INumber

INumber

Method Detail

getPrefix

setPrefix

getVal

getValText

getFormat

getFormatName

findNumb

findNumb

parseNumb

parseNumb

checkSign

incr

decr

value

toString

arabicToInt

toArabic

toRoman

romanToInt