org.kepler.objectmanager.library

Class LibIndex

java.lang.Object

org.kepler.objectmanager.library.LibIndex

public class LibIndex
extends java.lang.Object

A library index for keeping track of the tree structure in the component library. This class uses preorder tree traversal method in an SQL table to maintain the indexed structure of the component library instead of using XML (as was previously done). This allows for easier control over the ordering of the contents of the tree, faster and more targeted access to the contents of the library using SQL queries (and some simple math), and it also introduces a very useful new Identifier for the contents of the tree, the LIID. Two companion tables, LIBRARY_LSIDS and LIBRARY_ATTRIBUTES, are used to store additional metadata about the library contents. The LIBRARY_LSIDS table serves to track the existence of multiple LSIDs for one single Component in the library. This is necessary for handling revision management and the user will be allowed to toggle which LSID the component is currently associated with, without destroying the look of the component library tree. The LIBRARY_ATTRIBUTES table is used for storing single string values that are associated with component library items. For example, a KAR item can have the location of that KAR on disk stored as an attribute of the library index item.

Author:

Aaron Schultz

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATT_CLASSNAME
static java.lang.String	ATT_FOLDER
static java.lang.String	ATT_KARENTRYPATH
static java.lang.String	ATT_KARFILE
static java.lang.String	ATT_REPOPATH Attribute names that are used to keep information about Library nodes.
static java.lang.String	ATT_XMLFILE
static java.lang.String	LIBRARY_ATTRIBUTES_TABLE_NAME the name of the table in the database used to store attributes
static java.lang.String	LIBRARY_INDEX_TABLE_NAME the name of the table in the database
static java.lang.String	LIBRARY_LSIDS_TABLE_NAME the name of the table in the database used to store attributes
static int	TYPE_COMPONENT Map of integers for the different types of objects that are stored in the LIBRARY_INDEX table.
static int	TYPE_CONCEPT
static int	TYPE_FOLDER
static int	TYPE_KAR
static int	TYPE_KAR_ERROR
static int	TYPE_KARFOLDER
static int	TYPE_LOCALREPO
static int	TYPE_NAMED_OBJ
static int	TYPE_OBJECT
static int	TYPE_ONTOLOGY

Constructor Summary

Constructors

Constructor and Description
LibIndex(java.sql.Connection conn) A constructor that is given a connection to the database.

Method Summary

Modifier and Type	Method and Description
void	addToSearchIndex(LibItem li) Add the given LibItem to the search index.
LibItem	assureKarEntry(KARCacheContent content) Assures that the LibIndex row under the folder hierarchy exists for the given KARCacheContent.
java.util.Vector<LibItem>	assureOntologyComponent(KARCacheContent content) Assures that the LibIndex rows for the KARCacheContent object exist under the Ontology tree.
LibItem	assureXML(java.io.File file)
int	checkIfDuplicate(LibItem li) Take a LibItem and check to see if there is already an entry in the sql table for it depending on the type,name,and parent.
int	childExists(java.lang.Integer parentLiid, java.lang.String childName) Return true if there is a child of the parent in the index with the given name.
void	clear() Delete all rows in the LIBRARY_INDEX table.
int	countItems() Count how many rows there are in the LIBRARY_INDEX table.
int	determineLibIndexType(KARCacheContent content) Determine the appropriate LibIndex type of the given KARCacheContent
LibItem	findKar(java.io.File karFile)
LibItem	findXML(java.io.File file)
java.util.Vector<LibItem>	getItems() Get all of the items.
java.util.Vector<LibItem>	getItemsOfType(int type) Get all items of the given type.
java.util.Vector<LibItem>	getItemsOfType(int type, int root) Return items of the given type that are somewhere under the given root.
java.util.Vector<LibItem>	getPath(LibItem li) Returns a Vector of LibItems that are the parents of the given LibItem.
LibSearch	getSearcher()
boolean	isOrderedInsert() Return the current value of orderedInsert.
void	rebuild() Completely delete the library index and recreate it from the contents of cached KARs.
boolean	removeItem(int liid) Remove all data from the index database that is associated with the given Library Index ID and all of the data of it's children.
boolean	removeItem(LibItem li) Remove all data from the index database that is associated with the given Library Item (using the Library Index ID) and all of the data of it's children.
java.util.Vector<java.lang.Integer>	removeItemsByLsid(KeplerLSID lsidToRemove) This method will remove the given LSID from being associated with any of the Library Items.
void	setOrderedInsert(boolean orderedInsert) In general orderedInsert should always be true.
void	updateDefaultLsid(int liid, KeplerLSID lsid) Update the default LSID for the given LIID to the given LSID.
boolean	verifyPreorderValues() Sum the LFT and RGT columns and verify they are continuous integers from 1 to (countItems()*2).

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_INDEX_TABLE_NAME

