Package org.apache.calcite.sql

Interface SqlWriter.Frame

All Known Implementing Classes:

SqlPrettyWriter.FrameImpl

Enclosing interface:

SqlWriter

public static interface SqlWriter.Frame

A Frame is a piece of generated text which shares a common indentation level.

Every frame has a beginning, a series of clauses and separators, and an end. A typical frame is a comma-separated list. It begins with a "(", consists of expressions separated by ",", and ends with a ")".

A select statement is also a kind of frame. The beginning and end are empty strings, but it consists of a sequence of clauses. "SELECT", "FROM", "WHERE" are separators.

A frame is current between a call to one of the SqlWriter.startList(java.lang.String, java.lang.String) methods and the call to SqlWriter.endList(Frame). If other code starts a frame in the meantime, the sub-frame is put onto a stack.