OpenAPI 1.0

com.aquafold.openapi.rdbms.util
Interface AQSqlFormatter


public interface AQSqlFormatter

Utility class which facilitates SQL formatting -- a beautifier.


Method Summary
 String format(String script)
          Beautifies a SQL script.
 void setAlignmentOnJoin(boolean value)
          Defines whether to align the script on JOIN operation.
 void setAlignmentOnOperator(boolean value)
          Defines whether to align the script on operators.
 void setBreakAfterComma(boolean value)
          Defines whether a line break should be inserted after a comma.
 void setBreakAfterKeywords(boolean value)
          Defines whether a line break should be inserted after a keyword.
 void setBreakAfterLogical(boolean value)
          Defines whether a line break should be inserted after a logical operation.
 void setBreakBeforeComma(boolean value)
          Defines whether a line break should be inserted before a comma.
 void setBreakBeforeLogical(boolean value)
          Defines whether a line break should be inserted before a logical operation.
 void setBreakForBrackets(boolean value)
          Defines whether a line break should be inserted after a bracket.
 void setBreakForCaseKeywords(boolean value)
          Defines whether a line break should be inserted before a case keyword.
 void setIndentSpaces(int indent)
          Sets the number of spaces to use in indentation.
 void setLineLength(int length)
          Sets maximum line length for wrapping.
 void setUpperCaseAll(boolean value)
          Specifies whether the entire script should be converted to uppercase.
 void setUpperCaseKeywords(boolean value)
          Defines whether keywords should be converted to upper case.
 void setUpperCaseNonKeywords(boolean value)
          Specifies whether the non SQL keywords in the script should be converted to uppercase.
 void setUseTabIndent(boolean value)
          Defines whether a TAB character should be used for indentation.
 void setWrapLine(boolean value)
          Defines whether to wrap long lines.
 

Method Detail

format

String format(String script)
Beautifies a SQL script.

Parameters:
script - SQL script to re-format.
Returns:
Reformatted script.

setBreakAfterLogical

void setBreakAfterLogical(boolean value)
Defines whether a line break should be inserted after a logical operation.

Parameters:
value -

setBreakAfterKeywords

void setBreakAfterKeywords(boolean value)
Defines whether a line break should be inserted after a keyword.

Parameters:
value -

setBreakBeforeComma

void setBreakBeforeComma(boolean value)
Defines whether a line break should be inserted before a comma.

Parameters:
value -

setBreakAfterComma

void setBreakAfterComma(boolean value)
Defines whether a line break should be inserted after a comma.

Parameters:
value -

setBreakBeforeLogical

void setBreakBeforeLogical(boolean value)
Defines whether a line break should be inserted before a logical operation.

Parameters:
value -

setBreakForBrackets

void setBreakForBrackets(boolean value)
Defines whether a line break should be inserted after a bracket.

Parameters:
value -

setBreakForCaseKeywords

void setBreakForCaseKeywords(boolean value)
Defines whether a line break should be inserted before a case keyword.

Parameters:
value -

setUpperCaseAll

void setUpperCaseAll(boolean value)
Specifies whether the entire script should be converted to uppercase.

Parameters:
value -

setUpperCaseNonKeywords

void setUpperCaseNonKeywords(boolean value)
Specifies whether the non SQL keywords in the script should be converted to uppercase.

Parameters:
value -

setUpperCaseKeywords

void setUpperCaseKeywords(boolean value)
Defines whether keywords should be converted to upper case.

Parameters:
value -

setIndentSpaces

void setIndentSpaces(int indent)
Sets the number of spaces to use in indentation.

Parameters:
indent - Indent value.

setUseTabIndent

void setUseTabIndent(boolean value)
Defines whether a TAB character should be used for indentation.

Parameters:
value -

setAlignmentOnOperator

void setAlignmentOnOperator(boolean value)
Defines whether to align the script on operators.

Parameters:
value -

setAlignmentOnJoin

void setAlignmentOnJoin(boolean value)
Defines whether to align the script on JOIN operation.

Parameters:
value -

setWrapLine

void setWrapLine(boolean value)
Defines whether to wrap long lines.

Parameters:
value -

setLineLength

void setLineLength(int length)
Sets maximum line length for wrapping.

Parameters:
length - New line length.

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.