com.healthmarketscience.sqlbuilder

Class QueryPreparer.ListPlaceHolder

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

com.healthmarketscience.sqlbuilder.QueryPreparer.PlaceHolder

com.healthmarketscience.sqlbuilder.QueryPreparer.ListPlaceHolder

All Implemented Interfaces:

Appendee

Enclosing class:

QueryPreparer

public static class QueryPreparer.ListPlaceHolder
extends QueryPreparer.PlaceHolder

A SqlObject which outputs 0 or more '?' separated by commas, and records the current indexes at the times the appendTo method is called. This enables the user to set parameters correctly in a PreparedStatement where the position is not known at query creation time. Note: a ListPlaceHolder may not be used in more than one place in the query unless all the underlying PlaceHolders are instances of QueryPreparer.MultiPlaceHolder.

Field Summary

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors

Constructor and Description
ListPlaceHolder(QueryPreparer outer)

Method Summary

Modifier and Type	Method and Description
QueryPreparer.MultiPlaceHolder	addNewMultiPlaceHolder() Adds a new MultiPlaceHolder to this list and returns it.
QueryPreparer.PlaceHolder	addNewPlaceHolder() Adds a new PlaceHolder to this list and returns it.
QueryPreparer.ListPlaceHolder	addPlaceHolders(int size) Adds the given number of PlaceHolders to this list.
QueryPreparer.ListPlaceHolder	addStaticBooleans(boolean... values) Adds StaticPlaceHolders for the given boolean values.
QueryPreparer.ListPlaceHolder	addStaticBooleans(Iterable<? extends Boolean> values) Adds StaticPlaceHolders for the given Boolean values.
QueryPreparer.ListPlaceHolder	addStaticIntegers(int... values) Adds StaticPlaceHolders for the given int values.
QueryPreparer.ListPlaceHolder	addStaticIntegers(Iterable<? extends Integer> values) Adds StaticPlaceHolders for the given Integer values.
QueryPreparer.ListPlaceHolder	addStaticLongs(Iterable<? extends Long> values) Adds StaticPlaceHolders for the given Long values.
QueryPreparer.ListPlaceHolder	addStaticLongs(long... values) Adds StaticPlaceHolders for the given long values.
QueryPreparer.ListPlaceHolder	addStaticObjects(int sqlType, Iterable<?> values) Adds StaticPlaceHolders for the given Object values and given sql type.
QueryPreparer.ListPlaceHolder	addStaticObjects(int sqlType, Object... values) Adds StaticPlaceHolders for the given Object values and given sql type.
QueryPreparer.ListPlaceHolder	addStaticObjects(Iterable<?> values) Adds StaticPlaceHolders for the given Object values.
QueryPreparer.ListPlaceHolder	addStaticObjects(Object... values) Adds StaticPlaceHolders for the given Object values.
QueryPreparer.StaticPlaceHolder	addStaticPlaceHolder(QueryPreparer.StaticPlaceHolder ph) Adds the given StaticPlaceHolder to this list and returns it.
QueryPreparer.ListPlaceHolder	addStaticStrings(Iterable<? extends String> values) Adds StaticPlaceHolders for the given String values.
QueryPreparer.ListPlaceHolder	addStaticStrings(String... values) Adds StaticPlaceHolders for the given String values.
void	appendTo(AppendableExt app) Appends this object to the given AppendableExt.
int	getIndex() Returns the 1-based index of this PlaceHolder in the query.
List<Integer>	getIndexes()
boolean	isInQuery() Returns true if this PlaceHolder was used in the query, false otherwise.
void	setBooleans(PreparedStatement ps, boolean... values) Calls setBoolean on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setBooleans(PreparedStatement ps, Iterable<? extends Boolean> values) Calls setBoolean on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setInts(PreparedStatement ps, int... values) Calls setInt on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setInts(PreparedStatement ps, Iterable<? extends Integer> values) Calls setInt on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setLongs(PreparedStatement ps, Iterable<? extends Long> values) Calls setLong on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setLongs(PreparedStatement ps, long... values) Calls setLong on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setNulls(int sqlType, PreparedStatement ps) Calls setNull on the given PreparedStatement with the given sql type for the positions of this PlaceHolder.
void	setObjects(int sqlType, PreparedStatement ps, Iterable<?> values) Calls setObject on the given PreparedStatement with the given value and the given sql type for the position of this PlaceHolder.
void	setObjects(int sqlType, PreparedStatement ps, Object... values) Calls setObject on the given PreparedStatement with the given values and the given sql type for the positions of this PlaceHolder.
void	setObjects(PreparedStatement ps, Iterable<?> values) Calls setObject on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setObjects(PreparedStatement ps, Object... values) Calls setObject on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setStrings(PreparedStatement ps, Iterable<? extends String> values) Calls setString on the given PreparedStatement with the given values for the positions of this PlaceHolder.
void	setStrings(PreparedStatement ps, String... values) Calls setString on the given PreparedStatement with the given values for the positions of this PlaceHolder.

