Pierre Tutorials

Pierre Command Line Application - Advanced Search


Description


Advanced searching allows the end user greater flexibility in what they search on. With simple Search, the fields for querying and returning results are pre-set. With Advanced Search, the end user gets to choose from a list of available fields for both querying and results to be returned.

First use the -showAdvancedSearch command option to get a list of the various query items that are represented. Then use the -createAdvancedTemplate fileName to create a file that will be used in the advanced search. this file must be editted to include both the parts of the various query sections you want and their values. This is done by uncommenting the lines of the parts you want to query on and for meta query fields and results to be returned.

Once this file has been completed as desired, save it. Then use this file in the -advancedQuery fileName option. the results can be sent to a file or the screen and can be rendered in either HTML or text format. Command options for Advanced Seacrh are listed below.


-showAdvancedSearch

describes and advanced search. This will include a collection of record classes that represent queries, a collection of record classes that represent the content of expected results, and any meta query fields that might be used to constrain the results coming back from the data repository.

-createAdvancedTemplate fileName

creates a template file based on the capabilities of an advanced search. The advanced search feature in the Command Line Service is more powerful than the one offered in either the standalone Java application or the web application. The template that is generated under the name "fileName" will contain empty record forms for each of the record lasses that describe queries. The template will also have a subform for filling out meta query field values and another section showing classes to be included in query results. The file generated is put in the same directory as the command. All of these are commented out. To make a query, uncomment the lines you wish to include in the query. Be sure to fill in any legal comparison operator in [[]].

-advancedQuery fileName

executes the advanced query described in the file created by the -createAdvancedTemplate command option

-htmlFormat

formats the results to be HTML

-textFormat

formats the results to be text format

-resultFile fileName

specifies the file to store the results. If no file is specified, the results are displayed on the screen.

-userID userName

specifies the name of the user. This may be required by the data repository.

-help

displays all the commands available for this service with descriptions