SqlParserPos (Calcite Core 1.16.0 API)

java.lang.Object
- org.apache.calcite.sql.parser.SqlParserPos

All Implemented Interfaces:

Serializable
```
public class SqlParserPos
extends Object
implements Serializable
```
SqlParserPos represents the position of a parsed token within SQL statement text.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`columnNumber`
`private int`	`endColumnNumber`
`private int`	`endLineNumber`
`private int`	`lineNumber`
`private static com.google.common.base.Function<SqlNode,SqlParserPos>`	`NODE_TO_POS`
`private static long`	`serialVersionUID`
`static SqlParserPos`	`ZERO` SqlParserPos representing line one, character one.

Constructor Summary

Constructors
Constructor and Description
`SqlParserPos(int lineNumber, int columnNumber)` Creates a new parser position.
`SqlParserPos(int startLineNumber, int startColumnNumber, int endLineNumber, int endColumnNumber)` Creates a new parser range.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private boolean`	`endsAfter(SqlParserPos pos)`
`boolean`	`equals(Object o)`
`int`	`getColumnNum()`
`int`	`getEndColumnNum()`
`int`	`getEndLineNum()`
`int`	`getLineNum()`
`int`	`hashCode()`
`boolean`	`overlaps(SqlParserPos pos)`
`SqlParserPos`	`plus(SqlParserPos pos)` Combines this parser position with another to create a position that spans from the first point in the first to the last point in the other.
`SqlParserPos`	`plusAll(Collection<SqlNode> nodeList)` Combines this parser position with a list of positions.
`SqlParserPos`	`plusAll(SqlNode[] nodes)` Combines this parser position with an array of positions to create a position that spans from the first point in the first to the last point in the other.
`boolean`	`startsAt(SqlParserPos pos)`
`private boolean`	`startsBefore(SqlParserPos pos)`
`private static SqlParserPos`	`sum_(List<SqlParserPos> positions)` Combines a list of parser positions to create a position which spans from the beginning of the first to the end of the last.
`static SqlParserPos`	`sum(Iterable<SqlParserPos> poses)` Combines an iterable of parser positions to create a position which spans from the beginning of the first to the end of the last.
`private static SqlParserPos`	`sum(Iterable<SqlParserPos> poses, int line, int column, int endLine, int endColumn)` Computes the parser position which is the sum of an array of parser positions and of a parser position represented by (line, column, endLine, endColumn).
`static SqlParserPos`	`sum(List<? extends SqlNode> nodes)` Combines the parser positions of a list of nodes to create a position which spans from the beginning of the first to the end of the last.
`static SqlParserPos`	`sum(SqlNode[] nodes)` Combines the parser positions of an array of nodes to create a position which spans from the beginning of the first to the end of the last.
`private static Iterable<SqlParserPos>`	`toPos(Iterable<SqlNode> nodes)`
`private static List<SqlParserPos>`	`toPos(SqlNode[] nodes)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final SqlParserPos ZERO
```
    SqlParserPos representing line one, character one. Use this if the node doesn't correspond to a position in piece of SQL text.
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - NODE_TO_POS
```
private static final com.google.common.base.Function<SqlNode,SqlParserPos> NODE_TO_POS
```
  - lineNumber
```
private final int lineNumber
```
  - columnNumber
```
private final int columnNumber
```
  - endLineNumber
```
private final int endLineNumber
```
  - endColumnNumber
```
private final int endColumnNumber
```
- Constructor Detail
  - SqlParserPos
```
public SqlParserPos(int lineNumber,
                    int columnNumber)
```
    Creates a new parser position.
  - SqlParserPos
```
public SqlParserPos(int startLineNumber,
                    int startColumnNumber,
                    int endLineNumber,
                    int endColumnNumber)
```
    Creates a new parser range.
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getLineNum
```
public int getLineNum()
```
    Returns:
    
    1-based starting line number
  - getColumnNum
```
public int getColumnNum()
```
    Returns:
    
    1-based starting column number
  - getEndLineNum
```
public int getEndLineNum()
```
    Returns:
    
    1-based end line number (same as starting line number if the ParserPos is a point, not a range)
  - getEndColumnNum
```
public int getEndColumnNum()
```
    Returns:
    
    1-based end column number (same as starting column number if the ParserPos is a point, not a range)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - plus
```
public SqlParserPos plus(SqlParserPos pos)
```
    Combines this parser position with another to create a position that spans from the first point in the first to the last point in the other.
  - plusAll
```
public SqlParserPos plusAll(SqlNode[] nodes)
```
    Combines this parser position with an array of positions to create a position that spans from the first point in the first to the last point in the other.
  - plusAll
```
public SqlParserPos plusAll(Collection<SqlNode> nodeList)
```
    Combines this parser position with a list of positions.
  - sum
```
public static SqlParserPos sum(SqlNode[] nodes)
```
    Combines the parser positions of an array of nodes to create a position which spans from the beginning of the first to the end of the last.
  - toPos
```
private static List<SqlParserPos> toPos(SqlNode[] nodes)
```
  - toPos
```
private static Iterable<SqlParserPos> toPos(Iterable<SqlNode> nodes)
```
  - sum
```
public static SqlParserPos sum(List<? extends SqlNode> nodes)
```
    Combines the parser positions of a list of nodes to create a position which spans from the beginning of the first to the end of the last.
  - sum
```
public static SqlParserPos sum(Iterable<SqlParserPos> poses)
```
    Combines an iterable of parser positions to create a position which spans from the beginning of the first to the end of the last.
  - sum_
```
private static SqlParserPos sum_(List<SqlParserPos> positions)
```
    Combines a list of parser positions to create a position which spans from the beginning of the first to the end of the last.
  - sum
```
private static SqlParserPos sum(Iterable<SqlParserPos> poses,
                                int line,
                                int column,
                                int endLine,
                                int endColumn)
```
    Computes the parser position which is the sum of an array of parser positions and of a parser position represented by (line, column, endLine, endColumn).
    
    Parameters:
    
    poses - Array of parser positions
    
    line - Start line
    
    column - Start column
    
    endLine - End line
    
    endColumn - End column
    
    Returns:
    
    Sum of parser positions
  - overlaps
```
public boolean overlaps(SqlParserPos pos)
```
  - startsBefore
```
private boolean startsBefore(SqlParserPos pos)
```
  - endsAfter
```
private boolean endsAfter(SqlParserPos pos)
```
  - startsAt
```
public boolean startsAt(SqlParserPos pos)
```

Class SqlParserPos

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

serialVersionUID

NODE_TO_POS

lineNumber

columnNumber

endLineNumber

endColumnNumber

Constructor Detail

SqlParserPos

SqlParserPos

Method Detail

hashCode

equals

getLineNum

getColumnNum

getEndLineNum

getEndColumnNum

toString

plus

plusAll

plusAll

sum

toPos

toPos

sum

sum

sum_

sum

overlaps

startsBefore

endsAfter

startsAt