public interface CleanUp
The CleanUp interface defines the methods that can be used to search for and retrieve information about HiRISE products that can be cleaned from the file system. Once such products are found, this interface can be used to cleanly remove and/or archive these products, depending on the specifics of the classes that implement this interface.
Generally speaking the clean up procedure entails searching for products that are able to be removed as a result of newer versions of these products being publicly released. Once the set of removable products has been determined, the products can be selected passed to the Clean_Up_Products() methods to remove and archive the products and any associated database records.
Modifier and Type | Field and Description |
---|---|
static int |
ABSOLUTE_MAXIMUM_ORBIT_NUMBER
Default orbit search parameters for the gui
|
static java.lang.String |
ANAGLYPH
Supported Product Types
|
static int |
DEFAULT_MAXIMUM_ORBIT_NUMBER
Default orbit search parameters for the gui
|
static int |
DEFAULT_MINIMUM_ORBIT_NUMBER
Default orbit search parameters for the gui
|
static java.lang.String |
EDR
Supported Product Types
|
static java.lang.String |
EDR_EXTRAS
Supported Product Types
|
static java.lang.String |
ID
Class identifier
|
static java.lang.String |
IDLE_STATUS_MESSAGE
Search status property names and values.
|
static java.lang.String |
INDEX_TABLE_UPDATE_PROPERTY_NAME
Additional status properties that may be fired by the cleanup classes.
|
static int |
MAXIMUM_UPDATES_BEFORE_COMMIT
The classes that implement this interface are expected to run their database
updates as transactions.
|
static java.lang.String |
OLD_VERSION_ID_ALIAS
Column aliases used to make the columns consistent across the different
clean up procedures
|
static java.lang.String |
PREPARE_STATUS_PROPERTY_NAME
Additional status properties that may be fired by the cleanup classes.
|
static java.lang.String |
PREPARE_STATUS_ROW_PROPERTY_NAME
Additional status properties that may be fired by the cleanup classes.
|
static java.lang.String |
RDR
Supported Product Types
|
static java.lang.String |
RDR_EXTRAS
Supported Product Types
|
static java.lang.String |
RELEASED_VERSION_ID_ALIAS
Column aliases used to make the columns consistent across the different
clean up procedures
|
static java.lang.String |
REMOVAL_STATUS_COUNT_PROPERTY_NAME
Properties that indicate the number of products removed, and the current
product being processed.
|
static java.lang.String |
REMOVING_PRODUCT_PROPERTY_NAME
Properties that indicate the number of products removed, and the current
product being processed.
|
static java.lang.String |
SEARCH_STATUS_COMPILING_DATA
Search status property names and values.
|
static java.lang.String |
SEARCH_STATUS_COMPLETE
Search status property names and values.
|
static java.lang.String |
SEARCH_STATUS_CONSTRUCT
Search status property names and values.
|
static java.lang.String |
SEARCH_STATUS_EXECUTE
Search status property names and values.
|
static java.lang.String |
SEARCH_STATUS_PROPERTY_NAME
Search status property names and values.
|
static java.lang.String |
SEARCH_STATUS_START
Search status property names and values.
|
static java.util.HashMap<java.lang.String,java.lang.Integer> |
Status_Hash |
Modifier and Type | Method and Description |
---|---|
void |
Clean_Up_Products(java.util.Vector<Product> products)
This method performs the clean up operation on a list of products.
|
java.util.Vector<java.lang.String> |
Column_Names()
Retrieve the list of "column" names retrieved during the Find_Products()
step.
|
void |
Create_Archive_Table()
A convenience method useful during the testing process, as the mysql's
archive engine has a number of limitations that are easier to program into
this method than to deal with manually.
|
void |
Drop_Archive_Table()
Drops the archive table for the product, and allows the archive table to
be recreated using the Create_Archive_Table() method.
|
java.util.Vector<java.util.Vector<java.lang.String>> |
Find_Products(java.lang.String observation_id,
int start_orbit,
int end_orbit)
Search for products available for clean up.
|
Product |
Product_Data(java.lang.String product_id,
java.lang.String version,
java.lang.String type)
Create a Product object for the given product.
|
static final java.lang.String ID
static final java.lang.String EDR
static final java.lang.String RDR
static final java.lang.String EDR_EXTRAS
static final java.lang.String RDR_EXTRAS
static final java.lang.String ANAGLYPH
static final java.util.HashMap<java.lang.String,java.lang.Integer> Status_Hash
static final int DEFAULT_MINIMUM_ORBIT_NUMBER
static final int DEFAULT_MAXIMUM_ORBIT_NUMBER
static final int ABSOLUTE_MAXIMUM_ORBIT_NUMBER
static final java.lang.String SEARCH_STATUS_PROPERTY_NAME
static final java.lang.String SEARCH_STATUS_START
static final java.lang.String SEARCH_STATUS_CONSTRUCT
static final java.lang.String SEARCH_STATUS_EXECUTE
static final java.lang.String SEARCH_STATUS_COMPILING_DATA
static final java.lang.String SEARCH_STATUS_COMPLETE
static final java.lang.String IDLE_STATUS_MESSAGE
static final java.lang.String OLD_VERSION_ID_ALIAS
static final java.lang.String RELEASED_VERSION_ID_ALIAS
static final java.lang.String PREPARE_STATUS_PROPERTY_NAME
static final java.lang.String PREPARE_STATUS_ROW_PROPERTY_NAME
static final java.lang.String INDEX_TABLE_UPDATE_PROPERTY_NAME
static final java.lang.String REMOVAL_STATUS_COUNT_PROPERTY_NAME
static final java.lang.String REMOVING_PRODUCT_PROPERTY_NAME
static final int MAXIMUM_UPDATES_BEFORE_COMMIT
java.util.Vector<java.util.Vector<java.lang.String>> Find_Products(java.lang.String observation_id, int start_orbit, int end_orbit) throws PIRL.Database.Database_Exception
PIRL.Database.Database_Exception
- if a database error occurs during the searchvoid Clean_Up_Products(java.util.Vector<Product> products) throws PIRL.Database.Database_Exception, java.io.IOException
products
- - A vector of products to be removedPIRL.Database.Database_Exception
- if a database error occurrs during the deletion or
archive processjava.io.IOException
- if the file can not be accessed.java.util.Vector<java.lang.String> Column_Names()
Find_Products(String, int, int)
products has not yet been called.Product Product_Data(java.lang.String product_id, java.lang.String version, java.lang.String type) throws PIRL.Database.Database_Exception
product_id
- - the product_id to retrieve information forversion
- - the version of the producttype
- - the type of productPIRL.Database.Database_Exception
- - if an error occurs while retrieving product
information from the database.void Create_Archive_Table() throws PIRL.Database.Database_Exception
PIRL.Database.Database_Exception
- if an sql error or database access problem occurs.void Drop_Archive_Table() throws PIRL.Database.Database_Exception
PIRL.Database.Database_Exception
- if the database operation can not be executed.Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona