com.j256.ormlite.dao

Class BaseForeignCollection<T,ID>

java.lang.Object

com.j256.ormlite.dao.BaseForeignCollection<T,ID>

All Implemented Interfaces:

CloseableIterable<T>, ForeignCollection<T>, Serializable, Iterable<T>, Collection<T>

Direct Known Subclasses:

EagerForeignCollection, LazyForeignCollection

public abstract class BaseForeignCollection<T,ID>
extends Object
implements ForeignCollection<T>, Serializable

Base collection that is set on a field that as been marked with the ForeignCollectionField annotation when an object is refreshed or queried (i.e. not created).

WARNING: Most likely for(;;) loops should not be used here since we need to be careful about closing the iterator.

Author:

graywatson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Dao<T,ID>	dao

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseForeignCollection(Dao<T,ID> dao, Object parent, Object parentId, FieldType foreignFieldType, String orderColumn, boolean orderAscending)

Method Summary

Modifier and Type	Method and Description
boolean	add(T data) Adds the object to the collection.
boolean	addAll(Collection<? extends T> collection) Add the collection of elements to this collection.
void	clear() Clears the collection and uses the iterator to run through the dao and delete all of the items in the collection from the associated database table.
Dao<T,?>	getDao() Return the DAO object associated with this foreign collection.
protected PreparedQuery<T>	getPreparedQuery()
int	refresh(T data) This is a call through to Dao.refresh(Object) using the internal collection DAO.
abstract boolean	remove(Object data) Remove the item from the collection and the associated database table.
abstract boolean	removeAll(Collection<?> collection) Remove the items in the collection argument from the foreign collection and the associated database table.
boolean	retainAll(Collection<?> collection) Uses the iterator to run through the dao and retain only the items that are in the passed in collection.
int	update(T data) This is a call through to Dao.update(Object) using the internal collection DAO.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j256.ormlite.dao.ForeignCollection

closeableIterator, closeLastIterator, getWrappedIterable, getWrappedIterable, isEager, iterator, iteratorThrow, iteratorThrow, refreshAll, refreshCollection, updateAll

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeIf, size, spliterator, stream, toArray, toArray

Methods inherited from interface com.j256.ormlite.dao.CloseableIterable

closeableIterator

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

dao

protected final transient Dao<T,ID> dao

Constructor Detail

BaseForeignCollection

protected BaseForeignCollection(Dao<T,ID> dao,
                                Object parent,
                                Object parentId,
                                FieldType foreignFieldType,
                                String orderColumn,
                                boolean orderAscending)

Method Detail

add

public boolean add(T data)

Description copied from interface: ForeignCollection

Adds the object to the collection. This will also add it to the database by calling through to [@link Dao.create(Object). If the object has already been created in the database then you just need to set the foreign field on the object and call Dao.update(Object). If you add it here the DAO will try to create it in the database again which will most likely cause an error.

Specified by:

add in interface ForeignCollection<T>

Specified by:

add in interface Collection<T>

See Also:

Collection.add(Object)

addAll

public boolean addAll(Collection<? extends T> collection)

Add the collection of elements to this collection. This will also them to the associated database table.

Specified by:

addAll in interface Collection<T>

Returns:

Returns true if any of the items did not already exist in the collection otherwise false.

remove

public abstract boolean remove(Object data)

Remove the item from the collection and the associated database table. NOTE: we can't just do a dao.delete(data) because it has to be in the collection.

Specified by:

remove in interface Collection<T>

Returns:

True if the item was found in the collection otherwise false.

removeAll

public abstract boolean removeAll(Collection<?> collection)

Remove the items in the collection argument from the foreign collection and the associated database table. NOTE: we can't just do a for (...) dao.delete(item) because the items have to be in the collection.

Specified by:

removeAll in interface Collection<T>

Returns:

True if the item was found in the collection otherwise false.

retainAll

public boolean retainAll(Collection<?> collection)

Uses the iterator to run through the dao and retain only the items that are in the passed in collection. This will remove the items from the associated database table as well.

Specified by:

retainAll in interface Collection<T>

Returns:

Returns true of the collection was changed at all otherwise false.

clear

public void clear()

Clears the collection and uses the iterator to run through the dao and delete all of the items in the collection from the associated database table. This is different from removing all of the elements in the table since this iterator is across just one item's foreign objects.

Specified by:

clear in interface Collection<T>

update

public int update(T data)
           throws SQLException

Description copied from interface: ForeignCollection

This is a call through to Dao.update(Object) using the internal collection DAO. Objects inside of the collection are not updated if the parent object is refreshed so you will need to so that by hand.

Specified by:

update in interface ForeignCollection<T>

Throws:

SQLException

refresh

public int refresh(T data)
            throws SQLException

Description copied from interface: ForeignCollection

This is a call through to Dao.refresh(Object) using the internal collection DAO. Objects inside of the collection are not refreshed if the parent object is refreshed so you will need to so that by hand.

Specified by:

refresh in interface ForeignCollection<T>

Throws:

SQLException

getDao

public Dao<T,?> getDao()

Description copied from interface: ForeignCollection

Return the DAO object associated with this foreign collection. For usage for those who know what they are doing.

Specified by:

getDao in interface ForeignCollection<T>

getPreparedQuery

protected PreparedQuery<T> getPreparedQuery()
                                     throws SQLException

Throws:

SQLException