public static final java.lang.String LIBRARY_INDEX_TABLE_NAME

the name of the table in the database

See Also:

Constant Field Values

LIBRARY_LSIDS_TABLE_NAME

public static final java.lang.String LIBRARY_LSIDS_TABLE_NAME

the name of the table in the database used to store attributes

See Also:

Constant Field Values

LIBRARY_ATTRIBUTES_TABLE_NAME

public static final java.lang.String LIBRARY_ATTRIBUTES_TABLE_NAME

the name of the table in the database used to store attributes

See Also:

Constant Field Values

TYPE_COMPONENT

public static final int TYPE_COMPONENT

Map of integers for the different types of objects that are stored in the LIBRARY_INDEX table. To add a new type to the tree you must do a few things. Add a new static integer here. Modify LibraryManager.getTreeItem to handle the new type. Add methods to this class for recognizing the type in KAR files.

See Also:

Constant Field Values

TYPE_NAMED_OBJ

public static final int TYPE_NAMED_OBJ

See Also:

Constant Field Values

TYPE_ONTOLOGY

public static final int TYPE_ONTOLOGY

See Also:

Constant Field Values

TYPE_CONCEPT

public static final int TYPE_CONCEPT

See Also:

Constant Field Values

TYPE_FOLDER

public static final int TYPE_FOLDER

See Also:

Constant Field Values

TYPE_LOCALREPO

public static final int TYPE_LOCALREPO

See Also:

Constant Field Values

TYPE_KAR

public static final int TYPE_KAR

See Also:

Constant Field Values

TYPE_KAR_ERROR

public static final int TYPE_KAR_ERROR

See Also:

Constant Field Values

TYPE_KARFOLDER

public static final int TYPE_KARFOLDER

See Also:

Constant Field Values

TYPE_OBJECT

public static final int TYPE_OBJECT

See Also:

Constant Field Values

ATT_REPOPATH

public static final java.lang.String ATT_REPOPATH

Attribute names that are used to keep information about Library nodes.

See Also:

Constant Field Values

ATT_FOLDER

public static final java.lang.String ATT_FOLDER

See Also:

Constant Field Values

ATT_KARENTRYPATH

public static final java.lang.String ATT_KARENTRYPATH

See Also:

Constant Field Values

ATT_KARFILE

public static final java.lang.String ATT_KARFILE

See Also:

Constant Field Values

ATT_XMLFILE

public static final java.lang.String ATT_XMLFILE

See Also:

Constant Field Values

ATT_CLASSNAME

public static final java.lang.String ATT_CLASSNAME

See Also:

Constant Field Values

Constructor Detail

LibIndex

public LibIndex(java.sql.Connection conn)

A constructor that is given a connection to the database.

Parameters:

conn -

Method Detail

isOrderedInsert

public boolean isOrderedInsert()

Return the current value of orderedInsert. A value of false means that items inserted will not be automatically ordered during insert.

Returns:

setOrderedInsert

public void setOrderedInsert(boolean orderedInsert)

In general orderedInsert should always be true. When inserting many rows however it is faster to not order the entire table dynamically on every insert but to wait until all the rows have been inserted and then update the ordering based on parent relationships using the refreshPreorderValues method. This method allows you to toggle ordering during insert to on (true) or off (false).

Parameters:

orderedInsert -

clear

public void clear()

Delete all rows in the LIBRARY_INDEX table. This will also delete all rows in the LIBRARY_ATTRIBUTES table by cascading foreign key deletes.

rebuild

public void rebuild()

Completely delete the library index and recreate it from the contents of cached KARs.

updateDefaultLsid

public void updateDefaultLsid(int liid,
                              KeplerLSID lsid)
                       throws java.sql.SQLException

Update the default LSID for the given LIID to the given LSID.

Parameters:

liid -

lsid -

Throws:

java.sql.SQLException

removeItem

public boolean removeItem(int liid)

