org.apache.calcite.sql.pretty

Class SqlFormatOptions

java.lang.Object

org.apache.calcite.sql.pretty.SqlFormatOptions

public class SqlFormatOptions
extends java.lang.Object

Data structure to hold options for SqlPrettyWriter.setFormatOptions(SqlFormatOptions).

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	alwaysUseParentheses
private boolean	caseClausesOnNewLines
private boolean	clauseStartsLine
private int	indentation
private boolean	keywordsLowercase
private int	lineLength
private boolean	quoteAllIdentifiers
private boolean	selectListItemsOnSeparateLines
private boolean	whereListItemsOnSeparateLines
private boolean	windowDeclarationStartsLine
private boolean	windowListItemsOnSeparateLines

Constructor Summary

Constructors

Constructor and Description
SqlFormatOptions() Constructs a set of default SQL format options.
SqlFormatOptions(boolean alwaysUseParentheses, boolean caseClausesOnNewLines, boolean clauseStartsLine, boolean keywordsLowercase, boolean quoteAllIdentifiers, boolean selectListItemsOnSeparateLines, boolean whereListItemsOnSeparateLines, boolean windowDeclarationStartsLine, boolean windowListItemsOnSeparateLines, int indentation, int lineLength) Constructs a complete set of SQL format options.

Method Summary

Modifier and Type	Method and Description
int	getIndentation()
int	getLineLength()
boolean	isAlwaysUseParentheses()
boolean	isCaseClausesOnNewLines()
boolean	isClauseStartsLine()
boolean	isKeywordsLowercase()
boolean	isQuoteAllIdentifiers()
boolean	isSelectListItemsOnSeparateLines()
boolean	isWhereListItemsOnSeparateLines()
boolean	isWindowDeclarationStartsLine()
boolean	isWindowListItemsOnSeparateLines()
void	setAlwaysUseParentheses(boolean alwaysUseParentheses)
void	setCaseClausesOnNewLines(boolean caseClausesOnNewLines)
void	setClauseStartsLine(boolean clauseStartsLine)
void	setIndentation(int indentation)
void	setKeywordsLowercase(boolean keywordsLowercase)
void	setLineLength(int lineLength)
void	setQuoteAllIdentifiers(boolean quoteAllIdentifiers)
void	setSelectListItemsOnSeparateLines(boolean selectListItemsOnSeparateLines)
void	setWhereListItemsOnSeparateLines(boolean whereListItemsOnSeparateLines)
void	setWindowDeclarationStartsLine(boolean windowDeclarationStartsLine)
void	setWindowListItemsOnSeparateLines(boolean windowListItemsOnSeparateLines)

Methods inherited from class java.lang.Object

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

Field Detail

alwaysUseParentheses

private boolean alwaysUseParentheses

caseClausesOnNewLines

private boolean caseClausesOnNewLines

clauseStartsLine

private boolean clauseStartsLine

keywordsLowercase

private boolean keywordsLowercase

quoteAllIdentifiers

private boolean quoteAllIdentifiers

selectListItemsOnSeparateLines

private boolean selectListItemsOnSeparateLines

whereListItemsOnSeparateLines

private boolean whereListItemsOnSeparateLines

windowDeclarationStartsLine

private boolean windowDeclarationStartsLine

windowListItemsOnSeparateLines

private boolean windowListItemsOnSeparateLines

indentation

private int indentation

lineLength

private int lineLength

Constructor Detail

SqlFormatOptions

public SqlFormatOptions()

Constructs a set of default SQL format options.

SqlFormatOptions

public SqlFormatOptions(boolean alwaysUseParentheses,
                        boolean caseClausesOnNewLines,
                        boolean clauseStartsLine,
                        boolean keywordsLowercase,
                        boolean quoteAllIdentifiers,
                        boolean selectListItemsOnSeparateLines,
                        boolean whereListItemsOnSeparateLines,
                        boolean windowDeclarationStartsLine,
                        boolean windowListItemsOnSeparateLines,
                        int indentation,
                        int lineLength)

Constructs a complete set of SQL format options.

Parameters:

alwaysUseParentheses - Always use parentheses

caseClausesOnNewLines - Case clauses on new lines

clauseStartsLine - Clause starts line

keywordsLowercase - Keywords in lower case

quoteAllIdentifiers - Quote all identifiers

selectListItemsOnSeparateLines - Select items on separate lines

whereListItemsOnSeparateLines - Where items on separate lines

windowDeclarationStartsLine - Window declaration starts line

windowListItemsOnSeparateLines - Window list items on separate lines

indentation - Indentation

lineLength - Line length

Method Detail

isAlwaysUseParentheses

public boolean isAlwaysUseParentheses()

setAlwaysUseParentheses

public void setAlwaysUseParentheses(boolean alwaysUseParentheses)

isCaseClausesOnNewLines

public boolean isCaseClausesOnNewLines()

setCaseClausesOnNewLines

public void setCaseClausesOnNewLines(boolean caseClausesOnNewLines)

isClauseStartsLine

public boolean isClauseStartsLine()

setClauseStartsLine

public void setClauseStartsLine(boolean clauseStartsLine)

isKeywordsLowercase

public boolean isKeywordsLowercase()

setKeywordsLowercase

public void setKeywordsLowercase(boolean keywordsLowercase)

isQuoteAllIdentifiers

public boolean isQuoteAllIdentifiers()

setQuoteAllIdentifiers

public void setQuoteAllIdentifiers(boolean quoteAllIdentifiers)

isSelectListItemsOnSeparateLines

public boolean isSelectListItemsOnSeparateLines()

setSelectListItemsOnSeparateLines

public void setSelectListItemsOnSeparateLines(boolean selectListItemsOnSeparateLines)

isWhereListItemsOnSeparateLines

public boolean isWhereListItemsOnSeparateLines()

setWhereListItemsOnSeparateLines

public void setWhereListItemsOnSeparateLines(boolean whereListItemsOnSeparateLines)

isWindowDeclarationStartsLine

public boolean isWindowDeclarationStartsLine()

setWindowDeclarationStartsLine

public void setWindowDeclarationStartsLine(boolean windowDeclarationStartsLine)

isWindowListItemsOnSeparateLines

public boolean isWindowListItemsOnSeparateLines()

setWindowListItemsOnSeparateLines

public void setWindowListItemsOnSeparateLines(boolean windowListItemsOnSeparateLines)

getLineLength

public int getLineLength()

setLineLength

public void setLineLength(int lineLength)

getIndentation

public int getIndentation()

setIndentation

public void setIndentation(int indentation)