sortie.data.simpletypes.DataMember Class Reference

An object of this class represents a data member from a grid or tree. More...

Inheritance diagram for sortie.data.simpletypes.DataMember:

Public Member Functions
	DataMember (String sDisplayName, String sCodeName, int iType) throws ModelException
	Constructor. More...
String	toString ()
	Overridden from Object. More...
boolean	equals (Object oObject)
	Tests for equality. More...
String	getDisplayName ()
	Gets the display name of this data member. More...
void	setDisplayName (String sNewName)
	Sets the display name of this data member. More...
String	getCodeName ()
	Gets the code name of this data member. More...
void	setCodeName (String sNewName)
	Sets the code name of this data member. More...
int	getType ()
	Gets the type of this data member. More...
void	setType (int iType)
	Sets the type of this data member. More...
int	getCode ()
	Get the data member numerical code. More...
void	setCode (int iCode)
	Sets the data member numerical code. More...
Object	clone ()
	Creates a deep clone of this object. More...

Static Public Attributes
static final int	INTEGER = 0
	Data member is of type integer. More...
static final int	FLOAT = 1
	Data member is of type float. More...
static final int	CHAR = 2
	Data member is of type char. More...
static final int	BOOLEAN = 3
	Data member is of type boolean. More...

Protected Attributes
String	m_sDisplayName
	The display name is that which will be shown to users. More...
int	m_iType
	Data member type - one of the four static finals above. More...

Detailed Description

An object of this class represents a data member from a grid or tree.

Not all class members need to be set - just whatever is needed by whoever is using this class.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author

Lora E. Murphy

Version

1.0

Edit history:
---------------—
April 28, 2004: Submitted in beta version (LEM)

Constructor & Destructor Documentation

DataMember()

sortie.data.simpletypes.DataMember.DataMember	(	String	sDisplayName,
		String	sCodeName,
		int	iType
	)		throws ModelException

Constructor.

Parameters

sDisplayName	The name which will be displayed to the user
sCodeName	The name of the data member to be passed to the core model code.
iType	The data member type - options are INTEGER, FLOAT, CHAR, and BOOLEAN

Exceptions

ModelException

If iType is not recognized.

Member Function Documentation

clone()

Object sortie.data.simpletypes.DataMember.clone

(

)

Creates a deep clone of this object.

Returns

Clone.

equals()

boolean sortie.data.simpletypes.DataMember.equals

(

Object

oObject

)

Tests for equality.

Parameters

oObject

Object to test

Returns

True if the objects are equal, false if not

getCode()

int sortie.data.simpletypes.DataMember.getCode

(

)

Get the data member numerical code.

Returns

The code number.

getCodeName()

String sortie.data.simpletypes.DataMember.getCodeName

(

)

Gets the code name of this data member.

Returns

The code name.

getDisplayName()

String sortie.data.simpletypes.DataMember.getDisplayName

(

)

Gets the display name of this data member.

Returns

The display name.

getType()

int sortie.data.simpletypes.DataMember.getType

(

)

Gets the type of this data member.

Returns

Data member type.

setCode()

void sortie.data.simpletypes.DataMember.setCode

(

int

iCode

)

Sets the data member numerical code.

Parameters

iCode

The code number.

setCodeName()

void sortie.data.simpletypes.DataMember.setCodeName

(

String

sNewName

)

Sets the code name of this data member.

Parameters

sNewName

String New name to set.

setDisplayName()

void sortie.data.simpletypes.DataMember.setDisplayName

(

String

sNewName

)

Sets the display name of this data member.

Parameters

sNewName

String New name to set.

setType()

void sortie.data.simpletypes.DataMember.setType

(

int

iType

)

Sets the type of this data member.

Parameters

iType

Data member type.

toString()

String sortie.data.simpletypes.DataMember.toString

(

)

Overridden from Object.

Returns

Display name string

Member Data Documentation

BOOLEAN

final int sortie.data.simpletypes.DataMember.BOOLEAN = 3

static

Data member is of type boolean.

CHAR

final int sortie.data.simpletypes.DataMember.CHAR = 2

static

Data member is of type char.

FLOAT

final int sortie.data.simpletypes.DataMember.FLOAT = 1

static

Data member is of type float.

INTEGER

final int sortie.data.simpletypes.DataMember.INTEGER = 0

static

Data member is of type integer.

m_iType

int sortie.data.simpletypes.DataMember.m_iType

protected

Data member type - one of the four static finals above.

m_sDisplayName

String sortie.data.simpletypes.DataMember.m_sDisplayName

protected

The display name is that which will be shown to users.

---

The documentation for this class was generated from the following file:

• DataMember.java