A B C D F G H I J L M N O P R S T U V W Y

A

AbstractStep - class pop.gui.AbstractStep.

Abstract ancestor of all actions.

AbstractStep.StepFrame - class pop.gui.AbstractStep.StepFrame.

Used by subclasses to simplify their own frames.

AbstractStep.StepFrame(AbstractStep, String) - Constructor for class pop.gui.AbstractStep.StepFrame

Constructs a StepFrame with given title.

AbstractStep.StepTableModel - class pop.gui.AbstractStep.StepTableModel.

Adequate table model for most of the subclasses; mostly taken from TableEditDemo.java, http://java.sun.com/docs/books/tutorial.

AbstractStep.StepTableModel(AbstractStep, Object[][], String[]) - Constructor for class pop.gui.AbstractStep.StepTableModel

AbstractStep(String) - Constructor for class pop.gui.AbstractStep

Simply invokes parent constructor

accept(File) - Method in class pop.gui.LoadAction.ModelFileFilter

accept(File) - Method in class pop.gui.DataAction.DataFileFilter

accept(File) - Method in class pop.gui.SaveAction.ModelFileFilter

ActionManager - class pop.gui.ActionManager.

Keeps track of actions performed.

ActionManager() - Constructor for class pop.gui.ActionManager

Only usable constructor.

actionPerformed(ActionEvent) - Method in class pop.gui.LoadAction

Retrieves a filename from the user for loading the model.

actionPerformed(ActionEvent) - Method in class pop.gui.DetailedAction

Displays a frame for user to select results.

actionPerformed(ActionEvent) - Method in class pop.gui.MigrationAction

Retrieves migration data or a file name from the user.

actionPerformed(ActionEvent) - Method in class pop.gui.MortalityAction

Retrieves mortality data or a file name from the user.

actionPerformed(ActionEvent) - Method in class pop.gui.PopulationAction

Retrieves population data or a file name from the user.

actionPerformed(ActionEvent) - Method in class pop.gui.SummaryAction

Shows the summary results.

actionPerformed(ActionEvent) - Method in class pop.gui.RunAction

Runs the model if it hasn't already been run for the current configuration of data.

actionPerformed(ActionEvent) - Method in class pop.gui.SaveAction

Retrieves a filename from the user for saving the model.

actionPerformed(ActionEvent) - Method in class pop.gui.SetupAction

Intended as user-initiated action

actionPerformed(ActionEvent) - Method in class pop.gui.FertilityAction

Retrieves fertility data or a file name from the user.

add(Action) - Method in class pop.gui.StepBox

Adds an action to the toolbar.

addNotify() - Method in class pop.gui.MainFrame

Invokes super.addNotify(), and adjusts frame size to accommodate all insets.

all_sizes() - Method in class pop.model.Population

Returns 2-dimensional array of population sizes for the current year.

append_line(String, AttributeSet) - Method in class pop.gui.StepBox

Adds new line of text with given attributes to message.

append_text(String, AttributeSet) - Method in class pop.gui.StepBox

Adds string (no new line) with given attributes to message.

Assert - class pop.utilities.Assert.

Generalized assertion verifier class.

Assert() - Constructor for class pop.utilities.Assert

assert(boolean, String) - Static method in class pop.utilities.Assert

throws AssertionException if general assertion is false

AssertionException - exception pop.utilities.AssertionException.

Exception for assertion violations.

AssertionException(String) - Constructor for class pop.utilities.AssertionException

Constructs RuntimeException with specified message.

B

bad_format() - Static method in class pop.utilities.FileTools

Throws a FileFormatException with a generic message.

bad_format(String) - Static method in class pop.utilities.FileTools

Throws a FileFormatException with specified message.

base_year() - Static method in class pop.model.Statics

Returns base year of this model.

base_year() - Method in class pop.model.Constants

Base year of the model (for display).

births() - Method in class pop.model.Cohort

Births attributable to this cohort this time period.

births(int) - Method in class pop.model.Results

Returns 2-dimensional array of births for the specified year.

births(int, int) - Method in class pop.model.Results

Returns array of births for the specified year and population category (with females in the first row, males second row).

C

categories() - Static method in class pop.model.Statics

Returns number of population categories in this model.

categories() - Method in class pop.model.Constants

Number of population categories.

category_name(int) - Static method in class pop.model.Statics

Returns copy of the indicated category name.

category_name(int) - Method in class pop.model.Constants

Returns copy of the indicated category name.

category_names() - Static method in class pop.model.Statics

Returns copy of whole array of population category names.

category_names() - Method in class pop.model.Constants

Category names.

category(String) - Static method in class pop.model.Statics

Returns category number of indicated category.

choose_input_file(String) - Method in class pop.gui.DataAction

Chooses an input data file.

choose_input_file(String, FileFilter) - Method in class pop.gui.AbstractStep

Utility for choosing a filename.

clear_done() - Method in class pop.gui.AbstractStep

Resets an action's name to indicate not completed.

clear_done() - Method in class pop.gui.SetupAction

Reverses show_done().

Cohort - class pop.model.Cohort.

A particular age-sex group within a Population.

Cohort(int, int, Population, int) - Constructor for class pop.model.Cohort

Only constructor.

columnNames - Variable in class pop.gui.AbstractStep.StepTableModel

confirm(Container, Object[][]) - Method in class pop.gui.AbstractStep

Utility for dialog to confirm data entry.

Constants - class pop.model.Constants.

A way to encapsulate the model's constants, especially for writing and reading as a whole.

constants() - Method in class pop.model.Statics

Returns a new Constants object with current model's maximum_age(), categories(), category_names(), years(), and base_year().

constants() - Method in class pop.model.Results

Returns constants associated with this model.

Constants(Constants) - Constructor for class pop.model.Constants

Construct a copy of the Constants object.

Constants(int, int, String[], int, int, String) - Constructor for class pop.model.Constants

Basic constructor.

createDefaultModel() - Method in class pop.gui.WholeNumberField

D

data - Variable in class pop.gui.AbstractStep.StepTableModel

data_completed() - Method in class pop.gui.ActionManager

True if data are complete.

DataAction - class pop.gui.DataAction.

Ancestor of the four types of data entry/edit/retrieval actions.

DataAction.DataFileFilter - class pop.gui.DataAction.DataFileFilter.

A filter for .dat and .txt files.

DataAction.DataFileFilter(DataAction) - Constructor for class pop.gui.DataAction.DataFileFilter

DataAction(String) - Constructor for class pop.gui.DataAction

Passes the action's name to the superclass constructor, and insures the data action begins disabled.

DataFactory - interface pop.model.DataFactory.

A superclass interface for the four types of data factories.

deaths() - Method in class pop.model.Population

Returns 2-dimensional array of deaths for the current year.

deaths() - Method in class pop.model.Cohort

Deaths in this cohort over this time period.

deaths(int) - Method in class pop.model.Results

Returns 3-dimensional array of deaths for the specified year.

deaths(int, int) - Method in class pop.model.Results

Returns 2-dimensional array of deaths for the specified year and population category.

destroy() - Method in class pop.model.ModelManager

Destroys the current model; necessary to create a new one.

destroy() - Method in class pop.model.Statics

Only way to destroy an old model prior to creating a new one.

destroy() - Method in class pop.gui.ActionManager

Only way to destroy an old ActionManager prior to creating a new one.

detailed_action() - Method in class pop.gui.ActionManager

The action for detailed results.

DetailedAction - class pop.gui.DetailedAction.

Displays detailed results.

DetailedAction() - Constructor for class pop.gui.DetailedAction

Creates a new detailed action.

F

factory() - Method in class pop.gui.PopulationAction

Returns the PopulationSizesFactory if it exists (null otherwise).

FEMALE - Static variable in class pop.model.Statics

Identifies a female cohort.

female_births() - Method in class pop.model.Population

Returns number of female births for the current year.

female_deaths() - Method in class pop.model.Population

Returns age-array of female deaths for the current year.

female_migrants() - Method in class pop.model.Migration

Returns array of female inmigrants.

female_sizes() - Method in class pop.model.Population

Returns age-array of female population sizes, current year.

Fertility - class pop.model.Fertility.

Age-specific fertility rates, including the proportion of births that are females.

fertility_action() - Method in class pop.gui.ActionManager

The action for fertility data.

Fertility(double[], double) - Constructor for class pop.model.Fertility

Basic constructor (one set of fertility rates, and a female-birth proportion).

fertility(int) - Method in class pop.model.Population

Returns age-specific fertility rate.

FertilityAction - class pop.gui.FertilityAction.

Assembles fertility data.

FertilityAction() - Constructor for class pop.gui.FertilityAction

Constructs a new FertilityAction.

FertilityFactory - interface pop.model.FertilityFactory.

Creates Fertility objects.

FertilityFile - class pop.data.FertilityFile.

Creates Fertility objects from files on disk.

FertilityFile(String) - Constructor for class pop.data.FertilityFile

Constructor to open and read a named file.

FILE_DATA - Static variable in class pop.gui.DataAction

Identifies user choice to enter data from a file.

FileFormatException - exception pop.utilities.FileFormatException.

Exception to throw when a data file for the Demographic Forecasting system is incorrectly formatted for the current model (thrown by use of FileTools.bad_format()).

FileFormatException(String) - Constructor for class pop.utilities.FileFormatException

Constructs RuntimeException with specified message.

FileTools - class pop.utilities.FileTools.

