Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.acs.damsel.srvr.collection
Class CollectionMgr  view CollectionMgr download CollectionMgr.java

java.lang.Object
  extended byorg.acs.damsel.srvr.collection.CollectionMgr
All Implemented Interfaces:
java.io.Serializable

public class CollectionMgr
extends java.lang.Object
implements java.io.Serializable

Class Name: Collection Manager

Description: This class is a manager that grabs collections from the database and passes them to anyone who reqests them. Also adds, removes and edits collections on the database. Note that this class does not maintain a list of Collections, nor does it deal with Collection objects, it deals with the database directly

Version:
1.0

Field Summary
private  org.acs.damsel.srvr.db.AssetDB assetDB
           
private static org.apache.log4j.Logger log
           
 
Constructor Summary
CollectionMgr()
          Basic constructor
 
Method Summary
 void addAssetToCollection(java.lang.String fileName, java.lang.String collectionName)
          Method to add indicated existing asset to indicated existing collection
 void addCollection(Collection collection)
          Adds the specified collection information to the database Note!! This method does not add all the assets associated with the specified collection, it simply updates the CollectionTable to include all its information
 java.util.Iterator collectionIterator()
           
 java.util.Vector collectionNames()
           
 CollectionView getAllAssetsFromCollection(java.lang.String collectionName)
          This method returns all of the assets associated with a collection specified by collectionName in the form of a CollectionView.
 Collection getCollection(java.lang.String collectionName)
          Builds a Collection by populating all the Collection information from the database and returns the Collection.
 org.acs.damsel.srvr.db.Table getCollectionTable()
          Gets the CollectionTable from the database.
 java.util.Vector getEditableCollections(org.acs.damsel.srvr.user.User user)
          This method will take in a User object and search the database for all possible collections that the user could edit.
 boolean isCollectionPrivate(java.lang.String collectionName)
          Method checks database to discover if the permissions set for the specified collection signal that it is private and returns true if private, false otherwise.
 boolean isInRepository(Collection c)
          Checks for the presence of a collection in the repository.
 void removeCollection(Collection collection)
          Removes the specified collection information from the database's CollectionTable Note!! This method does not remove all the assets associated with the specified collection, it simply updates the CollectionTable to not include all its information
 int size()
           
 int updateCollection(Collection c)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static org.apache.log4j.Logger log

assetDB

private org.acs.damsel.srvr.db.AssetDB assetDB
Constructor Detail

CollectionMgr

public CollectionMgr()
Basic constructor

Method Detail

isInRepository

public boolean isInRepository(Collection c)
Checks for the presence of a collection in the repository.


addCollection

public void addCollection(Collection collection)
                   throws CollectionMgrException
Adds the specified collection information to the database Note!! This method does not add all the assets associated with the specified collection, it simply updates the CollectionTable to include all its information


removeCollection

public void removeCollection(Collection collection)
                      throws CollectionMgrException
Removes the specified collection information from the database's CollectionTable Note!! This method does not remove all the assets associated with the specified collection, it simply updates the CollectionTable to not include all its information


getCollection

public Collection getCollection(java.lang.String collectionName)
Builds a Collection by populating all the Collection information from the database and returns the Collection. Note!! The Collection returned will not contain assets. Rather, it has methods that allow the assets to be pulled from the database.


size

public int size()

collectionIterator

public java.util.Iterator collectionIterator()

collectionNames

public java.util.Vector collectionNames()

getEditableCollections

public java.util.Vector getEditableCollections(org.acs.damsel.srvr.user.User user)
This method will take in a User object and search the database for all possible collections that the user could edit. This will return a Vector of Strings containing collection names of the collections that are editable by the user.


getAllAssetsFromCollection

public CollectionView getAllAssetsFromCollection(java.lang.String collectionName)
                                          throws java.sql.SQLException,
                                                 org.acs.damsel.srvr.schema.SchemaException
This method returns all of the assets associated with a collection specified by collectionName in the form of a CollectionView.


getCollectionTable

public org.acs.damsel.srvr.db.Table getCollectionTable()
Gets the CollectionTable from the database.


updateCollection

public int updateCollection(Collection c)

addAssetToCollection

public void addAssetToCollection(java.lang.String fileName,
                                 java.lang.String collectionName)
                          throws java.sql.SQLException
Method to add indicated existing asset to indicated existing collection


isCollectionPrivate

public boolean isCollectionPrivate(java.lang.String collectionName)
Method checks database to discover if the permissions set for the specified collection signal that it is private and returns true if private, false otherwise.