com.portal.browse

Class DataTemplate

java.lang.Object

com.portal.browse.DataTemplate

All Implemented Interfaces:

Serializable

public class DataTemplate
extends Object
implements Serializable

The data template class is used to encapsulate the FList/POID/array data to display along with a display format description.

Version:

%version: 11 % %date_modified: Wed Oct 11 09:01:09 2000 %

Author:

Larry Lynch-Freshner, Monica Gaines

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataTemplate(Object data) Create a data template object.
DataTemplate(Object parent, Object data, String fldName) Create a data template object.
DataTemplate(Object data, String[] order) Create a data template object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns whether the given object is the same as this data template
Object	getChild() Returns a child object of the data template.
String	getChildFldName() Returns the field name for the child object of the data template.
Object	getData() Returns the actual data assoicated with the data template.
String	getName() Returns the name used to describe this data template.
String[]	getOrderedFields() Returns an array of the ordered fields.
Object	getOrigData() Returns the orginial data that was used to create this template.
String	getString() Returns the string used to describe the data template.
Object[]	getSubOrder()
void	setData(Object d)
void	setOrderedFields(String[] oFields) Sets the ordered fields array.
void	setString(String str) Sets the string to be used for describing the data template.
void	setSubOrder(Object[] objs)
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTemplate

public DataTemplate(Object data,
                    String[] order)

Create a data template object.

Parameters:

data - the data to be encapsulated

order - the order to display the fields

DataTemplate

public DataTemplate(Object data)

Create a data template object.

Parameters:

data - the data to be encapsulated

DataTemplate

public DataTemplate(Object parent,
                    Object data,
                    String fldName)

Create a data template object.

Parameters:

parent - the data to be encapsulated

data - a child object, usually a SparseArray or SubStruct

fldName - the field name for the child object

Method Detail

setString

public void setString(String str)

Sets the string to be used for describing the data template.

Parameters:

str - the string to describle the data template

getString

public String getString()

Returns the string used to describe the data template.

Returns:

the string that describes this data template.

setData

public void setData(Object d)

getData

public Object getData()

Returns the actual data assoicated with the data template.

Returns:

the actual data

getOrigData

public Object getOrigData()

Returns the orginial data that was used to create this template.

getName

public String getName()

Returns the name used to describe this data template.

Returns:

the name of the data template

getSubOrder

public Object[] getSubOrder()

setSubOrder

public void setSubOrder(Object[] objs)

getOrderedFields

public String[] getOrderedFields()

Returns an array of the ordered fields.

Returns:

An array containing the ordered fields

setOrderedFields

public void setOrderedFields(String[] oFields)

Sets the ordered fields array.

Parameters:

oFields - An array containing the ordered fields

equals

public boolean equals(Object obj)

Returns whether the given object is the same as this data template

Overrides:

equals in class Object

Returns:

true if the object is the same, false otherwise

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Parameters:

a - string repesentation of this object

getChild

public Object getChild()

Returns a child object of the data template. This only gets set in the constructor and is typically used for SparseArrays or substructs.

Parameters:

the - child object

getChildFldName

public String getChildFldName()

Returns the field name for the child object of the data template. This only gets set in the constructor and is typically used for SparseArrays or substructs.

Parameters:

field - name for the child object