jas.engine
Class ProjectDocument

java.lang.Object
  jas.engine.ProjectDocument

Direct Known Subclasses:

ProjectXMLDocument

public abstract class ProjectDocument
extends java.lang.Object

An abstract class implementing the generic content of a project. The derived class must override the Constructor to load the parameters from a file and the saveDocument() method to save parameters to file. This class is abstract to uncouple its internal parameter representation and its external file format.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Field Summary

java.util.ArrayList	classPath The list of the directories or jar files representing the local classpath.
java.util.Map	locationBag The list of sizes and positions of the windows built by models.
short	majorVersion Major version of the engine stored this document.
java.lang.String	projectDescription The project description.
java.io.File	projectFile The file associated with this document.
java.lang.String	projectName The project name.
boolean	randomSeedGeneration Decides if the random seed must be generated by simulation engine or not.
java.util.ArrayList	runningModels The list of the ISimModel classes to load into simulation engine.
boolean	runsInRealTime Enabled if model time is based on real time.
long	seed If randomSeedGeneration is true this variable is ignored, otherwise the engine's random seed is set to this value.
int	timeUnit Time unit used by the project.

Constructor Summary

ProjectDocument()
Construct a project document with no name.

ProjectDocument(java.lang.String projectName)
Standard project document constructor.

Method Summary

void	addLocationBag(java.lang.String owner, java.lang.String title, java.lang.String commaPositions) Add window size and postion entry into the location bag.
void	executeProject(SimEngine engine) Load the project into the simulation engine.
boolean	isCreatable() Return if project is creatable, using the executeProject method.
abstract void	saveDocument() Store the document on the projectFile file.
void	saveDocument(java.io.File file) Store the document in the given file.

Methods inherited from class java.lang.Object

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

Field Detail

classPath

public java.util.ArrayList classPath

The list of the directories or jar files representing the local classpath. See the DynamicClassLoader description for more details.

locationBag

public java.util.Map locationBag

The list of sizes and positions of the windows built by models. When the project is saved to disk the current dimensions are stored. So the project remember the last graphical setup made by user.

majorVersion

public short majorVersion

Major version of the engine stored this document.

projectDescription

public java.lang.String projectDescription

The project description.

projectFile

public java.io.File projectFile

The file associated with this document.

projectName

public java.lang.String projectName

The project name.

randomSeedGeneration

public boolean randomSeedGeneration

Decides if the random seed must be generated by simulation engine or not.

runningModels

public java.util.ArrayList runningModels

The list of the ISimModel classes to load into simulation engine.

runsInRealTime

public boolean runsInRealTime

Enabled if model time is based on real time.

seed

public long seed

If randomSeedGeneration is true this variable is ignored, otherwise the engine's random seed is set to this value.

timeUnit

public int timeUnit

Time unit used by the project.

Constructor Detail

ProjectDocument

public ProjectDocument()

Construct a project document with no name.

ProjectDocument

public ProjectDocument(java.lang.String projectName)

Standard project document constructor.

Parameters:

projectName - The project name.

Method Detail

addLocationBag

public void addLocationBag(java.lang.String owner,
                           java.lang.String title,
                           java.lang.String commaPositions)

Add window size and postion entry into the location bag.

Parameters:

owner - The SimModel owner's id.

title - The window title.

commaPositions - A string like "0,0,10,10", representing locationX, locationY, sizeX, sizeY.

executeProject

public void executeProject(SimEngine engine)

Load the project into the simulation engine.

Parameters:

engine - The current simulation engine.

isCreatable

public boolean isCreatable()

Return if project is creatable, using the executeProject method.

Returns:

If models has been built it returns true, false if just created.

saveDocument

public abstract void saveDocument()

Store the document on the projectFile file.

saveDocument

public void saveDocument(java.io.File file)

Store the document in the given file.

Parameters:

file - The file to be saved.