Methods inherited from class com.healthmarketscience.sqlbuilder.QueryPreparer.PlaceHolder

addIndex, collectSchemaObjects, getOuter, setBoolean, setBoolean, setInt, setInt, setLong, setLong, setNonNullObject, setNonNullString, setNull, setObject, setObject, setString

Methods inherited from class com.healthmarketscience.sqlbuilder.SqlObject

collectSchemaObjects, doValidate, toString

Methods inherited from class com.healthmarketscience.common.util.AppendeeObject

toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPlaceHolder

public ListPlaceHolder(QueryPreparer outer)

Method Detail

isInQuery

public boolean isInQuery()

Description copied from class: QueryPreparer.PlaceHolder

Returns true if this PlaceHolder was used in the query, false otherwise.

Overrides:

isInQuery in class QueryPreparer.PlaceHolder

getIndex

public int getIndex()

Returns the 1-based index of this PlaceHolder in the query.

Note, this method should generally not be used for ListPlaceHolders as they usually have more than one index, however if there is at most one index, this method will behave like the parent class.

Overrides:

getIndex in class QueryPreparer.PlaceHolder

Returns:

1-based index of this PlaceHolder if the query has been generated, -1 otherwise

Throws:

UnsupportedOperationException - if this method is called and there is more than one index

getIndexes

public List<Integer> getIndexes()

Overrides:

getIndexes in class QueryPreparer.PlaceHolder

addNewPlaceHolder

public QueryPreparer.PlaceHolder addNewPlaceHolder()

Adds a new PlaceHolder to this list and returns it.

addNewMultiPlaceHolder

public QueryPreparer.MultiPlaceHolder addNewMultiPlaceHolder()

Adds a new MultiPlaceHolder to this list and returns it.

addStaticPlaceHolder

public QueryPreparer.StaticPlaceHolder addStaticPlaceHolder(QueryPreparer.StaticPlaceHolder ph)

Adds the given StaticPlaceHolder to this list and returns it.

addPlaceHolders

public QueryPreparer.ListPlaceHolder addPlaceHolders(int size)

Adds the given number of PlaceHolders to this list.

addStaticStrings

public QueryPreparer.ListPlaceHolder addStaticStrings(String... values)

Adds StaticPlaceHolders for the given String values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticStrings

public QueryPreparer.ListPlaceHolder addStaticStrings(Iterable<? extends String> values)

Adds StaticPlaceHolders for the given String values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticLongs

public QueryPreparer.ListPlaceHolder addStaticLongs(long... values)

Adds StaticPlaceHolders for the given long values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticLongs

public QueryPreparer.ListPlaceHolder addStaticLongs(Iterable<? extends Long> values)

Adds StaticPlaceHolders for the given Long values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticIntegers

public QueryPreparer.ListPlaceHolder addStaticIntegers(int... values)

Adds StaticPlaceHolders for the given int values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticIntegers

public QueryPreparer.ListPlaceHolder addStaticIntegers(Iterable<? extends Integer> values)

Adds StaticPlaceHolders for the given Integer values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticBooleans

public QueryPreparer.ListPlaceHolder addStaticBooleans(boolean... values)

Adds StaticPlaceHolders for the given boolean values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticBooleans

public QueryPreparer.ListPlaceHolder addStaticBooleans(Iterable<? extends Boolean> values)

Adds StaticPlaceHolders for the given Boolean values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticObjects

public QueryPreparer.ListPlaceHolder addStaticObjects(Object... values)

Adds StaticPlaceHolders for the given Object values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticObjects

public QueryPreparer.ListPlaceHolder addStaticObjects(Iterable<?> values)

Adds StaticPlaceHolders for the given Object values.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticObjects

public QueryPreparer.ListPlaceHolder addStaticObjects(int sqlType,
                                                      Object... values)

Adds StaticPlaceHolders for the given Object values and given sql type.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

