ucar.unidata.util

Class TwoFacedObject

java.lang.Object

ucar.unidata.util.TwoFacedObject

All Implemented Interfaces:

java.lang.Comparable

public class TwoFacedObject
extends java.lang.Object
implements java.lang.Comparable

A generic Object wrapper that holds two objects. The first is used as the label and for comparisons in lists.

Version:

$Revision: 1.20 $ $Date: 2006/06/23 20:17:32 $

Author:

Metapps development team

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug debug flag

Constructor Summary

Constructors

Constructor and Description
TwoFacedObject() Default constructor with null id and label
TwoFacedObject(java.lang.Object label) Create a TwoFacedObject where both id and label are identical.
TwoFacedObject(java.lang.Object label, int id) Create a TwoFacedObject with label and integer id
TwoFacedObject(java.lang.Object label, java.lang.Object id) Create a TwoFacedObject.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compare this object to another.
static boolean	contains(java.util.List objects, java.lang.Object value)
static java.util.List	createList(int[] ids, java.lang.String[] names) Create a list of tfos from the given int ids and names
static java.util.List	createList(java.lang.String[] ids, java.lang.String[] names) Create a list of tfos from the given int ids and names
boolean	equals(java.lang.Object other) See if this TwoFacedObject is equal to another object.
static TwoFacedObject	findId(java.lang.Object id, java.util.List l) Finf the tfo with the given id in the list
static java.lang.String	findLabel(java.lang.Object id, java.util.List l) Find the label for the object in the list
java.lang.Object	getId() Get the Id object.
static java.util.List	getIdList(java.util.List objects) Create a list of ids from the given list of objects.
static java.lang.Object	getIdObject(java.lang.Object o) Get the id object of this possible TwoFacedObject.
static java.lang.String	getIdString(java.lang.Object o) Get a String representation for the id of this TwoFacedObject.
static java.util.List	getIdStrings(java.util.List objects) Get a String representation for the objects in te lsit
java.lang.Object	getLabel() Get the Label object.
int	hashCode() Get the hashcode for this TwoFacedObject
void	setId(java.lang.Object newId) Sets the value of the Id object.
void	setLabel(java.lang.Object newLabel) Sets the value of the Label object.
static void	sort(java.util.List list)
java.lang.String	toString() String representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

debug

public static boolean debug

debug flag

Constructor Detail

TwoFacedObject

public TwoFacedObject()

Default constructor with null id and label

TwoFacedObject

public TwoFacedObject(java.lang.Object label)

Create a TwoFacedObject where both id and label are identical.

Parameters:

label - label and object

TwoFacedObject

public TwoFacedObject(java.lang.Object label,
                      int id)

Create a TwoFacedObject with label and integer id

Parameters:

label - label

id - id

TwoFacedObject

public TwoFacedObject(java.lang.Object label,
                      java.lang.Object id)

Create a TwoFacedObject.

Parameters:

label - object to use for labeling.

id - other face of this object

Method Detail

toString

public java.lang.String toString()

String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

toString() method of label.

equals

public boolean equals(java.lang.Object other)

See if this TwoFacedObject is equal to another object.

Overrides:

equals in class java.lang.Object

Parameters:

other -

Returns:

true if both are TwoFacedObjects and their id-s are equal

hashCode

public int hashCode()

Get the hashcode for this TwoFacedObject

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode

getId

public java.lang.Object getId()

Get the Id object.

Returns:

the id for this TwoFacedObject.

setId

public void setId(java.lang.Object newId)

Sets the value of the Id object.

Parameters:

newId -

getLabel

public java.lang.Object getLabel()

Get the Label object.

Returns:

the label for this TwoFacedObject.

setLabel

public void setLabel(java.lang.Object newLabel)

Sets the value of the Label object.

Parameters:

newLabel -

getIdString

public static java.lang.String getIdString(java.lang.Object o)

Get a String representation for the id of this TwoFacedObject.

Parameters:

o - object in question.

Returns:

the toString() of the id if this is a TwoFacedObject, otherwise the toString() method of o.

getIdObject

public static java.lang.Object getIdObject(java.lang.Object o)

Get the id object of this possible TwoFacedObject.

Parameters:

o - object in question.

Returns:

the id if this is a TwoFacedObject, otherwise o.

createList

public static java.util.List createList(int[] ids,
                                        java.lang.String[] names)

Create a list of tfos from the given int ids and names

Parameters:

ids - ids

names - names

Returns:

list of tfos

createList

public static java.util.List createList(java.lang.String[] ids,
                                        java.lang.String[] names)

Create a list of tfos from the given int ids and names

Parameters:

ids - ids

names - names

Returns:

list of tfos

getIdList

public static java.util.List getIdList(java.util.List objects)

Create a list of ids from the given list of objects. For any TwoFaceObject in objects, the id is added to the resulting list, otherwise the object is added

Parameters:

objects - list of objects

Returns:

list of tfos

findId

public static TwoFacedObject findId(java.lang.Object id,
                                    java.util.List l)

Finf the tfo with the given id in the list

Parameters:

id - id to look for

l - list of tfos

Returns:

the tfo or null if none found

findLabel

public static java.lang.String findLabel(java.lang.Object id,
                                         java.util.List l)

Find the label for the object in the list

Parameters:

id - object to search for

l - list of TwoFacedObjects objects

Returns:

the label

contains

public static boolean contains(java.util.List objects,
                               java.lang.Object value)

getIdStrings

public static java.util.List getIdStrings(java.util.List objects)

Get a String representation for the objects in te lsit

Parameters:

objects - objects in question.

Returns:

List of fbhe toString() of the id if these are TwoFacedObjects, otherwise the toString() method of o.

compareTo

public int compareTo(java.lang.Object o)

Compare this object to another.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - object in question.

Returns:

spec from Comparable interface.

sort

public static void sort(java.util.List list)