Some tools for dealing with data files.

FileTools() - Constructor for class pop.utilities.FileTools

final_population() - Method in class pop.model.Results

Returns the array of final population sizes; elements of array correspond to population categories.

FULL_FILE - Static variable in class pop.gui.MigrationAction

Migration file is in full form.

G

get_characteristics(int) - Method in interface pop.model.DataFactory

Returns a new PopulationCharacteristics object for the indicated population category.

get_characteristics(int) - Method in class pop.data.MortalityFile

Returns a new Mortality object for the indicated population category.

get_characteristics(int) - Method in class pop.data.MigrationSpreader

Returns a new Migration object for the indicated population category and the current year of the model.

get_characteristics(int) - Method in class pop.data.InitialPopulationArray

Returns a new PopulationSizes object for the indicated population category.

get_characteristics(int) - Method in class pop.data.MigrationFile

Returns a new Migration object for the indicated population category and the current year of the model.

get_characteristics(int) - Method in class pop.data.InitialPopulationFile

Returns a new PopulationSizes object for the indicated population category.

get_characteristics(int) - Method in class pop.data.FertilityFile

Returns a new Fertility object for the indicated population category.

get_characteristics(int) - Method in class pop.data.InitialPopulationTables

Returns a new PopulationSizes object for the indicated population category.

get_characteristics(String) - Method in interface pop.model.DataFactory

Returns a new PopulationCharacteristics object for the indicated population category.

get_characteristics(String) - Method in class pop.data.MortalityFile

Returns a new Mortality object for the indicated population category.

get_characteristics(String) - Method in class pop.data.MigrationSpreader

Returns a new Migration object for the indicated population category and the current year of the model.

get_characteristics(String) - Method in class pop.data.InitialPopulationArray

Returns a new PopulationSizes object for the indicated population category.

get_characteristics(String) - Method in class pop.data.MigrationFile

Returns a new Migration object for the indicated population category and the current year of the model.

get_characteristics(String) - Method in class pop.data.InitialPopulationFile

Returns a new PopulationSizes object for the indicated population category.

get_characteristics(String) - Method in class pop.data.FertilityFile

Returns a new Fertility object for the indicated population category.

get_characteristics(String) - Method in class pop.data.InitialPopulationTables

Returns a new PopulationSizes object for the indicated population category.

get_fertility(int) - Method in interface pop.model.FertilityFactory

Returns a new Fertility object for the indicated population category.

get_fertility(int) - Method in class pop.data.FertilityFile

Returns a new Fertility object for the indicated population category.

get_fertility(String) - Method in interface pop.model.FertilityFactory

Returns a new Fertility object for the indicated population category.

get_fertility(String) - Method in class pop.data.FertilityFile

Returns a new Fertility object for the indicated population category.

get_migration(int, int) - Method in interface pop.model.MigrationFactory

Returns a new Migration object for the indicated population category and year.

get_migration(int, int) - Method in class pop.data.MigrationSpreader

Returns a new Migration object for the indicated population category and year.

get_migration(int, int) - Method in class pop.data.MigrationFile

Returns a new Migration object for the indicated population category and year.

get_migration(String, int) - Method in interface pop.model.MigrationFactory

Returns a new Migration object for the indicated population category and year.

get_migration(String, int) - Method in class pop.data.MigrationSpreader

Returns a new Migration object for the indicated population category and year.

get_migration(String, int) - Method in class pop.data.MigrationFile

Returns a new Migration object for the indicated population category and year.

get_mortality(int) - Method in interface pop.model.MortalityFactory

Returns a new Mortality object for the indicated population category.

get_mortality(int) - Method in class pop.data.MortalityFile

Returns a new Mortality object for the indicated population category.

get_mortality(String) - Method in interface pop.model.MortalityFactory

Returns a new Mortality object for the indicated population category.

get_mortality(String) - Method in class pop.data.MortalityFile

Returns a new Mortality object for the indicated population category.

getColumnClass(int) - Method in class pop.gui.AbstractStep.StepTableModel

getColumnCount() - Method in class pop.gui.AbstractStep.StepTableModel

getColumnName(int) - Method in class pop.gui.AbstractStep.StepTableModel

getDescription() - Method in class pop.gui.LoadAction.ModelFileFilter

Description lists *.dat and *.txt as choices.

getDescription() - Method in class pop.gui.DataAction.DataFileFilter

Description lists *.dat and *.txt as choices.

getDescription() - Method in class pop.gui.SaveAction.ModelFileFilter

Description lists *.dat and *.txt as choices.

getRowCount() - Method in class pop.gui.AbstractStep.StepTableModel

getValue() - Method in class pop.gui.WholeNumberField

getValueAt(int, int) - Method in class pop.gui.AbstractStep.StepTableModel

