com.screenscraper.datamanager.sql.util

Class SqlLookup

java.lang.Object

com.screenscraper.datamanager.sql.util.SqlLookup

Direct Known Subclasses:

MsSqlLookup

public class SqlLookup
extends java.lang.Object

A class which allows for the programatic construction of an Sql query for looking up data out of a database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlLookup.Distinct
static class	SqlLookup.Order
(package private) class	SqlLookup.WhereContainer

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL
static int	ASC
protected boolean	built
protected java.util.Map<java.lang.String,java.util.List<DataNode>>	constraints
static int	DESC
static int	DISTINCT
static int	DISTINCTROW
protected int	duplicateAction
protected boolean	forUpdate
protected java.lang.String[]	groupBy
protected int	groupDirection
protected int	limit
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	lookups
static int	NO_ORDER
protected int	offset
protected java.util.ArrayList<java.lang.String[]>	order
protected int	orderDirection
protected DmPreparedStatement	ps
protected java.lang.String	quote
protected java.lang.String	schemaName
protected DatabaseSchema	schemas
protected java.util.Set<java.lang.String>	updateColumns

Constructor Summary

Constructors

Constructor and Description
SqlLookup(DatabaseSchema schemas, java.lang.String quote, java.lang.String schemaName) Creates a new SqlLookup

Method Summary

Modifier and Type	Method and Description
void	addConstraint(java.lang.String table, java.util.Map<java.lang.String,?> whereData)
void	addConstraint(java.lang.String table, java.lang.String column, java.lang.Object value) add constraints (where clause) to the query
void	addGroupBy(BasicSchema schema, java.lang.String column) add group by to the query
void	addOrder(BasicSchema schema, java.lang.String column) add order by to the query
void	addSelectColumns(java.lang.String table, java.util.Collection<java.lang.String> selectColumns) add columns you wish to select with the statement
protected void	buildQuery(java.sql.Connection con) build the query
(package private) SqlLookup.WhereContainer	buildWhere()
DmPreparedStatement	getPreparedStatement(java.sql.Connection con) retrieves the completed PreparedStatement.
protected java.lang.String	quoteValue(java.lang.String input)
void	setDuplicateAction(int duplicateAction) set what to do on a duplicate
void	setForUpdate(java.util.Set<java.lang.String> columns)
void	setGroupDirection(int order) set the group direction(ascending or descending)
void	setLimit(int limit) set a limit for the number of rows returned
void	setOffset(int offset) set the offset of the query
void	setOrderDirection(int order) set the order by direction (ascending or descending)

Methods inherited from class java.lang.Object

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

Field Detail

schemaName

@Nullable
protected final java.lang.String schemaName

offset

protected int offset

limit

protected int limit

orderDirection

protected int orderDirection

groupDirection

protected int groupDirection

duplicateAction

protected int duplicateAction

built

protected boolean built

order

protected java.util.ArrayList<java.lang.String[]> order

groupBy

protected java.lang.String[] groupBy

ps

@Nullable
protected DmPreparedStatement ps

constraints

protected java.util.Map<java.lang.String,java.util.List<DataNode>> constraints

lookups

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> lookups

schemas

protected DatabaseSchema schemas

forUpdate

protected boolean forUpdate

updateColumns

protected java.util.Set<java.lang.String> updateColumns

quote

protected final java.lang.String quote

ASC

public static final int ASC

See Also:

Constant Field Values

DESC

public static final int DESC

See Also:

Constant Field Values

NO_ORDER

public static final int NO_ORDER

See Also:

Constant Field Values

ALL

public static final int ALL

See Also:

Constant Field Values

DISTINCT

public static final int DISTINCT

See Also:

Constant Field Values

DISTINCTROW

public static final int DISTINCTROW

See Also:

Constant Field Values

Constructor Detail

SqlLookup

public SqlLookup(DatabaseSchema schemas,
                 java.lang.String quote,
                 @Nullable
                 java.lang.String schemaName)

Creates a new SqlLookup

Parameters:

schemas -

Method Detail

getPreparedStatement

@Nullable
public DmPreparedStatement getPreparedStatement(@NotNull
                                                           java.sql.Connection con)
                                                    throws java.sql.SQLException

retrieves the completed PreparedStatement.

Parameters:

con -

Returns:

DmPreparedStatement for lookup

Throws:

java.sql.SQLException

addSelectColumns

public void addSelectColumns(java.lang.String table,
                             @Nullable
                             java.util.Collection<java.lang.String> selectColumns)

add columns you wish to select with the statement

Parameters:

table -

selectColumns -

addConstraint

public void addConstraint(java.lang.String table,
                          @Nullable
                          java.util.Map<java.lang.String,?> whereData)
                   throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

addConstraint

public void addConstraint(java.lang.String table,
                          java.lang.String column,
                          java.lang.Object value)
                   throws java.io.UnsupportedEncodingException

add constraints (where clause) to the query

Parameters:

table -

column -

value -

Throws:

java.io.UnsupportedEncodingException

addOrder

public void addOrder(@NotNull
                     BasicSchema schema,
                     java.lang.String column)

add order by to the query

Parameters:

schema -

column -

addGroupBy

public void addGroupBy(@NotNull
                       BasicSchema schema,
                       java.lang.String column)

add group by to the query

Parameters:

schema -

column -

setGroupDirection

public void setGroupDirection(int order)

set the group direction(ascending or descending)

Parameters:

order -

setDuplicateAction

public void setDuplicateAction(int duplicateAction)

set what to do on a duplicate

Parameters:

duplicateAction -

setOrderDirection

public void setOrderDirection(int order)

set the order by direction (ascending or descending)

Parameters:

order -

setLimit

public void setLimit(int limit)

set a limit for the number of rows returned

Parameters:

limit -

setOffset

public void setOffset(int offset)

set the offset of the query

Parameters:

offset -

buildQuery

protected void buildQuery(@NotNull
                          java.sql.Connection con)
                   throws java.sql.SQLException

build the query

Parameters:

con -

Throws:

java.sql.SQLException

setForUpdate

public void setForUpdate(java.util.Set<java.lang.String> columns)

quoteValue

@NotNull
protected java.lang.String quoteValue(java.lang.String input)

buildWhere

@NotNull
SqlLookup.WhereContainer buildWhere()