com.healthmarketscience.sqlbuilder

Class SqlObjectList<ObjType extends SqlObject>

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

com.healthmarketscience.sqlbuilder.SqlObjectList<ObjType>

All Implemented Interfaces:

Appendee, Iterable<ObjType>

public class SqlObjectList<ObjType extends SqlObject>
extends SqlObject
implements Iterable<ObjType>

Maintains a list of SqlObjects. Outputs each object separated by the given delimiter (defaults to DEFAULT_DELIMITER).

Note that this class is generally intended to be used internally by the other SqlObjects.

The default list item separator used by this framework is a simple ",". This is generally sufficient for interacting with most databases. That said, sometimes it is desirable to have the more readable separator of ", ". This can be enabled by setting the system property "com.healthmarketscience.sqlbuilder.useSpaceAfterDelimiter" to true.

Author:

James Ahlborn

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DELIMITER the default delimiter used by a SqlObjectList
static String	USE_SPACE_AFTER_DELIMITER_PROPERTY

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors

Constructor and Description
SqlObjectList()
SqlObjectList(String delimiter)
SqlObjectList(String delimiter, List<ObjType> objects)

Method Summary

Modifier and Type	Method and Description
SqlObjectList<ObjType>	addObject(ObjType obj) Adds the given object to the list
<SrcType,DstType extends ObjType> SqlObjectList<ObjType>	addObjects(Converter<SrcType,DstType> converter, Iterable<? extends SrcType> objs) Adds the given objects to the list after converting each of them using the given converter.
<SrcType,DstType extends ObjType> SqlObjectList<ObjType>	addObjects(Converter<SrcType,DstType> converter, SrcType... objs) Adds the given objects to the list after converting each of them using the given converter.
SqlObjectList<ObjType>	addObjects(Iterable<? extends ObjType> objs) Adds the given objects to the list
SqlObjectList<ObjType>	addObjects(ObjType... objs) Adds the given objects to the list
void	appendTo(AppendableExt app) Appends this object to the given AppendableExt.
void	clear() Removes all objects from the list.
protected void	collectSchemaObjects(ValidationContext vContext) Used during Query.validate() calls to collect the dbschema objects referenced in a query.
static <ObjType extends SqlObject> SqlObjectList<ObjType>	create() Constructs and returns a new SqlObjectList, conveniently allows construction without respecifying generic param type.
static <ObjType extends SqlObject> SqlObjectList<ObjType>	create(String delimiter) Constructs and returns a new SqlObjectList, conveniently allows construction without respecifying generic param type.
ObjType	get(int index) Returns the object at the specified index.
String	getDelimiter()
boolean	isEmpty()
Iterator<ObjType>	iterator()
ListIterator<ObjType>	listIterator()
int	size()

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

USE_SPACE_AFTER_DELIMITER_PROPERTY

public static final String USE_SPACE_AFTER_DELIMITER_PROPERTY

See Also:

Constant Field Values

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

the default delimiter used by a SqlObjectList

Constructor Detail

SqlObjectList

public SqlObjectList()

SqlObjectList

public SqlObjectList(String delimiter)

SqlObjectList

public SqlObjectList(String delimiter,
                     List<ObjType> objects)

Method Detail

create

public static <ObjType extends SqlObject> SqlObjectList<ObjType> create()

Constructs and returns a new SqlObjectList, conveniently allows construction without respecifying generic param type.

Returns:

a new SqlObjectList with the default delimiter

create

public static <ObjType extends SqlObject> SqlObjectList<ObjType> create(String delimiter)

Constructs and returns a new SqlObjectList, conveniently allows construction without respecifying generic param type.

Parameters:

delimiter - to use when appending the list

Returns:

a new SqlObjectList with the given delimiter

getDelimiter

public String getDelimiter()

size

public int size()

Returns:

the number of objects in the list

isEmpty

public boolean isEmpty()

Returns:

true if there are no objects in the list, false otherwise.

clear

public void clear()

Removes all objects from the list.

get

public ObjType get(int index)

Returns the object at the specified index.

iterator

public Iterator<ObjType> iterator()

Specified by:

iterator in interface Iterable<ObjType extends SqlObject>

Returns:

a mutable Iterator over the objects in the list

listIterator

public ListIterator<ObjType> listIterator()

Returns:

a mutable ListIterator over the objects in the list

addObject

public SqlObjectList<ObjType> addObject(ObjType obj)

Adds the given object to the list

Parameters:

obj - the object to be added

addObjects

public SqlObjectList<ObjType> addObjects(ObjType... objs)

Adds the given objects to the list

Parameters:

objs - the objects to be added, no-op if null

addObjects

public SqlObjectList<ObjType> addObjects(Iterable<? extends ObjType> objs)

Adds the given objects to the list

Parameters:

objs - the objects to be added, no-op if null

addObjects

public <SrcType,DstType extends ObjType> SqlObjectList<ObjType> addObjects(Converter<SrcType,DstType> converter,
                                                                           SrcType... objs)

Adds the given objects to the list after converting each of them using the given converter.

Parameters:

converter - Converter which generates the actual objects to be added from the given objects

objs - the objects to be added, no-op if null

addObjects

public <SrcType,DstType extends ObjType> SqlObjectList<ObjType> addObjects(Converter<SrcType,DstType> converter,
                                                                           Iterable<? extends SrcType> objs)

Adds the given objects to the list after converting each of them using the given converter.

Parameters:

converter - Converter which generates the actual objects to be added from the given objects

objs - the objects to be added, no-op if null

collectSchemaObjects

protected void collectSchemaObjects(ValidationContext vContext)

Description copied from class: SqlObject

Used during Query.validate() calls to collect the dbschema objects referenced in a query. Any subclass of this class should add all referenced tables and columns to the appropriate collections.

Specified by:

collectSchemaObjects in class SqlObject

Parameters:

vContext - handle to the current validation context

appendTo

public 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 AppendeeObject

Parameters:

app - the AppendableExt to which this class should append itself

Throws:

IOException - if the append fails