got_factory() - Method in class pop.gui.PopulationAction

True if a PopulationSizesFactory has been created.

got_file() - Method in class pop.gui.LoadAction

True if the user has asked for a file to be opened.

got_file() - Method in class pop.gui.DataAction

True if the user has asked for a file to be opened.

got_file() - Method in class pop.gui.MigrationAction

True if user asked for a file to be opened.

got_file() - Method in class pop.gui.MortalityAction

True if user asked for a file to be opened.

got_file() - Method in class pop.gui.PopulationAction

True if user asked for a file to be opened.

got_file() - Method in class pop.gui.SaveAction

True if the user has asked for a file to be opened.

got_file() - Method in class pop.gui.FertilityAction

True if user asked for a file to be opened.

got_models() - Method in class pop.gui.MigrationAction

True if the user has entered data now stored in TableModels.

got_models() - Method in class pop.gui.MortalityAction

True if the user has entered data now stored in TableModels.

got_models() - Method in class pop.gui.FertilityAction

True if the user has entered data now stored in TableModels.

H

has_fert_source() - Method in class pop.model.ModelManager

True if the model has a source of fertility rates.

has_manager() - Method in class pop.gui.AbstractStep

A way for subclasses to check manager available.

has_migrant_source() - Method in class pop.model.ModelManager

True if the model has a source of migration data.

has_mort_source() - Method in class pop.model.ModelManager

True if the model has a source of mortality rates.

has_pop_source() - Method in class pop.model.ModelManager

True if the model has a source of initial population sizes.

I

increment_model() - Method in class pop.model.ModelManager

Increments the model one year, until the current year is equal to Statics.years().

increment() - Method in class pop.model.Statics

Increments current year of model.

increment(Migration) - Method in class pop.model.Population

Increments this population one year.

inform(Object) - Method in class pop.gui.AbstractStep

Displays information dialog to user.

initial_population_sizes(int) - Method in class pop.gui.ActionManager

Returns initial population sizes for the specified category if population data entry is completed; null otherwise.

InitialPopulationArray - class pop.data.InitialPopulationArray.

Creates array of PopulationSizes as copies or from int arrays.

InitialPopulationArray(int[][][]) - Constructor for class pop.data.InitialPopulationArray

Basic constructor copies a 3-dimensional array: [Statics.categories()][2][Statics.maximum_age()+1].

InitialPopulationArray(PopulationSizes[]) - Constructor for class pop.data.InitialPopulationArray

Handy constructor based on array of PopulationSizes.

InitialPopulationFile - class pop.data.InitialPopulationFile.

Creates arrays of initial populations from files on disk.

InitialPopulationFile(String) - Constructor for class pop.data.InitialPopulationFile

Constructor to open and read a named file.

InitialPopulationTables - class pop.data.InitialPopulationTables.

Creates arrays of initial populations from TableModels.

InitialPopulationTables(AbstractTableModel[]) - Constructor for class pop.data.InitialPopulationTables

Constructor based on array of TableModels.

inmigrants(int, int) - Method in class pop.model.Migration

Returns age- and sex-specific number of inmigrants.

input_filename - Variable in class pop.gui.AbstractStep

input_filename() - Method in class pop.gui.LoadAction

Returns the input filename if it exists.

input_filename() - Method in class pop.gui.DataAction

Returns the input filename if it exists.

input_type() - Method in class pop.gui.DataAction

Utility for asking user what kind of data input will occur.

insertString(int, String, AttributeSet) - Method in class pop.gui.WholeNumberField.WholeNumberDocument

INTERACTIVE_DATA - Static variable in class pop.gui.DataAction

Identifies user choice to enter data interactively.

isCellEditable(int, int) - Method in class pop.gui.AbstractStep.StepTableModel

J

Justify - class pop.utilities.Justify.

Used mostly to right justify numbers in strings of fixed length.

Justify() - Constructor for class pop.utilities.Justify

L

load_action() - Method in class pop.gui.ActionManager

The action for loading a model from a file.

load(String) - Static method in class pop.model.ModelManager

Tries to load a new model from the specified file.

LoadAction - class pop.gui.LoadAction.

Loads a model from a file.

LoadAction.ModelFileFilter - class pop.gui.LoadAction.ModelFileFilter.

A filter for .pop files.

LoadAction.ModelFileFilter(LoadAction) - Constructor for class pop.gui.LoadAction.ModelFileFilter

LoadAction() - Constructor for class pop.gui.LoadAction

Constructs a new LoadAction

M

main(String[]) - Static method in class pop.Pop

Starts the MainFrame.

main(String[]) - Static method in class pop.gui.MainFrame

To allow running as its own application.

MainFrame - class pop.gui.MainFrame.

The parent component of the graphical user interface.

MainFrame() - Constructor for class pop.gui.MainFrame