addStaticObjects

public QueryPreparer.ListPlaceHolder addStaticObjects(int sqlType,
                                                      Iterable<?> values)

Adds StaticPlaceHolders for the given Object values and given sql type.

See Also:

QueryPreparer.setStaticValues(java.sql.PreparedStatement)

setNulls

public void setNulls(int sqlType,
                     PreparedStatement ps)
              throws SQLException

Calls setNull on the given PreparedStatement with the given sql type for the positions of this PlaceHolder.

Throws:

SQLException

setInts

public void setInts(PreparedStatement ps,
                    int... values)
             throws SQLException

Calls setInt on the given PreparedStatement with the given values for the positions of this PlaceHolder.

Throws:

SQLException

setInts

public void setInts(PreparedStatement ps,
                    Iterable<? extends Integer> values)
             throws SQLException

Calls setInt on the given PreparedStatement with the given values for the positions of this PlaceHolder. If given value is null, calls setNull with the sql type INTEGER.

Throws:

SQLException

setLongs

public void setLongs(PreparedStatement ps,
                     long... values)
              throws SQLException

Calls setLong on the given PreparedStatement with the given values for the positions of this PlaceHolder.

Throws:

SQLException

setLongs

public void setLongs(PreparedStatement ps,
                     Iterable<? extends Long> values)
              throws SQLException

Calls setLong on the given PreparedStatement with the given values for the positions of this PlaceHolder. If given value is null, calls setNull with the sql type BIGINT.

Throws:

SQLException

setBooleans

public void setBooleans(PreparedStatement ps,
                        boolean... values)
                 throws SQLException

Calls setBoolean on the given PreparedStatement with the given values for the positions of this PlaceHolder.

Throws:

SQLException

setBooleans

public void setBooleans(PreparedStatement ps,
                        Iterable<? extends Boolean> values)
                 throws SQLException

Calls setBoolean on the given PreparedStatement with the given values for the positions of this PlaceHolder. If given value is null, calls setNull with the sql type BOOLEAN.

Throws:

SQLException

setStrings

public void setStrings(PreparedStatement ps,
                       String... values)
                throws SQLException

Calls setString on the given PreparedStatement with the given values for the positions of this PlaceHolder. If given value is null, calls setNull with the sql type VARCHAR.

Throws:

SQLException

setStrings

public void setStrings(PreparedStatement ps,
                       Iterable<? extends String> values)
                throws SQLException

Calls setString on the given PreparedStatement with the given values for the positions of this PlaceHolder. If given value is null, calls setNull with the sql type VARCHAR.

Throws:

SQLException

setObjects

public void setObjects(PreparedStatement ps,
                       Object... values)
                throws SQLException

Calls setObject on the given PreparedStatement with the given values for the positions of this PlaceHolder. Note, calling this method with a null value may or may not work, depending on the JDBC driver. The only reliable (across all JDBC drivers) way to set a null object is to call setObjects(int,PreparedStatement,Object...) with the correct SQL type.

Throws:

SQLException

setObjects

public void setObjects(PreparedStatement ps,
                       Iterable<?> values)
                throws SQLException

Calls setObject on the given PreparedStatement with the given values for the positions of this PlaceHolder. Note, calling this method with a null value may or may not work, depending on the JDBC driver. The only reliable (across all JDBC drivers) way to set a null object is to call setObjects(int,PreparedStatement,Iterable) with the correct SQL type.

Throws:

SQLException

setObjects

public void setObjects(int sqlType,
                       PreparedStatement ps,
                       Object... values)
                throws SQLException

Calls setObject on the given PreparedStatement with the given values and the given sql type for the positions of this PlaceHolder.

Throws:

SQLException

setObjects

public void setObjects(int sqlType,
                       PreparedStatement ps,
                       Iterable<?> values)
                throws SQLException

Calls setObject on the given PreparedStatement with the given value and the given sql type for the position of this PlaceHolder. If given value is null, calls setNull with the given sql type.

Throws:

SQLException

appendTo

public final void appendTo(AppendableExt app)
                    throws IOException

Description copied from interface: Appendee

Appends this object to the given AppendableExt. Called by an AppendableExt when a request is made to append an instance of Appendee.

Specified by:

appendTo in interface Appendee

Overrides:

appendTo in class QueryPreparer.PlaceHolder

Parameters:

app - the AppendableExt to which this class should append itself

Throws:

IOException - if the append fails