CodeXCavator Finder

CodeXCavator Finder

• CodeXCavator Finder
  • Searching one or multiple indexes
    • Index directories and index list files
  • User interface

The Finder tool can be used to search one or multiple indexes interactively using a gui.

Searching one or multiple indexes

In order to search an index, you need an index configuration file and the index must have been created by using the [CodeXCavator Indexer] tool.
You can then use the CodeXCavator tool to search the index. Just invoke it from the command line or a batch file and provide the index configuration files as its commandline arguments.

Example:

 CodeXCavator index.xml

This will start the CodeXCavator search user interface and will allow you to search the contents of the index defined by the index.xml configuration file.

You can also specify multiple indexes.

Example:

 CodeXCavator index1.xml index2.xml

This will start the CodeXCavator search user interface and will allow you to search the contents of the indexes defined by the index1.xml and index2.xml configuration files. You can determine which index should be searched by selecting it from the corresponding combobox in the search user interface.

Index directories and index list files

Instead of specifying an index configuration file it's also possible to specify a directory instead. The search tool will then search the directory for files with the .xml extension and interpret them as index configuration files.

As an additional alternative one or multiple index configuration list files can be passed to the search tool.
An index configuration list file is simply a text file, where each line contains the path to an index configuration file. Empty lines will be skipped and lines starting with a dash or a single quote character will be treated as comments and also ignored. You can specify relative or absolute paths. Relative paths are treated as being relative to the list file not the current working directory.

You can mix index configuration files index configuration directories and index configuration lists arbitrarily.

User interface

The search user interface is divided into three main areas:

• Search area:
  The [Search] area is located at the left side of the main window. Here you can enter search phrases, select the index, which should be searched, browse the files contained in the index and specify file type and directory filters.

• Search results area:
  The [Search results] area is located at the bottom right side of the main window. Here all files matching the search phrase are listed.

• File viewer area:
  The [File viewer] area is located at the top right side of the main window. Here all opened source code files are displayed in tabs.

All areas can be resized by using the provided separator bars.

[Home][CodeXCavator Indexer]