org.kepler.objectmanager.library

Class LibraryManager

java.lang.Object

org.kepler.objectmanager.library.LibraryManager

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.TreeExpansionListener

public class LibraryManager
extends java.lang.Object
implements javax.swing.event.TreeExpansionListener

The LibraryManager is used for managing the Actor Library. It maintains an index for increased performance. Any code that adds, updates, or removes items in the library should use the LibraryManager class directly.

Author:

Aaron Schultz

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LIID_LABEL The LIID_LABEL is used as the name of the String Attribute that is attached to Tree Items to keep track of their Library Index ID.

Constructor Summary

Constructors

Constructor and Description
LibraryManager() constructor called from getInstance()

Method Summary

Modifier and Type	Method and Description
void	addKAR(java.io.File karFile) Given the LSID of a KAR that has been successfully cached this method will add all of the contents of that KAR into the Library by first updating the LibIndex and then updating the tree model.
void	addLibraryJTree(javax.swing.JTree ptree) Add a reference to a JTree that is using the Library Tree Model so that it can be updated when the tree model changes.
void	addXML(java.io.File xmlFile) Update the LibIndex and tree model for a XML file.
void	buildEmptyLibrary() Create an empty library.
void	buildLibrary() This method will synchronize the cache with local repositories.
ComponentEntity	createAndAddTreeItem(CompositeEntity parent, LibItem li) Create and add the appropriate type of placeholder object to the parent CompositeEntity that is in the tree model.
void	deleteKAR(java.io.File aKarFile) Remove a KAR file from the Component Library and from the user's Disk.
ComponentEntity	findTreeItem(CompositeEntity parent, int liid) Look only at the children of the given parent to match the given LIID.
ComponentEntity	findTreeItem(int liid) Look in the entire tree and return the ComponentEntity that matches the given LIID.
ComponentEntity	findTreeItemDeep(CompositeEntity parent, int liid) Recurse all children under parent to match the given LIID.
CompositeEntity	getActorLibrary() Get the CompositeEntity version of the library.
LibIndex	getIndex()
static LibraryManager	getInstance() Method for getting an instance of this singleton class.
static int	getLiidFor(ComponentEntity obj) Return the Library Index ID for the given NamedObj or -1 if an ID cannot be found.
java.util.Vector<java.lang.Integer>	getLiidsFor(java.util.Vector<KeplerLSID> lsids) Return the LIIDs for the given set of LSIDs.
LibItem	getPopulatedLibItem(int liid) Populate this LibItem Object from the database using the given Library Index ID.
LibItem	getTreeItemIndexInformation(int liid) Return a populated LibItem for the given liid.
EntityTreeModel	getTreeModel()
EntityTreeModel	getTreeModel(java.io.File filterFile)
void	refreshJTrees() Refresh and redraw any JTrees that the LibraryManager is keeping track of.
void	removeAllFrameTabs(TableauFrame parent)
void	setActorLibraryWorkspace(Workspace ws) Set the workspace for the actor library and regenerate
void	treeCollapsed(javax.swing.event.TreeExpansionEvent event) Called whenever an item in the tree is collapsed.
void	treeExpanded(javax.swing.event.TreeExpansionEvent event) Called whenever an item in the tree is expanded.

Methods inherited from class java.lang.Object

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

Field Detail

LIID_LABEL

public static final java.lang.String LIID_LABEL

The LIID_LABEL is used as the name of the String Attribute that is attached to Tree Items to keep track of their Library Index ID.

See Also:

Constant Field Values

Constructor Detail

LibraryManager

public LibraryManager()

constructor called from getInstance()

Method Detail

getInstance

public static LibraryManager getInstance()

Method for getting an instance of this singleton class.

getLiidFor

public static int getLiidFor(ComponentEntity obj)

Return the Library Index ID for the given NamedObj or -1 if an ID cannot be found.

Parameters:

obj - a NamedObj from the Library tree.

Returns:

int Library Index ID or

addKAR

public void addKAR(java.io.File karFile)
            throws java.sql.SQLException

Given the LSID of a KAR that has been successfully cached this method will add all of the contents of that KAR into the Library by first updating the LibIndex and then updating the tree model.

Parameters:

f -

Throws:

java.sql.SQLException

addXML

public void addXML(java.io.File xmlFile)
            throws java.sql.SQLException

Update the LibIndex and tree model for a XML file.

Parameters:

