Expression (pdb 2.2.2 API)

java.lang.Object
- com.feedzai.commons.sql.abstraction.dml.Expression

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AlterColumn, Between, Coalesce, Delete, DropPrimaryKey, Function, Join, K, Literal, Modulo, Name, Query, Rename, RepeatDelimiter, Truncate, Update, View
```
public abstract class Expression
extends java.lang.Object
implements java.io.Serializable
```
A generic SQL Expression capable of being translated.

Since:

2.0.0

Author:

Rui Vilao (rui.vilao@feedzai.com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`alias` The expression alias if applicable.
`protected boolean`	`enclosed` True if the expression is to be enclosed in parenthesis.
`protected java.util.List<Join>`	`joins` The list of joins, if applicable.
`protected java.lang.String`	`ordering` The string that specified the ordering if applicable.
`protected PdbProperties`	`properties` The PDB properties.
`protected boolean`	`quotes` True if the expression is to be put around quotes.
`protected AbstractTranslator`	`translator` The abstract translator.
`protected boolean`	`withNoLock` The SQL Server's no lock keyword.

Constructor Summary

Constructors
Constructor and Description

Expression()

Constructors
Constructor and Description
`Expression()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Expression`	`alias(java.lang.String alias)` Aliases this expression.
`Expression`	`asc()` Sets ordering to ascendant.
`Expression`	`desc()` Sets ordering to descendant.
`Expression`	`enclose()` Encloses this expression with parenthesis.
`Expression`	`fullOuterJoin(Expression table, Expression expr)` Sets a full outer join with the current table.
`java.lang.String`	`getAlias()` Gets the alias.
`java.util.List<Join>`	`getJoins()` Gets the join list.
`java.lang.String`	`getOrdering()` Gets the ordering.
`Expression`	`innerJoin(Expression table, Expression expr)` Sets an inner join with the current table.
`boolean`	`isAliased()` Checks if this expression is to be aliased.
`boolean`	`isEnclosed()` Checks if this expression is to be enclosed in parenthesis.
`boolean`	`isQuote()` Checks if this expression is to be quoted.
`boolean`	`isQuotes()` Checks if this expression is to be translated with quotes.
`boolean`	`isWithNoLock()` Checks if this expression (TABLES) is with no lock.
`Expression`	`leftOuterJoin(Expression table, Expression expr)` Sets a left outer join with the current table.
`Expression`	`rightOuterJoin(Expression table, Expression expr)` Sets a right outer join with the current table.
`abstract java.lang.String`	`translate()` Translates the expression.
`Expression`	`unquote()` Removes the quotes for this expression.
`Expression`	`withNoLock()` Sets no lock keyword on SQL Server tables.

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

- Field Detail
  - translator
```
@Inject
protected AbstractTranslator translator
```
    The abstract translator.
  - properties
```
@Inject
protected PdbProperties properties
```
    The PDB properties.
  - alias
```
protected java.lang.String alias
```
    The expression alias if applicable.
  - enclosed
```
protected boolean enclosed
```
    True if the expression is to be enclosed in parenthesis.
  - quotes
```
protected boolean quotes
```
    True if the expression is to be put around quotes.
  - ordering
```
protected java.lang.String ordering
```
    The string that specified the ordering if applicable.
  - joins
```
protected final java.util.List<Join> joins
```
    The list of joins, if applicable.
  - withNoLock
```
protected boolean withNoLock
```
    The SQL Server's no lock keyword.
- Constructor Detail
  - Expression
```
public Expression()
```
- Method Detail
  - translate
```
public abstract java.lang.String translate()
```
    Translates the expression.
    
    Returns:
    
    A translation of the implementing expression.
  - alias
```
public Expression alias(java.lang.String alias)
```
    Aliases this expression.
    
    Parameters:
    
    alias - The alias.
    
    Returns:
    
    This expression.
  - unquote
```
public Expression unquote()
```
    Removes the quotes for this expression.
    
    Returns:
    
    This expression.
  - enclose
```
public Expression enclose()
```
    Encloses this expression with parenthesis.
    
    Returns:
    
    This expression.
  - asc
```
public Expression asc()
```
    Sets ordering to ascendant.
    
    Returns:
    
    This expression.
  - desc
```
public Expression desc()
```
    Sets ordering to descendant.
    
    Returns:
    
    This expression.
  - isEnclosed
```
public boolean isEnclosed()
```
    Checks if this expression is to be enclosed in parenthesis.
    
    Returns:
    
    true if this expression is enclosed, false otherwise.
  - isQuote
```
public boolean isQuote()
```
    Checks if this expression is to be quoted.
    
    Returns:
    
    true if this expression is quoted, false otherwise.
  - isAliased
```
public boolean isAliased()
```
    Checks if this expression is to be aliased.
    
    Returns:
    
    true if this expression is aliased, false otherwise.
  - innerJoin
```
public Expression innerJoin(Expression table,
                            Expression expr)
```
    Sets an inner join with the current table.
    
    Parameters:
    
    table - The table to join.
    
    expr - The expressions to join.
    
    Returns:
    
    This expression.
  - leftOuterJoin
```
public Expression leftOuterJoin(Expression table,
                                Expression expr)
```
    Sets a left outer join with the current table.
    
    Parameters:
    
    table - The table to join.
    
    expr - The expressions to join.
    
    Returns:
    
    This expression.
  - rightOuterJoin
```
public Expression rightOuterJoin(Expression table,
                                 Expression expr)
```
    Sets a right outer join with the current table.
    
    Parameters:
    
    table - The table to join.
    
    expr - The expressions to join.
    
    Returns:
    
    This expression.
  - fullOuterJoin
```
public Expression fullOuterJoin(Expression table,
                                Expression expr)
```
    Sets a full outer join with the current table.
    
    Parameters:
    
    table - The table to join.
    
    expr - The expressions to join.
    
    Returns:
    
    This expression.
  - withNoLock
```
public Expression withNoLock()
```
    Sets no lock keyword on SQL Server tables.
    
    Returns:
    
    This expression.
  - isWithNoLock
```
public boolean isWithNoLock()
```
    Checks if this expression (TABLES) is with no lock.
    
    Returns:
    
    true if this expression (TABLE) is with no lock, false otherwise.
  - getJoins
```
public java.util.List<Join> getJoins()
```
    Gets the join list.
    
    Returns:
    
    The join list.
  - getOrdering
```
public java.lang.String getOrdering()
```
    Gets the ordering.
    
    Returns:
    
    The ordering.
  - isQuotes
```
public boolean isQuotes()
```
    Checks if this expression is to be translated with quotes.
    
    Returns:
    
    true if this expression is to be translated with quotes, false otherwise.
  - getAlias
```
public java.lang.String getAlias()
```
    Gets the alias.
    
    Returns:
    
    The alias, null if not applicable.

Class Expression

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

translator

properties

alias

enclosed

quotes

ordering

joins

withNoLock

Constructor Detail

Expression

Method Detail

translate

alias

unquote

enclose

asc

desc

isEnclosed

isQuote

isAliased

innerJoin

leftOuterJoin

rightOuterJoin

fullOuterJoin

withNoLock

isWithNoLock

getJoins

getOrdering

isQuotes

getAlias