com.datastax.oss.dsbulk.format.statement

Class StatementPrinterBase<S extends Statement<S>>

java.lang.Object

com.datastax.oss.dsbulk.format.statement.StatementPrinterBase<S>

All Implemented Interfaces:

StatementPrinter<S>

Direct Known Subclasses:

BoundStatementPrinter, DefaultStatementPrinter, SimpleStatementPrinter

public abstract class StatementPrinterBase<S extends Statement<S>>
extends Object
implements StatementPrinter<S>

A common parent class for StatementPrinter implementations.

This class assumes a common formatting pattern comprised of the following sections:

1. Header: this section should contain two subsections:
   1. The actual statement class and the statement's hash code;
   2. The statement "summary"; examples of typical information that could be included here are: the statement's consistency level; its default timestamp; its idempotence flag; the number of bound values; etc.
2. Query String: this section should print the statement's query string, if it is available; this section is only enabled if the verbosity is NORMAL or higher;
3. Bound Values: this section should print the statement's bound values, if available; this section is only enabled if the verbosity is EXTENDED;
4. Footer: an optional section, empty by default.

Constructor Summary

Constructors

Constructor and Description
StatementPrinterBase()

Method Summary

Modifier and Type	Method and Description
protected List<String>	collectStatementProperties(S statement, StatementWriter out, StatementFormatVerbosity verbosity)
abstract Class<? extends S>	getSupportedStatementClass() The concrete Statement subclass that this printer handles.
void	print(S statement, StatementWriter out, StatementFormatVerbosity verbosity) Prints the given statement, using the given statement writer and the given verbosity level.
protected void	printBoundValues(S statement, StatementWriter out, StatementFormatVerbosity verbosity)
protected void	printHeader(S statement, StatementWriter out, StatementFormatVerbosity verbosity)
protected void	printQueryString(S statement, StatementWriter out, StatementFormatVerbosity verbosity)

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementPrinterBase

public StatementPrinterBase()

Method Detail

getSupportedStatementClass

public abstract Class<? extends S> getSupportedStatementClass()

Description copied from interface: StatementPrinter

The concrete Statement subclass that this printer handles.

In case of subtype polymorphism, if this printer handles more than one concrete subclass, the most specific common ancestor should be returned here.

Specified by:

getSupportedStatementClass in interface StatementPrinter<S extends Statement<S>>

Returns:

The concrete Statement subclass that this printer handles.

print

public void print(S statement,
                  StatementWriter out,
                  StatementFormatVerbosity verbosity)

Description copied from interface: StatementPrinter

Prints the given statement, using the given statement writer and the given verbosity level.

Specified by:

print in interface StatementPrinter<S extends Statement<S>>

Parameters:

statement - the statement to print

out - the writer to use

verbosity - the verbosity to use

printHeader

protected void printHeader(S statement,
                           StatementWriter out,
                           StatementFormatVerbosity verbosity)

collectStatementProperties

protected List<String> collectStatementProperties(S statement,
                                                  StatementWriter out,
                                                  StatementFormatVerbosity verbosity)

printQueryString

protected void printQueryString(S statement,
                                StatementWriter out,
                                StatementFormatVerbosity verbosity)

printBoundValues

protected void printBoundValues(S statement,
                                StatementWriter out,
                                StatementFormatVerbosity verbosity)