Remove all data from the index database that is associated with the given Library Index ID and all of the data of it's children.

Parameters:

liid -

Returns:

removeItem

public boolean removeItem(LibItem li)

Remove all data from the index database that is associated with the given Library Item (using the Library Index ID) and all of the data of it's children. This method is the same as removeItem(int liid). It is here for convenience.

Parameters:

li -

Returns:

removeItemsByLsid

public java.util.Vector<java.lang.Integer> removeItemsByLsid(KeplerLSID lsidToRemove)
                                                      throws java.sql.SQLException

This method will remove the given LSID from being associated with any of the Library Items. If there is another LSID associated with the given item then it will be assigned as the default. If the Library Item is only associated with the given LSID then the Item itself will be removed.

Parameters:

lsid -

Returns:

Vector all LIIDs that got removed

Throws:

java.sql.SQLException

assureKarEntry

public LibItem assureKarEntry(KARCacheContent content)
                       throws java.sql.SQLException

Assures that the LibIndex row under the folder hierarchy exists for the given KARCacheContent. This method shouldn't really be used. It is only public so the LibraryManager.addKar() method can use it.

Parameters:

content -

Throws:

java.sql.SQLException

determineLibIndexType

public int determineLibIndexType(KARCacheContent content)

Determine the appropriate LibIndex type of the given KARCacheContent

Parameters:

kcc -

Returns:

assureOntologyComponent

public java.util.Vector<LibItem> assureOntologyComponent(KARCacheContent content)

Assures that the LibIndex rows for the KARCacheContent object exist under the Ontology tree. This method shouldn't really be used. It is only public so the LibraryManager.addKar() method can use it.

Parameters:

content -

countItems

public int countItems()

Count how many rows there are in the LIBRARY_INDEX table.

Returns:

getPath

public java.util.Vector<LibItem> getPath(LibItem li)
                                  throws java.sql.SQLException

Returns a Vector of LibItems that are the parents of the given LibItem.

Parameters:

li -

Returns:

Vector representing all parents of the given LibItem

Throws:

java.sql.SQLException

getItems

public java.util.Vector<LibItem> getItems()

Get all of the items.

Returns:

getItemsOfType

public java.util.Vector<LibItem> getItemsOfType(int type)

Get all items of the given type.

Parameters:

type -

Returns:

getItemsOfType

public java.util.Vector<LibItem> getItemsOfType(int type,
                                                int root)

Return items of the given type that are somewhere under the given root.

Parameters:

type -

root -

Returns:

checkIfDuplicate

public int checkIfDuplicate(LibItem li)
                     throws java.sql.SQLException

Take a LibItem and check to see if there is already an entry in the sql table for it depending on the type,name,and parent. If there is already an item in the table, return the LIID for the existing item.

Parameters:

li -

Returns:

long LIID of existing item or -1 if no duplicate is found

Throws:

java.sql.SQLException

addToSearchIndex

public void addToSearchIndex(LibItem li)
                      throws java.sql.SQLException

Add the given LibItem to the search index. If the OrderedInsert flag is set to true then all of the parents of this LibItem will be add to the search index for this item.

Parameters:

li -

Throws:

java.sql.SQLException

getSearcher

public LibSearch getSearcher()

verifyPreorderValues

public boolean verifyPreorderValues()
                             throws java.sql.SQLException

Sum the LFT and RGT columns and verify they are continuous integers from 1 to (countItems()*2). This function should always return true after finishing sql transactions for insert, update, or delete.

Returns:

true if the LFT and RGT columns of the table add up

Throws:

java.sql.SQLException

findKar

public LibItem findKar(java.io.File karFile)
                throws java.sql.SQLException

Parameters:

karFile -

Returns:

LibItem that represents the given KAR File or null if the given KAR File does not correspond to an entry in the Library Index.

Throws:

java.sql.SQLException

findXML

public LibItem findXML(java.io.File file)
                throws java.sql.SQLException

Parameters:

file -

Returns:

LibItem that represents the given XML File or null if the given XML File does not correspond to an entry in the Library Index.

Throws:

java.sql.SQLException

assureXML

public LibItem assureXML(java.io.File file)

Parameters:

kc -

Returns:

childExists

public int childExists(java.lang.Integer parentLiid,
                       java.lang.String childName)

Return true if there is a child of the parent in the index with the given name.

Parameters:

parentLiid -

childName -

Returns: