com.feedzai.commons.sql.abstraction.dml.functions

Class SubString

java.lang.Object

com.feedzai.commons.sql.abstraction.dml.Expression

com.feedzai.commons.sql.abstraction.dml.functions.SubString

All Implemented Interfaces:

Serializable

public class SubString
extends Expression

SQL function "SUBSTRING", which returns a string that is a substring of the string in the colum expression.

Author:

José Fidalgo (jose.fidalgo@feedzai.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Expression	column

Fields inherited from class com.feedzai.commons.sql.abstraction.dml.Expression

alias, enclosed, joins, ordering, properties, quotes, translator, withNoLock

Constructor Summary

Constructors

Constructor and Description
SubString(Expression column, Expression start, Expression length) Constructor for a SubString SQL expression, which returns a substring of the string in the colum expression.

Method Summary

Modifier and Type	Method and Description
Expression	getColumn() Returns the column expression for which to obtain a substring.
Expression	getLength() Returns the length of the substring, which is the number of characters to extract from the original string.
Expression	getStart() Returns The start position of the substring in the original string.
String	translate() Translates the expression.

Methods inherited from class com.feedzai.commons.sql.abstraction.dml.Expression

alias, asc, desc, enclose, fullOuterJoin, getAlias, getJoins, getOrdering, innerJoin, isAliased, isEnclosed, isQuote, isQuotes, isWithNoLock, leftOuterJoin, rightOuterJoin, unquote, withNoLock

Methods inherited from class java.lang.Object

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

Field Detail

column

public final Expression column

See Also:

getColumn()

Constructor Detail

SubString

public SubString(Expression column,
                 Expression start,
                 Expression length)

Constructor for a SubString SQL expression, which returns a substring of the string in the colum expression.

Parameters:

column - The column for which to obtain a substring.

start - The start position. The first position in string is 1.

length - The number of characters to extract. Must be a positive number.

Method Detail

getColumn

public Expression getColumn()

Returns the column expression for which to obtain a substring.

Returns:

The column for which to obtain a substring.

getStart

public Expression getStart()

Returns The start position of the substring in the original string. The first position is 1.

Returns:

The start position.

getLength

public Expression getLength()

Returns the length of the substring, which is the number of characters to extract from the original string. Must be a positive number.

Returns:

The number of characters to extract.

translate

public String translate()

Description copied from class: Expression

Translates the expression.

Specified by:

translate in class Expression

Returns:

A translation of the implementing expression.