ucar.units

Interface PrefixDB

All Known Implementing Classes:

PrefixDBImpl, StandardPrefixDB

public interface PrefixDB

Interface for a database of unit prefixes.

Version:

$Id: PrefixDB.java 64 2006-07-12 22:30:50Z edavis $

Author:

Steven R. Emmerson

Method Summary

Methods

Modifier and Type	Method and Description
void	addName(java.lang.String name, double value) Adds a prefix to the database by name.
void	addSymbol(java.lang.String symbol, double value) Adds a prefix to the database by symbol.
Prefix	getPrefixByName(java.lang.String name) Gets a prefix from the database by name.
Prefix	getPrefixBySymbol(java.lang.String symbol) Gets a prefix from the database by symbol.
Prefix	getPrefixByValue(double value) Gets a prefix from the database by value.
java.util.Iterator<?>	iterator() Gets an iterator over the entries in the database.
java.lang.String	toString() Gets a string representation of this database.

Method Detail

addName

void addName(java.lang.String name,
           double value)
             throws PrefixExistsException,
                    PrefixDBAccessException

Adds a prefix to the database by name.

Parameters:

name - The name of the prefix.

value - The value of the prefix.

Throws:

PrefixExistsException - A prefix with the same name already exists in the database.

PrefixDBAccessException - Prefix database access failure.

addSymbol

void addSymbol(java.lang.String symbol,
             double value)
               throws PrefixExistsException,
                      PrefixDBAccessException

Adds a prefix to the database by symbol.

Parameters:

symbol - The symbol for the prefix.

value - The value of the prefix.

Throws:

PrefixExistsException - A prefix with the same symbol already exists in the database.

PrefixDBAccessException - Prefix database access failure.

getPrefixByName

Prefix getPrefixByName(java.lang.String name)
                       throws PrefixDBAccessException

Gets a prefix from the database by name.

Parameters:

name - The name of the prefix.

Returns:

prefix The prefix or null.

Throws:

PrefixDBAccessException - Prefix database access failure.

getPrefixBySymbol

Prefix getPrefixBySymbol(java.lang.String symbol)
                         throws PrefixDBAccessException

Gets a prefix from the database by symbol.

Parameters:

symbol - The symbol for the prefix.

Returns:

prefix The prefix or null.

Throws:

PrefixDBAccessException - Prefix database access failure.

getPrefixByValue

Prefix getPrefixByValue(double value)
                        throws PrefixDBAccessException

Gets a prefix from the database by value.

Parameters:

value - The value for the prefix.

Returns:

prefix The prefix or null.

Throws:

PrefixDBAccessException - Prefix database access failure.

toString

java.lang.String toString()

Gets a string representation of this database.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this database.

iterator

java.util.Iterator<?> iterator()

Gets an iterator over the entries in the database.

Returns:

An iterator over the database.