fr.cnes.genius.unit

Class GUnitList

java.lang.Object

fr.cnes.genius.unit.GUnitList

public class GUnitList
extends Object

Class used to define the list of units to apply to an item. It internally verifies the dimensional compatibility between the given units.

Author:

ffsm

Constructor Summary

Constructors

Constructor and Description
GUnitList(GUnit[] unitArray) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	containsByName(String unitName) Checks if a given unit is contained in the units list, given its name.
GUnit	get(int rank) Get the unit at requested position.
GUnit[]	getArray() Get the list of units as an array.
GUnit	getByName(String unitName) Returns the unit, given its name, if it is contained in the units list.
GUnit	getFirst() Returns the first unit in the list or null if the list is empty.
ArrayList<GMenuItem>	getMenuItems(String widgetIDprefix) Generates the list of items to be used in a units pop-up menu.
int	indexOfByName(String unitName) Finds the index of a unit in the units list, given its name.
boolean	isEmpty() Check if the unit list is empty.
int	size() Get the size of the units list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GUnitList

public GUnitList(GUnit[] unitArray)

Default constructor. Creates a new list of units from an array of units.

Parameters:

unitArray - Array of units.

Method Detail

getMenuItems

public ArrayList<GMenuItem> getMenuItems(String widgetIDprefix)

Generates the list of items to be used in a units pop-up menu.

Parameters:

widgetIDprefix - of the widgetId of each element for the menu.

Returns:

the list of menu items to be used in the units pop-up menu.

indexOfByName

public int indexOfByName(String unitName)

Finds the index of a unit in the units list, given its name.

Parameters:

unitName - name of the unit.

Returns:

index of the unit or -1 if not found.

containsByName

public boolean containsByName(String unitName)

Checks if a given unit is contained in the units list, given its name.

Parameters:

unitName - name of the unit.

Returns:

true if the it is contained, false if not.

getByName

public GUnit getByName(String unitName)

Returns the unit, given its name, if it is contained in the units list.

Parameters:

unitName - name of the unit.

Returns:

the unit, given its name, if it is contained in the units list, null if it is not contained.

getFirst

public GUnit getFirst()

Returns the first unit in the list or null if the list is empty.

Returns:

the first unit in the list of null if the list is empty.

isEmpty

public boolean isEmpty()

Check if the unit list is empty.

Returns:

true if the list is empty, false otherwise.

get

public GUnit get(int rank)

Get the unit at requested position.

Parameters:

rank - of the unit.

Returns:

the unit at the requested rank.

size

public int size()

Get the size of the units list.

Returns:

the size of the units list.

getArray

public GUnit[] getArray()

Get the list of units as an array.

Returns:

the list of units as an array.