Index

A B C D E F H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

annotations() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns the value of the annotations record component.
arbitrary() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the arbitrary record component.
arbitrary() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns the value of the arbitrary record component.
asWritten() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns the value of the asWritten record component.
atom() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
The atom a term that is an atom means.
atom() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Returns the value of the atom record component.
atomCodes() - Method in class network.ike.foundation.ike.ucum.UcumEssence
 
atomCodes() - Method in interface network.ike.foundation.ike.ucum.UcumSymbols
The codes of every atom, base units and defined units alike, case-sensitive.
atomCodes() - Method in class network.ike.foundation.ike.ucum.UcumUnits
 

B

base(String) - Static method in record class network.ike.foundation.ike.ucum.UcumReduction
The reduction of a base unit: exponent one on its dimension, magnitude one.
baseUnit(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
A base unit by its case-sensitive code.
BaseUnit(String, String, String, String, String, String) - Constructor for record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Creates an instance of a BaseUnit record class.
baseUnits() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The base units, in the file's order.
baseUnits() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the baseUnits record component.

C

canonicalCode() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
The canonical code: the number when not one, then the canonical factors, joined by periods; 1 for unity.
caseInsensitiveCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the caseInsensitiveCode record component.
caseInsensitiveCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns the value of the caseInsensitiveCode record component.
caseInsensitiveCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the caseInsensitiveCode record component.
code() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the code record component.
code() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns the value of the code record component.
code() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the code record component.
code() - Method in exception class network.ike.foundation.ike.ucum.UcumSyntaxException
The code as written.
code() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
The factor's code: prefix, atom, and the exponent when not one.
commensurable(UcumReduction) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Whether two reductions have the same dimension.
composedUnit(String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The concept for a composed unit.
composedUnits() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the composedUnits record component.
counts() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the counts record component.

D

definitionNumber() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
The number in the definition: the value as written, or a special unit's function value.
definitionUnit() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the definitionUnit record component.
definitionValue() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the definitionValue record component.
description(PublicId, String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
A description or dialect semantic hung on a concept, by its role.
dimension() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the dimension record component.
dimension() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
The dimension as text: each base dimension's letter with its exponent when not one, joined by periods, in the fixed order; 1 when there is no dimension.
DIMENSIONS - Static variable in record class network.ike.foundation.ike.ucum.UcumReduction
The base dimensions' letters, in the order the UCUM file lists its base units.

E

equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Indicates whether some other object is "equal to" this one.
exponent() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Returns the value of the exponent record component.
exponents() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns the value of the exponents record component.

F

factor() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
The factor as a number.
Factor(String, String, int) - Constructor for record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Creates an instance of a Factor record class.
factors() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns the value of the factors record component.
flagged(boolean, boolean) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
This reduction with flags added.
function() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the function record component.
Function(String, String, String) - Constructor for record class network.ike.foundation.ike.ucum.UcumEssence.Function
Creates an instance of a Function record class.

H

hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Returns a hash code value for this object.
hashCode() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns a hash code value for this object.

I

identity(UcumTerm) - Method in class network.ike.foundation.ike.ucum.UcumUnits
The concept a term means: the atom's own concept for a single atom, else the composed unit's, whether or not it has been written yet.
importEssence(UcumEssence, Stamp) - Method in class network.ike.foundation.ike.ucum.UcumImporter
Imports the file under a stamp.
isAtom() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Whether the term means one atom alone: no number, no prefix, no power.
isEmpty() - Method in class network.ike.foundation.ike.ucum.UcumUnits
Whether the store holds no UCUM units.

L

load(StampCalculator) - Static method in class network.ike.foundation.ike.ucum.UcumUnits
Reads the atoms and prefixes from the store on a view.

M

magnitude() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns the value of the magnitude record component.
metric() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the metric record component.
metric(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
 
metric(String) - Method in interface network.ike.foundation.ike.ucum.UcumSymbols
Whether an atom is metric, and so takes a prefix.
metric(String) - Method in class network.ike.foundation.ike.ucum.UcumUnits
 

N

name() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the name record component.
name() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Returns the value of the name record component.
name() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns the value of the name record component.
names() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the names record component.
NAMESPACE - Static variable in class network.ike.foundation.ike.ucum.UcumIdentity
The namespace every UCUM identity is derived under.
network.ike.foundation.ike.ucum - module network.ike.foundation.ike.ucum
The Unified Code for Units of Measure as knowledge: the unmodified UCUM file, its importer, the grammar that composes units on demand, and the reduction to base dimensions.
network.ike.foundation.ike.ucum - package network.ike.foundation.ike.ucum
 
number() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns the value of the number record component.

O

of(String, BigDecimal, boolean, boolean) - Static method in record class network.ike.foundation.ike.ucum.UcumReduction
A reduction read back from its recorded form.
ONE - Static variable in record class network.ike.foundation.ike.ucum.UcumReduction
The reduction of unity: no dimension, magnitude one.

P

parse(String) - Method in class network.ike.foundation.ike.ucum.UcumUnits
Reads a unit code against the store's atoms and prefixes.
parse(String, UcumSymbols) - Static method in class network.ike.foundation.ike.ucum.UcumGrammar
Reads a unit code.
position() - Method in exception class network.ike.foundation.ike.ucum.UcumSyntaxException
Where reading stopped, counted from zero.
power(int) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
This reduction raised to a power: exponents multiplied, the magnitude raised.
PRECISION - Static variable in record class network.ike.foundation.ike.ucum.UcumReduction
The precision every magnitude is kept to: forty significant digits, rounded half even.
prefix() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Returns the value of the prefix record component.
prefix(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
A prefix by its case-sensitive code.
prefix(String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The concept for a prefix.
Prefix(String, String, String, String, String) - Constructor for record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Creates an instance of a Prefix record class.
prefixCodes() - Method in class network.ike.foundation.ike.ucum.UcumEssence
 
prefixCodes() - Method in interface network.ike.foundation.ike.ucum.UcumSymbols
The codes of every prefix, case-sensitive.
prefixCodes() - Method in class network.ike.foundation.ike.ucum.UcumUnits
 
prefixes() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The prefixes, in the file's order.
prefixes() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the prefixes record component.
prefixFactor(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
 
prefixFactor(String) - Method in interface network.ike.foundation.ike.ucum.UcumSymbols
What a prefix multiplies by.
prefixFactor(String) - Method in class network.ike.foundation.ike.ucum.UcumUnits
 
printSymbol() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the printSymbol record component.
printSymbol() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns the value of the printSymbol record component.
printSymbol() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the printSymbol record component.
properties() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The properties the units measure, each once, in order of first appearance.
properties() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the properties record component.
property() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns the value of the property record component.
property() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the property record component.
property(String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The concept for a property, the parent of the units that measure it.

R

ratioTo(UcumReduction) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
How many of the other unit make one of this one: the ratio of the magnitudes when the two are commensurable and neither is special or arbitrary; empty otherwise.
read() - Static method in class network.ike.foundation.ike.ucum.UcumEssence
Reads the bundled file.
read(InputStream) - Static method in class network.ike.foundation.ike.ucum.UcumEssence
Reads a UCUM file.
record(PublicId) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The record semantic hung on a concept: the unit, prefix, or composed-unit pattern's.
reduce(UcumSymbols) - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Reduces the term to the base units: the number times each factor's atom, scaled by its prefix, raised to its exponent.
reduction(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
Reduces an atom by following its definition down to the base units.
reduction(String) - Method in interface network.ike.foundation.ike.ucum.UcumSymbols
What an atom reduces to in the base units.
reduction(String) - Method in class network.ike.foundation.ike.ucum.UcumUnits
 
relation(String, String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The relation semantic that says a UCUM unit is one of IKE's own concepts.
relations() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the relations record component.
Report(int, int, int, int, int, int, StoreWriter.Counts) - Constructor for record class network.ike.foundation.ike.ucum.UcumImporter.Report
Creates an instance of a Report record class.
RESOURCE - Static variable in class network.ike.foundation.ike.ucum.UcumEssence
Where the file is bundled.
revisionDate() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The file's revision date.

S

scale(BigDecimal) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
This reduction with its magnitude multiplied by a factor.
special() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the special record component.
special() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns the value of the special record component.

T

times(UcumReduction) - Method in record class network.ike.foundation.ike.ucum.UcumReduction
The product of two reductions: exponents added, magnitudes multiplied, flags joined.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.BaseUnit
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumReduction
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumTerm.Factor
Returns a string representation of this record class.
toString() - Method in record class network.ike.foundation.ike.ucum.UcumTerm
Returns a string representation of this record class.

U

UcumEssence - Class in network.ike.foundation.ike.ucum
The unmodified UCUM file, read as it is: its prefixes, its base units, and its defined units, every code, name, symbol, property, class, and definition as the file writes them.
UcumEssence.BaseUnit - Record Class in network.ike.foundation.ike.ucum
One base unit as the file writes it.
UcumEssence.Function - Record Class in network.ike.foundation.ike.ucum
The function a special unit is defined by.
UcumEssence.Prefix - Record Class in network.ike.foundation.ike.ucum
One prefix as the file writes it.
UcumEssence.Unit - Record Class in network.ike.foundation.ike.ucum
One defined unit as the file writes it.
UcumGrammar - Class in network.ike.foundation.ike.ucum
UCUM's grammar for unit codes, as the specification gives it: a term is components joined by a period for a product or a solidus for a quotient, and may open with a solidus; a component is a unit with an optional exponent, a number, a parenthesized term, or an annotation in braces; a unit is an atom, or a prefix on a metric atom.
UcumIdentity - Class in network.ike.foundation.ike.ucum
Where every UCUM component gets its identity (IKE-Network/ike-issues#1114): derived, never random, from what the component is.
UcumImporter - Class in network.ike.foundation.ike.ucum
Reads the unmodified UCUM file into the store as knowledge (IKE-Network/ike-issues#1114): a concept for each property, each base unit and defined unit under its property, and each prefix, every code, name, symbol, class, and definition kept verbatim in the concept's record, IKE's reduction to the base units beside them marked as IKE's, and the four relations that say UCUM's second, minute, hour, and millisecond are IKE's own units of that name.
UcumImporter(StampCalculator) - Constructor for class network.ike.foundation.ike.ucum.UcumImporter
Creates an importer over a view.
UcumImporter.Report - Record Class in network.ike.foundation.ike.ucum
What an import did.
UcumReduction - Record Class in network.ike.foundation.ike.ucum
A unit reduced to UCUM's seven base units: an exponent on each base dimension and a magnitude in the base units, computed by IKE from UCUM's definitions (IKE-Network/ike-issues#1114).
UcumReduction(List, BigDecimal, boolean, boolean) - Constructor for record class network.ike.foundation.ike.ucum.UcumReduction
Checks the shape and normalizes the magnitude.
UcumSymbols - Interface in network.ike.foundation.ike.ucum
What the grammar and the reduction need to know about UCUM's atoms and prefixes: which codes exist, which atoms take a prefix, what each atom reduces to, and what each prefix multiplies by.
UcumSyntaxException - Exception Class in network.ike.foundation.ike.ucum
A unit code the grammar cannot read, refused with its place: the code, the position of the first character that could not be read, counted from zero, and what was expected there.
UcumSyntaxException(String, int, String) - Constructor for exception class network.ike.foundation.ike.ucum.UcumSyntaxException
Creates the refusal.
UcumTerm - Record Class in network.ike.foundation.ike.ucum
A unit code read by UCUM's grammar: a number, the factors it multiplies, each a prefix if any, an atom, and an exponent, and the annotations in braces, which mean nothing to the algebra and are kept outside it (IKE-Network/ike-issues#1114).
UcumTerm(String, BigDecimal, List, List) - Constructor for record class network.ike.foundation.ike.ucum.UcumTerm
Keeps the lists immutable.
UcumTerm.Factor - Record Class in network.ike.foundation.ike.ucum
One factor of a unit: a prefix, empty when none, an atom, and an exponent.
UcumUnits - Class in network.ike.foundation.ike.ucum
The UCUM units as the store holds them after import: the atoms and prefixes read back from their records, so that a unit code met later, in a library's quantity, is read by the grammar against the knowledge in the graph, and a composed unit is made on demand, once, identified by its canonical code.
unit() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Returns the value of the unit record component.
unit(String) - Method in class network.ike.foundation.ike.ucum.UcumEssence
A defined unit by its case-sensitive code.
unit(String) - Static method in class network.ike.foundation.ike.ucum.UcumIdentity
The concept for a base unit or a defined unit.
Unit(String, String, boolean, boolean, boolean, String, List, String, String, String, String, Optional) - Constructor for record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Keeps the names immutable.
unitClass() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Unit
Returns the value of the unitClass record component.
units() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The defined units, in the file's order.
units() - Method in record class network.ike.foundation.ike.ucum.UcumImporter.Report
Returns the value of the units record component.

V

value() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Function
Returns the value of the value record component.
value() - Method in record class network.ike.foundation.ike.ucum.UcumEssence.Prefix
Returns the value of the value record component.
version() - Method in class network.ike.foundation.ike.ucum.UcumEssence
The file's version.

W

write(UcumTerm, StoreWriter) - Method in class network.ike.foundation.ike.ucum.UcumUnits
The concept a term means, written if it is a composed unit not yet in the store.
A B C D E F H I L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form