Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)

com.lapetus_ltd.api.db.control
Class TLptsFactoryProject

java.lang.Object
  extended by com.lapetus_ltd.api.db.control.TLptsFactoryProject

public final class TLptsFactoryProject
extends java.lang.Object

Class Description : The class responsible for loading and saving project files.

The project files contain the XLptsProjectType xml type.

$LastChangedRevision: 1197 $
$LastChangedDate:: 2010-11-22 10:06:06#$


Method Summary
static void addProjectListener(ILptsFactoryProjectListener projectListener)
           Add a listener that implements ILptsFactoryProjectListener in the list.
static TLptsDBProjectType getCurrentSettingsAsProject()
           Gets the current settings of the system (connections and statements) and puts them into a TLptsDBProjectType.
static TLptsDBProjectType loadProject(java.lang.String fileName)
           Load a project giving the full path name.
static void removeProjectListener(ILptsFactoryProjectListener projectListener)
           Remove a listener that implements ILptsFactoryProjectListener from list.
static void saveProject(java.lang.String fileName, XLptsDBProjectType project)
           Saves a project to file.
static void zI()
          Obfuscated, as it is not required by the application.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addProjectListener

public static void addProjectListener(ILptsFactoryProjectListener projectListener)

Add a listener that implements ILptsFactoryProjectListener in the list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : N/A

Notes :

Example :

 

public class MyApp { public MyApp() { ... TLptsFactoryProject.addProjectListener(listener = new ProjectListener());

TLptsDBProjectType pt = TLptsFactoryProject.getCurrentSettingsAsProject(); TLptsFactoryProject.saveProject(TLptsFileUtil.createDirectoryPath(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/")+"test.project.load.xml",pt);

TLptsFactoryConnection.removeConnection(connection,true); // get rid of all statements for the connection.

TLptsFactoryProject.loadProject(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/test.project.load.xml");

TLptsFactoryProject.removeProjectListener(listener); }

private class ProjectListener implements ILptsFactoryProjectListener { public void projectSaveStart(String fileName,XLptsDBProjectType project) { } public void projectSaveComplete(String fileName,XLptsDBProjectType project, boolean isSaved) { } public void projectLoadStarting() { } public void projectLoadComplete(XLptsDBProjectType projectType) { System.out.println("Project has loaded."); // TLptsFactoryConnection and TLptsFactoryStatement have connections and statements of the loaded project. } } }

Parameters:
projectListener - is the listener to add.

getCurrentSettingsAsProject

public static TLptsDBProjectType getCurrentSettingsAsProject()

Gets the current settings of the system (connections and statements) and puts them into a TLptsDBProjectType.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : No, emply data in the worst case.

Notes : Use this to save a project to file.

Example :

 

TLptsDBProjectType pt = TLptsFactoryProject.getCurrentSettingsAsProject(); TLptsFactoryProject.saveProject(TLptsFileUtil.createDirectoryPath(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/")+ "test.project.load.xml",pt);

Returns:
Returns a type TLptsDBProjectType with all the current connections, statements and driver information.

loadProject

public static TLptsDBProjectType loadProject(java.lang.String fileName)

Load a project giving the full path name.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : N/A

Notes : The project load process does not remove any connections, nor statement.
It is the responsibility of the application to remove all connections and statement (if required) before loading the project.
The connections and statements in the project are added to the connection and statement factory lists.

Example :

 

public class MyApp { public MyApp() { ... TLptsFactoryProject.addProjectListener(listener = new ProjectListener());

TLptsDBProjectType pt = TLptsFactoryProject.getCurrentSettingsAsProject(); TLptsFactoryProject.saveProject(TLptsFileUtil.createDirectoryPath(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/")+"test.project.load.xml",pt);

TLptsFactoryConnection.removeConnection(connection,true); // get rid of all statements for the connection.

TLptsFactoryProject.loadProject(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/test.project.load.xml");

TLptsFactoryProject.removeProjectListener(listener); }

private class ProjectListener implements ILptsFactoryProjectListener { public void projectSaveStart(String fileName,XLptsDBProjectType project) { } public void projectSaveComplete(String fileName,XLptsDBProjectType project,boolean isSaved) { } public void projectLoadStarting() { } public void projectLoadComplete(XLptsDBProjectType projectType) { System.out.println("Project Loaded."); } } }

Parameters:
fileName - is the full path name of the project to be loaded
Returns:
the project type

removeProjectListener

public static void removeProjectListener(ILptsFactoryProjectListener projectListener)

Remove a listener that implements ILptsFactoryProjectListener from list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : N/A

Notes :

Example :

 

public class MyApp { public MyApp() { ... TLptsFactoryProject.addProjectListener(listener = new ProjectListener());

TLptsDBProjectType pt = TLptsFactoryProject.getCurrentSettingsAsProject(); TLptsFactoryProject.saveProject(TLptsFileUtil.createDirectoryPath(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/")+"test.project.load.xml",pt);

TLptsFactoryConnection.removeConnection(connection,true); // get rid of all statements for the connection.

TLptsFactoryProject.loadProject(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/test.project.load.xml");

TLptsFactoryProject.removeProjectListener(listener); }

private class ProjectListener implements ILptsFactoryProjectListener { public void projectSaveStart(String fileName,XLptsDBProjectType project) { } public void projectSaveComplete(String fileName,XLptsDBProjectType project,boolean isSaved) { } public void projectLoadStarting() { } public void projectLoadComplete(XLptsDBProjectType projectType) { System.out.println("Project Loaded."); } } }

Parameters:
projectListener - is the listener to remove from list.

saveProject

public static void saveProject(java.lang.String fileName,
                               XLptsDBProjectType project)

Saves a project to file.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : No

Notes : As shown below, the most logical project to save is the current situation of the connections and statements.

Example :

 

TLptsDBProjectType pt = TLptsFactoryProject.getCurrentSettingsAsProject(); TLptsFactoryProject.saveProject(TLptsFileUtil.createDirectoryPath(TLptsFileUtil.getUserHomeLapetusDirectory()+"test/")+ "test.project.load.xml",pt);

Parameters:
fileName - is the full path name of the project.
project - is the xml project type to save.

zI

public static void zI()
Obfuscated, as it is not required by the application.



Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)