Constructs the GUI.

MainFrame(String) - Constructor for class pop.gui.MainFrame

Constructs the GUI with the specified title.

MALE - Static variable in class pop.model.Statics

Identifies a male cohort.

male_births() - Method in class pop.model.Population

Returns number of male births for the current year.

male_deaths() - Method in class pop.model.Population

Returns age-array of male deaths for the current year.

male_migrants() - Method in class pop.model.Migration

Returns array of male inmigrants.

male_sizes() - Method in class pop.model.Population

Returns age-array of male population sizes, current year.

manager - Static variable in class pop.gui.AbstractStep

maximum_age() - Static method in class pop.model.Statics

Returns maximum age of cohorts in this model.

maximum_age() - Method in class pop.model.Constants

Maximum cohort age.

maximum_fertile_age() - Method in class pop.model.Fertility

Returns maximum fertile age.

migrants() - Method in class pop.model.Migration

Returns 2-dimensional array of inmigrants by sex (first dimension, with females in the first row, males second row) and age (second dimension).

Migration - class pop.model.Migration.

Age- and sex-specific migration levels of a particular Population.

migration_action() - Method in class pop.gui.ActionManager

The action for migration data.

migration(int) - Method in class pop.model.Results

Returns array of migrations for the specified year; elements of array correspond to population category.

Migration(int[][]) - Constructor for class pop.model.Migration

Basic constructor (one year of migration).

MigrationAction - class pop.gui.MigrationAction.

Assembles migration data.

MigrationAction() - Constructor for class pop.gui.MigrationAction

Constructs a new MigrationAction.

MigrationFactory - interface pop.model.MigrationFactory.

Creates Migration objects.

MigrationFile - class pop.data.MigrationFile.

Creates Migration objects from files on disk in FULL format (with values for each age and sex cohort for each year).

MigrationFile(String) - Constructor for class pop.data.MigrationFile

Constructor to open and read a named file in FULL format.

MigrationSpreader - class pop.data.MigrationSpreader.

Creates Migration objects from partial input data.

MigrationSpreader(int[], double[][][]) - Constructor for class pop.data.MigrationSpreader

Basic constructor takes an array of total migration values and a 3-dimensional array of shares.

MigrationSpreader(int[], String) - Constructor for class pop.data.MigrationSpreader

Constructs a MigrationSpreader using migration totals from an array and default shares from a file.

MigrationSpreader(String) - Constructor for class pop.data.MigrationSpreader

Constructs a MigrationSpreader using both migration data and default shares from the same file.

MigrationSpreader(String, double[][][]) - Constructor for class pop.data.MigrationSpreader

Constructs a MigrationSpreader using migration data from a file, and default shares from an array.

minimum_fertile_age() - Method in class pop.model.Fertility

Returns minimum fertile age.

model_title() - Static method in class pop.model.Statics

Returns the model's title precondition: a Statics object is instantiated.

model_title() - Method in class pop.model.Constants

Title of the model (for display).

ModelManager - class pop.model.ModelManager.

Loosely manages the model's activities.

ModelManager(Constants) - Constructor for class pop.model.ModelManager

Handy constructor takes a Constants object.

ModelManager(int, int, String[], int, int, String) - Constructor for class pop.model.ModelManager

Alternate, uglier constructor requires multiple parameters.

Mortality - class pop.model.Mortality.

Age- and sex-specific mortality rates.

mortality_action() - Method in class pop.gui.ActionManager

The action for mortality data.

Mortality(double[][]) - Constructor for class pop.model.Mortality

Basic constructor (one set of mortality rates).

mortality(int, int) - Method in class pop.model.Population

Returns age- and sex-specific mortality rate.

MortalityAction - class pop.gui.MortalityAction.

Assembles mortality data.

MortalityAction() - Constructor for class pop.gui.MortalityAction

Creates a new MortalityAction.

MortalityFactory - interface pop.model.MortalityFactory.

Creates Mortality objects.

MortalityFile - class pop.data.MortalityFile.

Creates Mortality objects from files on disk.

MortalityFile(String) - Constructor for class pop.data.MortalityFile

Constructor to open and read a named file.

N

name() - Method in class pop.model.Population

Returns name of this population.

new_setup() - Method in class pop.gui.SetupAction

Returns true if user has set up a completely new model.

O

open_input_file(String) - Static method in class pop.utilities.FileTools

Returns BufferedReader object associated with indicated filename.

output_filename() - Method in class pop.gui.SaveAction

Returns the output filename if it exists.

P

pop - package pop

Pop - class pop.Pop.

Pop is the "main program" of the Demographic Forecasting System.

pop_source() - Method in class pop.model.ModelManager

Returns initial population sizes factory if one is available; null otherwise.

pop.data - package pop.data

pop.gui - package pop.gui

pop.model - package pop.model

pop.utilities - package pop.utilities

Pop() - Constructor for class pop.Pop

Population - class pop.model.Population.

A total population or a particular population group (such as an ethnic group).

population_action() - Method in class pop.gui.ActionManager

The action for initial population data.

population_sizes(int) - Method in interface pop.model.PopulationSizesFactory

Returns a new PopulationSizes object for the indicated population category.

population_sizes(int) - Method in class pop.data.InitialPopulationArray

Returns a new PopulationSizes object for the indicated population category.

population_sizes(int) - Method in class pop.data.InitialPopulationFile

Returns a new PopulationSizes object for the indicated population category.

population_sizes(int) - Method in class pop.data.InitialPopulationTables

Returns a new PopulationSizes object for the indicated population category.

population_sizes(String) - Method in interface pop.model.PopulationSizesFactory

Returns a new Fertility object for the indicated population category.

population_sizes(String) - Method in class pop.data.InitialPopulationArray

Returns a new PopulationSizes object for the indicated population category.

population_sizes(String) - Method in class pop.data.InitialPopulationFile

Returns a new PopulationSizes object for the indicated population category.

population_sizes(String) - Method in class pop.data.InitialPopulationTables

Returns a new PopulationSizes object for the indicated population category.

Population() - Constructor for class pop.model.Population

Unavailable.

population(int) - Method in class pop.model.Results

Returns array of population sizes for the specified year; elements of array correspond to population category.

Population(int[][], String, Fertility, Mortality) - Constructor for class pop.model.Population

Basic constructor.

Population(PopulationSizes, String, Fertility, Mortality) - Constructor for class pop.model.Population

Alternate constructor takes a PopulationSizes object instead of an array of initial population sizes.

PopulationAction - class pop.gui.PopulationAction.

Assembles initial population sizes.

PopulationAction() - Constructor for class pop.gui.PopulationAction

Constructs a new PopulationAction.

PopulationCharacteristics - class pop.model.PopulationCharacteristics.

Umbrella for representing population characteristics objects.

PopulationCharacteristics() - Constructor for class pop.model.PopulationCharacteristics

PopulationSizes - class pop.model.PopulationSizes.

Age- and sex-specific population sizes.

PopulationSizes(int[][]) - Constructor for class pop.model.PopulationSizes

Basic constructor (one set of population sizes).

PopulationSizes(PopulationSizes) - Constructor for class pop.model.PopulationSizes

Alternate constructor creates clone of sizes parameter.

PopulationSizesFactory - interface pop.model.PopulationSizesFactory.

Creates PopulationSizes objects.

postcondition(boolean, String) - Static method in class pop.utilities.Assert

throws AssertionException if postcondition is false

precondition(boolean, String) - Static method in class pop.utilities.Assert

throws AssertionException if precondition is false

proportion_female_births() - Method in class pop.model.Population

Returns proportion of total births resulting in female children.

proportion_female_births() - Method in class pop.model.Fertility

Returns proportion of total births resulting in female children.

R

rate(int) - Method in class pop.model.Fertility

Returns age-specific fertility rate.

rate(int, int) - Method in class pop.model.Mortality

Returns age- and sex-specific mortality rate.

rates() - Method in class pop.model.Fertility

Returns age-array of fertility rates.

rates() - Method in class pop.model.Mortality

Returns [sex][age] array of fertility rates.

read_a_line(BufferedReader) - Static method in class pop.utilities.FileTools

Returns the next record from a BufferedReader object.

ready() - Method in interface pop.model.DataFactory

Implementing classes are expected to override this method as a way to update their characteristics objects if necessary before each increment of the model.

ready() - Method in class pop.data.MortalityFile

Simply returns true at present.

ready() - Method in class pop.data.MigrationSpreader

Simply returns true; any fully-created MigrationSpreader is ready.

ready() - Method in class pop.data.InitialPopulationArray

Simply returns true at present.

ready() - Method in class pop.data.MigrationFile

Simply returns true at present.

ready() - Method in class pop.data.InitialPopulationFile

Simply returns true at present.

ready() - Method in class pop.data.FertilityFile

Simply returns true at present.

ready() - Method in class pop.data.InitialPopulationTables

Simply returns true at present.

ready() - Method in class pop.gui.RunAction

True if the data are all available.

reset_proportion(int, double[][][]) - Method in class pop.data.MigrationSpreader

Resets the proportioning used to spread migrations for a particular year only.

reset() - Method in class pop.model.ModelManager

Resets the current year to 0, so model can be rerun.

reset() - Method in class pop.model.Statics

Resets the current year to base year; model to be rerun.

Results - class pop.model.Results.

Stores all of the results from the model, and provides access to the results of each year for which the model has been run, plus the final populations.

