edu.northwestern.at.wordhoard.swing.calculator.analysis
Class DescribeUserDataObject

java.lang.Object
  edu.northwestern.at.wordhoard.swing.calculator.analysis.DescribeUserDataObject

public class DescribeUserDataObject
extends java.lang.Object

Describes the contents of a word set, work set, or phrase set.

Constructor Summary

DescribeUserDataObject()

Method Summary

protected static void	addSetting(LabeledSettingsTable table, java.lang.String refLabel, int value) Add a setting and its value to the settings table.
protected static void	addSetting(LabeledSettingsTable table, java.lang.String refLabel, java.lang.Object value) Add a setting and its value to the settings table.
static XTable	describe(UserDataObject userDataObject) Describe a user data object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeUserDataObject

public DescribeUserDataObject()

Method Detail

describe

public static XTable describe(UserDataObject userDataObject)

Describe a user data object.

Parameters:

userDataObject - The user data object to describe.

Returns:

A table with the object's settings and values. Null if the input object is null.

addSetting

protected static void addSetting(LabeledSettingsTable table,
                                 java.lang.String refLabel,
                                 java.lang.Object value)

Add a setting and its value to the settings table.

Parameters:

table - The settings table.

refLabel - Reference name for setting. Will be looked up in WordHoardSettings.

value - The setting's value.

addSetting

protected static void addSetting(LabeledSettingsTable table,
                                 java.lang.String refLabel,
                                 int value)

Add a setting and its value to the settings table.

Parameters:

table - The settings table.

refLabel - Reference name for setting. Will be looked up in WordHoardSettings.

value - The setting's value.