gov.nih.nci.caarray.services.arraydesign
Interface ArrayDesignManager


public interface ArrayDesignManager

Interface to the ArrayDesignManager subsytem. Acquired by using the ArrayDesignManagerFactory.

Author:
ETavela

Method Summary
 void addCompositeSequence(CompositeGroup compositeGroup, CompositeSequence compositeSequence)
          Adds a composite sequence to the given group.
 PhysicalArrayDesign createArrayDesign(ArrayDesignType type, java.lang.String arrayDesignName, java.lang.String currentUsername)
          Creates a new array design.
 void disableConstraintsAndIndexes()
          Disables array design indexes and constraints to enable fast loading of array designs.
 void enableConstraintsAndIndexes()
          Re-enables array design indexes and constraints disabled in disableConstraintsAndIndexes.
 PhysicalArrayDesign getArrayDesign(long arrayDesignId)
          Returns the array design matching the given id.
 PhysicalArrayDesign getArrayDesign(java.lang.String identifier)
          Returns the requested array design.
 java.util.List getArrayDesignsToReload()
          Returns a list of array designs (top-level object only) that require reloading.
 void reloadArrayDesign(ArrayDesignDesc arrayDesign, int timeoutMinutes)
          Reloads design information for the given array design.
 void removeDesignElements(ArrayDesignDesc design, int timeoutMinutes)
          Removes the design elements associated with an array design in preparation for reloading.
 void save(PhysicalArrayDesign arrayDesign)
          Stores the given array design to the database.
 DesignElementRetrievalSettings setEfficientDesignElementRetrieval()
          Changes OJB auto-retrieval for design elements to false for all objects associated with design elements.
 void setNormalDesignElementRetrieval(DesignElementRetrievalSettings originalSettings)
          Restores OJB design element auto-retrieve settings to their original values.
 

Method Detail

getArrayDesign

PhysicalArrayDesign getArrayDesign(java.lang.String identifier)
                                   throws ArrayDesignRetrievalException
Returns the requested array design.

Parameters:
identifier - identifier of the array design.
Returns:
the array design.
Throws:
ArrayDesignRetrievalException

getArrayDesign

PhysicalArrayDesign getArrayDesign(long arrayDesignId)
                                   throws ArrayDesignRetrievalException
Returns the array design matching the given id.

Parameters:
arrayDesignId - id of the array design to retrieve.
Returns:
the array design.
Throws:
ArrayDesignRetrievalException

createArrayDesign

PhysicalArrayDesign createArrayDesign(ArrayDesignType type,
                                      java.lang.String arrayDesignName,
                                      java.lang.String currentUsername)
                                      throws ArrayDesignRetrievalException
Creates a new array design.

Parameters:
type - the type or manufacturer of the array design.
arrayDesignName - the name of the array design.
currentUsername - the username of the current user.
Returns:
the array design.
Throws:
ArrayDesignRetrievalException

reloadArrayDesign

void reloadArrayDesign(ArrayDesignDesc arrayDesign,
                       int timeoutMinutes)
                       throws java.lang.Exception
Reloads design information for the given array design.

Parameters:
arrayDesign -
timeoutMinutes -
Throws:
TransactionException
ArrayDesignDataSourceException
java.lang.Exception

getArrayDesignsToReload

java.util.List getArrayDesignsToReload()
                                       throws ArrayDesignDataSourceException
Returns a list of array designs (top-level object only) that require reloading.

Returns:
Throws:
ArrayDesignDataSourceException

disableConstraintsAndIndexes

void disableConstraintsAndIndexes()
                                  throws java.lang.Exception
Disables array design indexes and constraints to enable fast loading of array designs.

Throws:
ArrayDesignDataSourceException
java.lang.Exception

enableConstraintsAndIndexes

void enableConstraintsAndIndexes()
                                 throws java.lang.Exception
Re-enables array design indexes and constraints disabled in disableConstraintsAndIndexes.

Throws:
ArrayDesignDataSourceException
java.lang.Exception

removeDesignElements

void removeDesignElements(ArrayDesignDesc design,
                          int timeoutMinutes)
                          throws java.lang.Exception
Removes the design elements associated with an array design in preparation for reloading.

Throws:
ArrayDesignDataSourceException
java.lang.Exception

save

void save(PhysicalArrayDesign arrayDesign)
          throws ArrayDesignDataSourceException
Stores the given array design to the database.

Parameters:
arrayDesign -
Throws:
ArrayDesignDataSourceException

setEfficientDesignElementRetrieval

DesignElementRetrievalSettings setEfficientDesignElementRetrieval()
Changes OJB auto-retrieval for design elements to false for all objects associated with design elements.

Returns:
the original settings for later restoration
Throws:
ArrayDesignDataSourceException

setNormalDesignElementRetrieval

void setNormalDesignElementRetrieval(DesignElementRetrievalSettings originalSettings)
Restores OJB design element auto-retrieve settings to their original values.

Parameters:
originalSettings -
Throws:
ArrayDesignDataSourceException

addCompositeSequence

void addCompositeSequence(CompositeGroup compositeGroup,
                          CompositeSequence compositeSequence)
Adds a composite sequence to the given group.

Parameters:
compositeGroup -
compositeSequence -