results() - Method in class pop.model.ModelManager

Returns the results (null if model not yet incremented).

results() - Method in class pop.gui.ActionManager

Returns results if model has been run.

Results() - Constructor for class pop.model.Results

Unavailable.

Results(Constants) - Constructor for class pop.model.Results

Only useable constructor.

right(double, int) - Static method in class pop.utilities.Justify

Returns string of length size with the number right justified in it.

right(int, int) - Static method in class pop.utilities.Justify

Returns string of length size with the number right justified in it.

right(String, int) - Static method in class pop.utilities.Justify

Returns new string of length size with the string parameter right justified in it.

run_action() - Method in class pop.gui.ActionManager

The action for running the model.

run_completed() - Method in class pop.gui.ActionManager

True if model has been run.

run_model() - Method in class pop.model.ModelManager

Runs the model for all remaining years (0 to end if increment() not invoked).

RunAction - class pop.gui.RunAction.

Responds to user request to runs the model.

RunAction() - Constructor for class pop.gui.RunAction

Ordinary constructor.

S

save_action() - Method in class pop.gui.ActionManager

The action for saving a model to a file.

save(String) - Method in class pop.model.ModelManager

Saves the current model to a new file with the specified filename.

SaveAction - class pop.gui.SaveAction.

Saves a model to a file.

SaveAction.ModelFileFilter - class pop.gui.SaveAction.ModelFileFilter.

A filter for .pop files.

SaveAction.ModelFileFilter(SaveAction) - Constructor for class pop.gui.SaveAction.ModelFileFilter

SaveAction() - Constructor for class pop.gui.SaveAction

Constructs a new SaveAction

set_factory(FertilityFactory) - Method in class pop.model.ModelManager

Sets the factory that will produce fertility factors.

set_factory(MigrationFactory) - Method in class pop.model.ModelManager

Sets the factory that will produce migration data.

set_factory(MortalityFactory) - Method in class pop.model.ModelManager

Sets the factory that will produce mortality factors.

set_factory(PopulationSizesFactory) - Method in class pop.model.ModelManager

Sets the factory that will produce initial population sizes.

set_labels(Constants) - Method in class pop.model.Statics

Resets the labels (model title, base year, category names).

set_manager(ActionManager) - Static method in class pop.gui.AbstractStep

Assigns the Manager that actions can ask to things like displaying their internal frames.

set_new_labels(Constants) - Method in class pop.model.ModelManager

Changes just the labels in Statics.

set_proportion_female_births(double) - Method in class pop.model.Fertility

Sets proportion of births that are females to parameter value.

set_rates(double[]) - Method in class pop.model.Fertility

Sets all fertility rates to values of input array.

set_size(int) - Method in class pop.model.Cohort

Resets cohort size to the value of the parameter.

set_title(String) - Method in class pop.gui.StepBox

Can be used to change the title.

setGroupingUsed(boolean) - Method in class pop.gui.WholeNumberField

setup_action() - Method in class pop.gui.ActionManager

The action that sets up the model.

setup_completed() - Method in class pop.gui.ActionManager

True if setup is complete.

SetupAction - class pop.gui.SetupAction.

Sets up the model by querying user about main dimensions and titles.

SetupAction() - Constructor for class pop.gui.SetupAction

Intended for use by ActionManager object only

setUpIntegerEditor(JTable) - Method in class pop.gui.AbstractStep

Used to set default table editor for whole numbers.

setValue(int) - Method in class pop.gui.WholeNumberField

setValueAt(Object, int, int) - Method in class pop.gui.AbstractStep.StepTableModel

setVisible(boolean) - Method in class pop.gui.MainFrame

Sets visibility as directed.

shares_of(PopulationSizes[]) - Method in class pop.data.MigrationSpreader

Returns an appropriately arranged double array of shares that reflect the distribution of population in the input array of population sizes.

show_done() - Method in class pop.gui.AbstractStep

Resets an action's name to indicate completion.

show_done() - Method in class pop.gui.SetupAction

