com.sun.electric.tool.project
Class Project

java.lang.Object
  com.sun.electric.tool.Tool
      com.sun.electric.tool.Listener
          com.sun.electric.tool.project.Project

All Implemented Interfaces:

Changes, java.lang.Comparable

public class Project
extends Listener

This is the Project Management tool.

Field Summary

static int	CHECKEDIN
static int	CHECKEDOUTTOOTHERS
static int	CHECKEDOUTTOYOU
static int	NOTMANAGED
static int	OLDVERSION

Fields inherited from class com.sun.electric.tool.Tool

prefs

Method Summary

void	endBatch(Snapshot oldSnapshot, Snapshot newSnapshot, boolean undoRedo) Handles database changes of a Job.
static java.lang.String	getAuthorizationPassword() Method to tell the authorization password for administering users in Project Management.
static java.lang.String	getCellOwner(Cell cell) Method to get the name of the owner of a Cell.
static int	getCellStatus(Cell cell) Method to return the status of a Cell in Project Management.
static java.lang.String	getCurrentUserName() Method to tell the name of the current user of Project Management.
static java.lang.String	getFactoryCurrentUserName() Method to tell the default name of the current user of Project Management.
static java.lang.String	getFactoryRepositoryLocation() Method to tell the default location of the project management repository.
static Project	getProjectTool() Method to retrieve the singleton associated with the Project tool.
static java.lang.String	getRepositoryLocation() Method to tell the location of the project management repository.
void	init() Method to initialize the Project Management tool.
static boolean	isLibraryManaged(Library lib) Method to tell whether a Library is in the repository.
void	readLibrary(Library lib) Method to announce that a Library has been read.
static void	setAuthorizationPassword(java.lang.String a) Method to set the authorization password for administering users in Project Management.
static void	setCurrentUserName(java.lang.String u) Method to set the name of the current user of Project Management.
static void	setRepositoryLocation(java.lang.String r) Method to set the location of the project management repository.

Methods inherited from class com.sun.electric.tool.Listener

eraseLibrary, examineCell, killObject, modifyArcInst, modifyCell, modifyCellGroup, modifyExport, modifyLibrary, modifyNodeInst, newObject, renameObject, request, slice, startBatch, writeLibrary

Methods inherited from class com.sun.electric.tool.Tool

clearAnalysis, clearBackground, clearFixErrors, clearIncremental, clearOn, clearSynthesis, compareTo, findTool, getIndex, getListeners, getName, getNumTools, getProjectSettings, getTools, initAllTools, isAnalysis, isBackground, isFixErrors, isIncremental, isOn, isSynthesis, setAnalysis, setBackground, setFixErrors, setIncremental, setOn, setSynthesis, setVarInJob, testAll, toString

Methods inherited from class java.lang.Object

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

Field Detail

NOTMANAGED

public static final int NOTMANAGED

See Also:

Constant Field Values

CHECKEDIN

public static final int CHECKEDIN

See Also:

Constant Field Values

CHECKEDOUTTOYOU

public static final int CHECKEDOUTTOYOU

See Also:

Constant Field Values

CHECKEDOUTTOOTHERS

public static final int CHECKEDOUTTOOTHERS

See Also:

Constant Field Values

OLDVERSION

public static final int OLDVERSION

See Also:

Constant Field Values

Method Detail

init

public void init()

Method to initialize the Project Management tool.

Specified by:

init in interface Changes

Overrides:

init in class Tool

getProjectTool

public static Project getProjectTool()

Method to retrieve the singleton associated with the Project tool.

Returns:

the Project tool.

isLibraryManaged

public static boolean isLibraryManaged(Library lib)

Method to tell whether a Library is in the repository.

Parameters:

lib - the Library in quesiton.

Returns:

true if the Library is in the repository, and under the control of Project Management.

getCellStatus

public static int getCellStatus(Cell cell)

Method to return the status of a Cell in Project Management.

Parameters:

cell - the Cell in question.

Returns:

NOTMANAGED: this cell is not in any repository
CHECKEDIN: the cell is checked into the repository and is available for checkout.
CHECKEDOUTTOYOU: the cell is checked out to the currently-logged in user.
CHECKEDOUTTOOTHERS: the cell is checked out to someone else (use "getCellOwner" to find out who).
OLDVERSION: this is an old version of a cell in the repository.

getCellOwner

public static java.lang.String getCellOwner(Cell cell)

Method to get the name of the owner of a Cell.

Parameters:

cell - the Cell in question.

Returns:

the name of the user who owns the Cell. Returns a null string if no owner can be found.

endBatch

public void endBatch(Snapshot oldSnapshot,
                     Snapshot newSnapshot,
                     boolean undoRedo)

Handles database changes of a Job.

Specified by:

endBatch in interface Changes

Specified by:

endBatch in class Listener

Parameters:

oldSnapshot - database snapshot before Job.

undoRedo - true if Job was Undo/Redo job.

newSnapshot - database snapshot after Job and constraint propagation.

readLibrary

public void readLibrary(Library lib)

Method to announce that a Library has been read.

Specified by:

readLibrary in interface Changes

Overrides:

readLibrary in class Listener

Parameters:

lib - the Library that was read.

getCurrentUserName

public static java.lang.String getCurrentUserName()

Method to tell the name of the current user of Project Management. The default is "".

Returns:

the name of the current user of Project Management.

setCurrentUserName

public static void setCurrentUserName(java.lang.String u)

Method to set the name of the current user of Project Management.

Parameters:

u - the name of the current user of Project Management.

getFactoryCurrentUserName

public static java.lang.String getFactoryCurrentUserName()

Method to tell the default name of the current user of Project Management.

Returns:

the default name of the current user of Project Management.

getRepositoryLocation

public static java.lang.String getRepositoryLocation()

Method to tell the location of the project management repository. The default is "".

Returns:

the location of the project management repository.

setRepositoryLocation

public static void setRepositoryLocation(java.lang.String r)

Method to set the location of the project management repository.

Parameters:

r - the location of the project management repository.

getFactoryRepositoryLocation

public static java.lang.String getFactoryRepositoryLocation()

Method to tell the default location of the project management repository.

Returns:

the default location of the project management repository.

getAuthorizationPassword

public static java.lang.String getAuthorizationPassword()

Method to tell the authorization password for administering users in Project Management. The default is "".

Returns:

the authorization password for administering users in Project Management.

setAuthorizationPassword

public static void setAuthorizationPassword(java.lang.String a)

Method to set the authorization password for administering users in Project Management.

Parameters:

a - the authorization password for administering users in Project Management.