nl.inl.blacklab.tools

Class QueryTool

java.lang.Object

nl.inl.blacklab.tools.QueryTool

public class QueryTool
extends Object

Simple command-line querying tool for BlackLab indices.

Field Summary

Fields

Modifier and Type	Field and Description
PrintWriter	err Our error writer (if null, output errors to out as well)
PrintWriter	out Our output writer.

Constructor Summary

Constructors

Constructor and Description
QueryTool(BlackLabIndex index, BufferedReader in, PrintWriter out, PrintWriter err) Construct the query tool object.
QueryTool(File indexDir, BufferedReader in, PrintWriter out, PrintWriter err) Construct the query tool object.
QueryTool(File indexDir, PrintWriter out, PrintWriter err) Construct the query tool object.

Method Summary

Modifier and Type	Method and Description
void	commandProcessor() Parse and execute commands and queries.
String	describeAnnotation(Annotation annotation)
void	errprintln(String str)
static void	main(String[] args) The main program.
void	outprint(String str)
void	outprintf(String str, Object... args)
void	outprintln(String str)
void	processCommand(String fullCmd)
static void	runBatch(File indexDir, File commandFile) Run the QueryTool in batch mode
static void	runBatch(File indexDir, File commandFile, String encoding) Run the QueryTool in batch mode
static void	runInteractive(File indexDir) Run the QueryTool in interactive mode
static void	runInteractive(File indexDir, String encoding) Run the QueryTool in interactive mode
void	setIndex(BlackLabIndex index) Switch to a different index.
void	statprintln(String str)

Methods inherited from class java.lang.Object

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

Field Detail

out

public PrintWriter out

Our output writer.

err

public PrintWriter err

Our error writer (if null, output errors to out as well)

Constructor Detail

QueryTool

public QueryTool(BlackLabIndex index,
                 BufferedReader in,
                 PrintWriter out,
                 PrintWriter err)
          throws org.apache.lucene.index.CorruptIndexException

Construct the query tool object.

Parameters:

index - the index object (our index)

in - where to read commands from

out - where to write output to

err - where to write errors to

Throws:

org.apache.lucene.index.CorruptIndexException

QueryTool

public QueryTool(File indexDir,
                 BufferedReader in,
                 PrintWriter out,
                 PrintWriter err)
          throws ErrorOpeningIndex

Construct the query tool object.

Parameters:

indexDir - directory our index is in

in - where to read commands from

out - where to write output to

err - where to write errors to

Throws:

ErrorOpeningIndex - if we couldn't open the index

QueryTool

public QueryTool(File indexDir,
                 PrintWriter out,
                 PrintWriter err)
          throws ErrorOpeningIndex

Construct the query tool object.

Parameters:

indexDir - directory our index is in

out - the output writer to use

err - where to write errors to

Throws:

ErrorOpeningIndex - if index could not be opened

Method Detail

main

public static void main(String[] args)
                 throws ErrorOpeningIndex

The main program.

Parameters:

args - commandline arguments

Throws:

ErrorOpeningIndex - if index could not be opened

runBatch

public static void runBatch(File indexDir,
                            File commandFile,
                            String encoding)
                     throws ErrorOpeningIndex

Run the QueryTool in batch mode

Parameters:

indexDir - the index to search

commandFile - the command file to execute

encoding - the output encoding

Throws:

ErrorOpeningIndex - if index could not be opened

runBatch

public static void runBatch(File indexDir,
                            File commandFile)
                     throws ErrorOpeningIndex

Run the QueryTool in batch mode

Parameters:

indexDir - the index to search

commandFile - the command file to execute

Throws:

ErrorOpeningIndex

runInteractive

public static void runInteractive(File indexDir,
                                  String encoding)
                           throws ErrorOpeningIndex

Run the QueryTool in interactive mode

Parameters:

indexDir - the index to search

encoding - the output encoding

Throws:

ErrorOpeningIndex - if index could not be opened

runInteractive

public static void runInteractive(File indexDir)
                           throws ErrorOpeningIndex

Run the QueryTool in interactive mode

Parameters:

indexDir - the index to search

Throws:

ErrorOpeningIndex - if index could not be opened

setIndex

public void setIndex(BlackLabIndex index)

Switch to a different index.

Parameters:

index - the new BlackLabIndex to use

commandProcessor

public void commandProcessor()

Parse and execute commands and queries.

processCommand

public void processCommand(String fullCmd)

describeAnnotation

public String describeAnnotation(Annotation annotation)

outprintln

public void outprintln(String str)

outprint

public void outprint(String str)

outprintf

public void outprintf(String str,
                      Object... args)

errprintln

public void errprintln(String str)

statprintln

public void statprintln(String str)