Records setup complete (invoked when setup values are acquired elsewhere.

size() - Method in class pop.model.Cohort

Current size of cohort, not counting deaths or migrants.

size(int, int) - Method in class pop.model.Population

Returns age- and sex-specific current population size (excludes migration for current year).

size(int, int) - Method in class pop.model.PopulationSizes

Returns age- and sex-specific population size.

sizes() - Method in class pop.model.PopulationSizes

Returns 2-dimensional array of population sizes by sex (first dimension, with females in the first row, males second row) and age (second dimension).

sizes(int) - Method in class pop.data.InitialPopulationArray

Returns handle to array of population sizes for the indicated population category.

sizes(int) - Method in class pop.data.InitialPopulationFile

Returns handle to array of population sizes for the indicated population category.

sizes(int) - Method in class pop.data.InitialPopulationTables

Returns handle to array of population sizes for the indicated population category.

sizes(String) - Method in class pop.data.InitialPopulationArray

Returns handle to array of population sizes for the indicated population category.

sizes(String) - Method in class pop.data.InitialPopulationFile

Returns handle to array of population sizes for the indicated population category.

sizes(String) - Method in class pop.data.InitialPopulationTables

Returns handle to array of population sizes for the indicated population category.

special(AbstractStep) - Method in class pop.gui.ActionManager

Special version of success() to handle unusual action requests.

SPREAD_FILE - Static variable in class pop.gui.MigrationAction

Migration file requires spreading to full form.

Statics - class pop.model.Statics.

Key static constants and methods used by many objects.

Statics() - Constructor for class pop.model.Statics

Unavailable.

Statics(Constants) - Constructor for class pop.model.Statics

Construct a Statics with a Constants object.

Statics(int, int, String[], int, int, String) - Constructor for class pop.model.Statics

Basic constructor.

StepBox - class pop.gui.StepBox.

Intro GUI for each of the four basic steps: setup, data, model, run.

StepBox(String) - Constructor for class pop.gui.StepBox

Constructs a StepBox with the given title.

store(int, Population[], Migration[]) - Method in class pop.model.Results

Stores results for the specified year.

store(Population[]) - Method in class pop.model.Results

Stores final population results.

success(AbstractStep) - Method in class pop.gui.ActionManager

A way for my actions to signal successful completion.

summary_action() - Method in class pop.gui.ActionManager

The action for summary results.

SummaryAction - class pop.gui.SummaryAction.

Summary results.

SummaryAction() - Constructor for class pop.gui.SummaryAction

Creates a new summary action; begins disabled.

survivors() - Method in class pop.model.Cohort

Size of cohort after current deaths, excluding migrants.

T

table_models() - Method in class pop.gui.MigrationAction

Returns the TableModels if they exist (null otherwise).

table_models() - Method in class pop.gui.MortalityAction

Returns the TableModels if they exist (null otherwise).

table_models() - Method in class pop.gui.FertilityAction

Returns the TableModels if they exist (null otherwise).

timesRoman() - Method in class pop.gui.AbstractStep

Utility for TimesRoman attribute set.

total_births() - Method in class pop.model.Population

Returns total number of births for the current year.

total_births(int) - Method in class pop.model.Results

Returns array of total births for a year.

total_deaths() - Method in class pop.model.Population

Returns sum of all female and male deaths.

total_deaths(int) - Method in class pop.model.Results

Returns array of total deaths for a year.

total_final_population() - Method in class pop.model.Results

Returns array of total final populations; elements of array correspond to population categories.

total_migration(int) - Method in class pop.model.Results

Returns array of total migration for the specified year; elements of array correpond to population categories;

total_population(int) - Method in class pop.model.Results

Returns array of total populations for the indicated year; elements of array correspond to population categories.

U

update_all_values() - Method in class pop.gui.AbstractStep.StepTableModel

user_directory - Static variable in class pop.gui.AbstractStep

V

valid_age(int) - Static method in class pop.model.Statics

True if age is in valid range (0 to maximum age).

valid_category(int) - Static method in class pop.model.Statics

True if category number is in valid range (0 to number of categories - 1).

valid_category(int) - Method in class pop.model.Constants

True if category number is in valid range (0 to number of categories - 1).

valid_category(String) - Static method in class pop.model.Statics

True if category name is one of the valid names.

valid_matrix(double[][]) - Static method in class pop.model.Statics

True if the dimensions of the 2-dimensional array exactly match the model's parameters (i.e., full 2 by 1+maximum_age()).

valid_matrix(int[][]) - Static method in class pop.model.Statics

True if the dimensions of the 2-dimensional array exactly match the model's parameters (i.e., full 2 by 1+maximum_age()).

valid_sex_constant(int) - Static method in class pop.model.Statics

True if sex is one of the valid constants.

values() - Method in class pop.gui.SetupAction

Returns the SetupValues.

W

WholeNumberField - class pop.gui.WholeNumberField.

Accepts whole number input only.

WholeNumberField.WholeNumberDocument - class pop.gui.WholeNumberField.WholeNumberDocument.

WholeNumberField.WholeNumberDocument(WholeNumberField) - Constructor for class pop.gui.WholeNumberField.WholeNumberDocument

WholeNumberField(int, int) - Constructor for class pop.gui.WholeNumberField

Y

year() - Static method in class pop.model.Statics

Returns current year of the model.

years() - Static method in class pop.model.Statics

Returns number of years the model is to be run.

years() - Method in class pop.model.Constants

Number of years to run the model.

A B C D F G H I J L M N O P R S T U V W Y