ptdb.kernel.bl.search

Class SearchCriteriaManager

java.lang.Object

ptdb.kernel.bl.search.SearchCriteriaManager

public class SearchCriteriaManager
extends java.lang.Object

The business layer class to handle the operations for saving and loading search criteria from the stored file system.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Alek Wang

Pt.AcceptedRating:

red (wenjiaow)

Pt.ProposedRating:

red (wenjiaow)

Constructor Summary

Constructors

Constructor and Description
SearchCriteriaManager()

Method Summary

Modifier and Type	Method and Description
static SearchCriteria	open(java.lang.String searchCriteriaFileName, Configuration configuration) Open the file from the file system, and load the search criteria stored in it.
static boolean	save(SearchCriteria searchCriteria, java.lang.String searchCriteriaFile) Save the search criteria to a file in the XML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchCriteriaManager

public SearchCriteriaManager()

Method Detail

open

public static SearchCriteria open(java.lang.String searchCriteriaFileName,
                                  Configuration configuration)
                           throws SearchCriteriaParseException,
                                  java.io.IOException

Open the file from the file system, and load the search criteria stored in it. Return the loaded search criteria back to the caller.

Parameters:

searchCriteriaFileName - The location and file name of the search criteria to be loaded.

configuration - The configuration of the opening search criteria.

Returns:

The search criteria that contains the information stored in the file to be loaded.

Throws:

SearchCriteriaParseException - Thrown if there is any error during parsing the search criteria file.

java.io.IOException - Thrown if IO errors happened during reading of the search criteria file.

save

public static boolean save(SearchCriteria searchCriteria,
                           java.lang.String searchCriteriaFile)
                    throws IllegalActionException,
                           java.io.IOException

Save the search criteria to a file in the XML format.

Parameters:

searchCriteria - The DTO containing the search criteria to be saved.

searchCriteriaFile - The file path and name where the criteria should be saved.

Returns:

true - if the search criteria is saved successful.
False - if the search criteria is not saved successful.

Throws:

IllegalActionException - Thrown if the passed attributes' values cannot be obtained.

java.io.IOException - Thrown if error happens during writing the search criteria information to the file.