BasicSQLStatementFactory (LensKit 3.0-M2)

java.lang.Object
- org.grouplens.lenskit.data.sql.BasicSQLStatementFactory

All Implemented Interfaces:

SQLStatementFactory
```
public class BasicSQLStatementFactory
extends Object
implements SQLStatementFactory
```
Default implementation of the SQL statement factory.

Constructor Summary

Constructors
Constructor and Description

BasicSQLStatementFactory()

Constructors
Constructor and Description
`BasicSQLStatementFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getItemColumn()` Get the name of the item ID column in the rating table.
`String`	`getRatingColumn()` Get the name of the rating column in the rating table.
`String`	`getTableName()` Get the name of the rating table.
`String`	`getTimestampColumn()` Get the name of the timestamp column in the rating table (or `null` if there is no timestamp column).
`String`	`getUserColumn()` Get the name of the user ID column in the rating table.
`String`	`prepareEvents(SortOrder order)` Prepare a statement to satisfy `EventDAO.streamEvents(Class, SortOrder)`.
`String`	`prepareItemEvents()` Prepare a statement to satisfy `ItemEventDAO.getEventsForItem(long)`.
`String`	`prepareItems()` Prepare a statement to satisfy `ItemDAO.getItemIds()`.
`String`	`prepareItemUsers()` Prepare a statement to satisfy `ItemEventDAO.getUsersForItem(long)`.
`String`	`prepareUserEvents()` Prepare a statement to satisfy `UserEventDAO.getEventsForUser(long)`.
`String`	`prepareUsers()` Prepare a statement to satisfy `UserDAO.getUserIds()`.
`protected void`	`rqAddOrder(StringBuilder query, SortOrder order)` Add an ORDER BY clause to a query.
`protected void`	`rqAddSelectFrom(StringBuilder query)` Add the SELECT and FROM clauses to the query.
`protected void`	`rqFinish(StringBuilder query)` Finish a query (append a semicolon).
`void`	`setItemColumn(String col)` Set the name of the item ID column in the rating table.
`void`	`setRatingColumn(String col)` Set the name of the rating column in the rating table.
`void`	`setTableName(String name)` Set the name of the rating table.
`void`	`setTimestampColumn(String col)` Set the name of the timestamp column in the rating table.
`void`	`setUserColumn(String col)` Set the name of the user ID column in the rating table.

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

- Constructor Detail
  - BasicSQLStatementFactory
```
public BasicSQLStatementFactory()
```
- Method Detail
  - getTableName
```
@Nonnull
public String getTableName()
```
    Get the name of the rating table.
    
    Returns:
    
    The rating table name.
  - setTableName
```
public void setTableName(@Nonnull
                         String name)
```
    Set the name of the rating table.
    
    Parameters:
    
    name - The name of the rating table. This table name is used without escaping to build SQL queries, so include whatever escaping or quotations are needed to make the name valid in the backing DBMS in the name here.
  - getUserColumn
```
@Nonnull
public String getUserColumn()
```
    Get the name of the user ID column in the rating table.
    
    Returns:
    
    The user column name.
  - setUserColumn
```
public void setUserColumn(@Nonnull
                          String col)
```
    Set the name of the user ID column in the rating table.
    
    Parameters:
    
    col - The name of the user column. This column name is used without escaping to build SQL queries, so include whatever escaping or quotations are needed to make the name valid in the backing DBMS in the name here.
  - getItemColumn
```
@Nonnull
public String getItemColumn()
```
    Get the name of the item ID column in the rating table.
    
    Returns:
    
    The item column name.
  - setItemColumn
```
public void setItemColumn(@Nonnull
                          String col)
```
    Set the name of the item ID column in the rating table.
    
    Parameters:
    
    col - The name of the item column. This column name is used without escaping to build SQL queries, so include whatever escaping or quotations are needed to make the name valid in the backing DBMS in the name here.
  - getRatingColumn
```
@Nonnull
public String getRatingColumn()
```
    Get the name of the rating column in the rating table.
    
    Returns:
    
    The rating column name.
  - setRatingColumn