f -

Throws:

java.sql.SQLException

addLibraryJTree

public void addLibraryJTree(javax.swing.JTree ptree)

Add a reference to a JTree that is using the Library Tree Model so that it can be updated when the tree model changes. Whenever getTreeModel() is used in a gui component, the JTree reference should be added using this method so that it can get refreshed when the library model changes using the refreshJTrees() method.

Parameters:

ptree - The feature to be added to the LibraryComponent attribute

buildEmptyLibrary

public void buildEmptyLibrary()

Create an empty library. When KeplerGraphFrame starts, it initializes ComponentLibraryTab, which in turn requires a library. Building the library with buildLibrary() can take a long time, so this method can be used to open a KeplerGraphFrame quickly.

buildLibrary

public void buildLibrary()

This method will synchronize the cache with local repositories. Then it will rebuild the LibIndex if needed. Then it will generate the Actor Library from the LibIndex. To force the rebuilding of the LibIndex before calling this method call getIndex().clear()

removeAllFrameTabs

public void removeAllFrameTabs(TableauFrame parent)

createAndAddTreeItem

public ComponentEntity createAndAddTreeItem(CompositeEntity parent,
                                            LibItem li)
                                     throws IllegalActionException,
                                            NameDuplicationException,
                                            java.lang.IllegalArgumentException,
                                            java.io.IOException

Create and add the appropriate type of placeholder object to the parent CompositeEntity that is in the tree model. Return the object when finished. Only subtypes of ComponentEntity may be returned. However, the tree item can represent any type of object, depending on what the type is in the LibIndex.

Parameters:

li -

Returns:

Throws:

NameDuplicationException

IllegalActionException

java.io.IOException

java.lang.IllegalArgumentException

deleteKAR

public void deleteKAR(java.io.File aKarFile)

Remove a KAR file from the Component Library and from the user's Disk.

Parameters:

File - aKarFile

findTreeItem

public ComponentEntity findTreeItem(CompositeEntity parent,
                                    int liid)

Look only at the children of the given parent to match the given LIID. Do not recurse the children here, use findTreeItemDeep() for that.

Parameters:

parent -

liid -

Returns:

findTreeItem

public ComponentEntity findTreeItem(int liid)

Look in the entire tree and return the ComponentEntity that matches the given LIID.

Parameters:

liid -

Returns:

findTreeItemDeep

public ComponentEntity findTreeItemDeep(CompositeEntity parent,
                                        int liid)

Recurse all children under parent to match the given LIID.

Parameters:

parent -

liid -

Returns:

getActorLibrary

public CompositeEntity getActorLibrary()

Get the CompositeEntity version of the library.

getIndex

public LibIndex getIndex()

Returns:

LibIndex object that the manager is using

getLiidsFor

public java.util.Vector<java.lang.Integer> getLiidsFor(java.util.Vector<KeplerLSID> lsids)

Return the LIIDs for the given set of LSIDs.

Parameters:

lsids -

Returns:

getTreeItemIndexInformation

public LibItem getTreeItemIndexInformation(int liid)

Return a populated LibItem for the given liid.

Parameters:

liid -

Returns:

LibItem

getTreeModel

public EntityTreeModel getTreeModel()

Returns:

the TreeModel version of the library.

getTreeModel

public EntityTreeModel getTreeModel(java.io.File filterFile)

refreshJTrees

public void refreshJTrees()
                   throws IllegalActionException

Refresh and redraw any JTrees that the LibraryManager is keeping track of.

Throws:

IllegalActionException - Description of the Exception

setActorLibraryWorkspace

public void setActorLibraryWorkspace(Workspace ws)

Set the workspace for the actor library and regenerate

Parameters:

ws -

getPopulatedLibItem

public LibItem getPopulatedLibItem(int liid)
                            throws java.sql.SQLException

Populate this LibItem Object from the database using the given Library Index ID.

Parameters:

liid -

Throws:

java.sql.SQLException

treeExpanded

public void treeExpanded(javax.swing.event.TreeExpansionEvent event)

Called whenever an item in the tree is expanded.

Specified by:

treeExpanded in interface javax.swing.event.TreeExpansionListener

treeCollapsed

public void treeCollapsed(javax.swing.event.TreeExpansionEvent event)

Called whenever an item in the tree is collapsed.

Specified by:

treeCollapsed in interface javax.swing.event.TreeExpansionListener