jas.engine
Class ProjectXMLDocument

java.lang.Object
  jas.engine.ProjectDocument
      jas.engine.ProjectXMLDocument

public class ProjectXMLDocument
extends ProjectDocument

Implementation of the ProjectDocument abstract class. All project properties are stored in a file using XML 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

static java.lang.String	TAG_ATTR_MODEL_NAME XML model class name tag.
static java.lang.String	TAG_ATTR_RANDOM_SEED XML random seed tag.
static java.lang.String	TAG_ATTR_USE_NAME XML project name tag.
static java.lang.String	TAG_ATTR_WINDOW XML window title tag.
static java.lang.String	TAG_CLASS_PATH XML class path tag.
static java.lang.String	TAG_JAS XML main tag.
static java.lang.String	TAG_JAS_PARAMETERS XML parameters main tag.
static java.lang.String	TAG_MODEL XML model tag.
static java.lang.String	TAG_PATH XML path tag.
static java.lang.String	TAG_PRJ_DESCRIPTION XML project description tag.
static java.lang.String	TAG_REALTIME XML project realtime tag.
static java.lang.String	TAG_SEED XML seed tag.
static java.lang.String	TAG_TIME_UNIT XML time unit tag.
static java.lang.String	TAG_VERSION XML version tag.
static java.lang.String	TAG_WINDOW XML window tag.

Fields inherited from class jas.engine.ProjectDocument

classPath, locationBag, majorVersion, projectDescription, projectFile, projectName, randomSeedGeneration, runningModels, runsInRealTime, seed, timeUnit

Constructor Summary

ProjectXMLDocument(java.io.File projectFile)
Open a project document from the given file.

ProjectXMLDocument(java.lang.String projectName)
New project document constructor.

Method Summary

void	saveDocument() Save document to the projectFile file.

Methods inherited from class jas.engine.ProjectDocument

addLocationBag, executeProject, isCreatable, saveDocument

Methods inherited from class java.lang.Object

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

Field Detail

TAG_ATTR_MODEL_NAME

public static final java.lang.String TAG_ATTR_MODEL_NAME

XML model class name tag.

See Also:

Constant Field Values

TAG_ATTR_RANDOM_SEED

public static final java.lang.String TAG_ATTR_RANDOM_SEED

XML random seed tag.

See Also:

Constant Field Values

TAG_ATTR_USE_NAME

public static final java.lang.String TAG_ATTR_USE_NAME

XML project name tag.

See Also:

Constant Field Values

TAG_ATTR_WINDOW

public static final java.lang.String TAG_ATTR_WINDOW

XML window title tag.

See Also:

Constant Field Values

TAG_CLASS_PATH

public static final java.lang.String TAG_CLASS_PATH

XML class path tag.

See Also:

Constant Field Values

TAG_JAS

public static final java.lang.String TAG_JAS

XML main tag.

See Also:

Constant Field Values

TAG_JAS_PARAMETERS

public static final java.lang.String TAG_JAS_PARAMETERS

XML parameters main tag.

See Also:

Constant Field Values

TAG_MODEL

public static final java.lang.String TAG_MODEL

XML model tag.

See Also:

Constant Field Values

TAG_PATH

public static final java.lang.String TAG_PATH

XML path tag.

See Also:

Constant Field Values

TAG_PRJ_DESCRIPTION

public static final java.lang.String TAG_PRJ_DESCRIPTION

XML project description tag.

See Also:

Constant Field Values

TAG_REALTIME

public static final java.lang.String TAG_REALTIME

XML project realtime tag.

See Also:

Constant Field Values

TAG_SEED

public static final java.lang.String TAG_SEED

XML seed tag.

See Also:

Constant Field Values

TAG_TIME_UNIT

public static final java.lang.String TAG_TIME_UNIT

XML time unit tag.

See Also:

Constant Field Values

TAG_VERSION

public static final java.lang.String TAG_VERSION

XML version tag.

See Also:

Constant Field Values

TAG_WINDOW

public static final java.lang.String TAG_WINDOW

XML window tag.

See Also:

Constant Field Values

Constructor Detail

ProjectXMLDocument

public ProjectXMLDocument(java.io.File projectFile)

Open a project document from the given file.

Parameters:

projectFile - The XML file containing project parameters.

ProjectXMLDocument

public ProjectXMLDocument(java.lang.String projectName)

New project document constructor.

Parameters:

projectName - The project name.

Method Detail

saveDocument

public void saveDocument()

Save document to the projectFile file.

Specified by:

saveDocument in class ProjectDocument