```
public void setRatingColumn(@Nonnull
                            String col)
```
    Set the name of the rating column in the rating table.
    
    Parameters:
    
    col - The name of the rating column. This column name is used without escaping to build SQL queries, so include whatever escaping or quotations are needed to make the name valid in the backing DBMS in the name here.
  - getTimestampColumn
```
@Nullable
public String getTimestampColumn()
```
    Get the name of the timestamp column in the rating table (or null if there is no timestamp column).
    
    Returns:
    
    The timestamp column name, or null if no timestamp is used.
  - setTimestampColumn
```
public void setTimestampColumn(@Nullable
                               String col)
```
    Set the name of the timestamp column in the rating table. Set to null if there is no timestamp column.
    
    Parameters:
    
    col - The name of the timestamp column, or null. This column name is used without escaping to build SQL queries, so include whatever escaping or quotations are needed to make the name valid in the backing DBMS in the name here.
  - prepareUsers
```
public String prepareUsers()
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy UserDAO.getUserIds(). Querying the statement should return one column per row containing the numeric user ID.
    
    Specified by:
    
    prepareUsers in interface SQLStatementFactory
    
    Returns:
    
    A string for a sql query containing user ID data.
  - prepareItems
```
public String prepareItems()
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy ItemDAO.getItemIds(). Querying the statement should return one column per row containing the numeric item ID.
    
    Specified by:
    
    prepareItems in interface SQLStatementFactory
    
    Returns:
    
    A string for a sql query containing item ID data.
  - rqAddSelectFrom
```
protected void rqAddSelectFrom(StringBuilder query)
```
    Add the SELECT and FROM clauses to the query.
    
    Parameters:
    
    query - The query accumulator.
  - rqAddOrder
```
protected void rqAddOrder(StringBuilder query,
                          SortOrder order)
```
    Add an ORDER BY clause to a query.
    
    Parameters:
    
    query - The query accumulator
    
    order - The sort order.
  - rqFinish
```
protected void rqFinish(StringBuilder query)
```
    Finish a query (append a semicolon).
    
    Parameters:
    
    query - The query accumulator
  - prepareEvents
```
public String prepareEvents(SortOrder order)
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy EventDAO.streamEvents(Class, SortOrder). Each row should contain three or four columns: the user ID, the item ID, the rating, and (optionally) the timestamp. The timestamp column is allowed to contain NULL values or to be omitted entirely. User, item, and rating columns must be non-null.
    
    Specified by:
    
    prepareEvents in interface SQLStatementFactory
    
    Parameters:
    
    order - The sort order
  - prepareUserEvents
```
public String prepareUserEvents()
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy UserEventDAO.getEventsForUser(long). The returned rows should be as in SQLStatementFactory.prepareEvents(SortOrder), and the prepared statement should take a single parameter for the user ID.
    
    Specified by:
    
    prepareUserEvents in interface SQLStatementFactory
    
    Returns:
    
    A string for a sql query returning user rating data. The ratings must be in timestamp order.
  - prepareItemEvents
```
public String prepareItemEvents()
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy ItemEventDAO.getEventsForItem(long). The returned rows should be as in SQLStatementFactory.prepareEvents(SortOrder), and the prepared statement should take a single parameter for the item ID.
    
    Specified by:
    
    prepareItemEvents in interface SQLStatementFactory
    
    Returns:
    
    A string for a sql query returning item rating data. The ratings must be ordered first by user ID, then by timestamp.
  - prepareItemUsers
```
public String prepareItemUsers()
```
    Description copied from interface: SQLStatementFactory
    
    Prepare a statement to satisfy ItemEventDAO.getUsersForItem(long). The returned rows should each contain a user ID as their only column, and the statement should take a single parameter for the item ID.
    
    Specified by:
    
    prepareItemUsers in interface SQLStatementFactory
    
    Returns:
    
    A string for a sql query returning item rating data. The ratings must be ordered first by user ID, then by timestamp.

Class BasicSQLStatementFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicSQLStatementFactory

Method Detail

getTableName

setTableName

getUserColumn

setUserColumn

getItemColumn

setItemColumn

getRatingColumn

setRatingColumn

getTimestampColumn

setTimestampColumn

prepareUsers

prepareItems

rqAddSelectFrom

rqAddOrder

rqFinish

prepareEvents

prepareUserEvents

prepareItemEvents

prepareItemUsers