org.hps.conditions.cli

Class PrintCommand

java.lang.Object

org.hps.conditions.cli.AbstractCommand

org.hps.conditions.cli.PrintCommand

final class PrintCommand
extends AbstractCommand

This sub-command of the conditions CLI prints conditions conditions table data by run number to the console or optionally writes it to an output file.

Author:

Jeremy McCormick, SLAC

Field Summary

Fields

Modifier and Type	Field and Description
private static char	DELIMITER The field delimiter for print output.
private static Logger	LOGGER Initialize the logger.
(package private) static org.apache.commons.cli.Options	options Defines command options.
private File	outputFile Output file if printing to a file.
private boolean	printHeaders Flag to print out column headers.
private boolean	printIDs Flag to print row IDs.
private PrintStream	ps This is the PrintStream for printing the collections to the console or a file.

Constructor Summary

Constructors

Constructor and Description
PrintCommand() Class constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	execute(String[] arguments) Print out the conditions sets selected by the user's command line arguments.
private void	printCollection(ConditionsObjectCollection<?> collection) Print a single collection.
private void	printCollectionHeader(ConditionsObjectCollection<?> collection) Print the header for a collection.
private void	printCollections(List<ConditionsObjectCollection<?>> collectionList) Print the list of collections.
private void	printColumnNames(TableMetaData tableMetaData) Print the column names for a table.
private void	printConditionsRecords(Set<String> conditionsKeys) Print out the conditions records either to the console or a file (if that option is enabled).

Methods inherited from class org.hps.conditions.cli.AbstractCommand

cleanup, getDescription, getManager, getName, getOptions, parse, printUsage

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

Initialize the logger.

options

static org.apache.commons.cli.Options options

Defines command options.

DELIMITER

private static final char DELIMITER

The field delimiter for print output.

See Also:

Constant Field Values

outputFile

private File outputFile

Output file if printing to a file.

printHeaders

private boolean printHeaders

Flag to print out column headers.

printIDs

private boolean printIDs

Flag to print row IDs.

ps

private PrintStream ps

This is the PrintStream for printing the collections to the console or a file.

Constructor Detail

PrintCommand

PrintCommand()

Class constructor.

Method Detail

execute

final void execute(String[] arguments)

Print out the conditions sets selected by the user's command line arguments.

Specified by:

execute in class AbstractCommand

Parameters:

arguments - the command line arguments

printCollection

private void printCollection(ConditionsObjectCollection<?> collection)

Print a single collection.

Parameters:

collection - the collection to print

printCollectionHeader

private void printCollectionHeader(ConditionsObjectCollection<?> collection)

Print the header for a collection. This is printed to the log rather than the PrintStream.

Parameters:

collection - the collection

printCollections

private void printCollections(List<ConditionsObjectCollection<?>> collectionList)

Print the list of collections.

Parameters:

collectionList - the list of collections

printColumnNames

private void printColumnNames(TableMetaData tableMetaData)

Print the column names for a table.

Parameters:

tableMetaData - the table meta data

printConditionsRecords

private void printConditionsRecords(Set<String> conditionsKeys)

Print out the conditions records either to the console or a file (if that option is enabled).

Parameters:

conditionsKeys - the list of conditions keys (usually same as table names)