com.aoindustries.dao

Interface Table<K extends Comparable<? super K>,R extends Row<K,?>>

All Superinterfaces:

Collection<R>, Iterable<R>

public interface Table<K extends Comparable<? super K>,R extends Row<K,?>>
extends Collection<R>

Method Summary

Modifier and Type	Method and Description
default boolean	add(R e)
default boolean	addAll(Collection<? extends R> c)
default K	canonicalize(K key) Gets the canonical key used for internal indexing.
default void	clear()
default void	clearCaches() Clears the caches for this table that apply to the current thread.
default boolean	contains(Object o)
default boolean	containsAll(Collection<?> c)
R	get(K key) Gets the row with the provided key.
default Iterator<? extends R>	getIterator() Iterates the rows in sorted order.
Map<K,? extends R>	getMap() Gets a map view of this table.
Model	getModel() Gets the model this table is part of.
default String	getName() Gets the table name.
default Set<? extends R>	getOrderedRows(Iterable<? extends K> keys) Gets an unmodifiable set of each object corresponding to the set of keys.
SortedSet<? extends R>	getRows() Gets all rows, sorted by their natural ordering.
default SortedSet<? extends R>	getRows(Iterable<? extends K> keys) Gets an unmodifiable sorted set of each object corresponding to the set of keys, sorted by their natural ordering.
default int	getSize() Gets the number of accessible rows in this table.
SortedMap<K,? extends R>	getSortedMap() Gets a sorted map view of this table.
Set<? extends R>	getUnsortedRows() Gets all rows in no particular order.
default boolean	isEmpty()
default Iterator<R>	iterator() Iterates the rows in sorted order.
default boolean	remove(Object o)
default boolean	removeAll(Collection<?> c)
default boolean	retainAll(Collection<?> c)
default int	size()
default void	tableUpdated() Called after the table is updated to ensure cache integrity.
default Object[]	toArray()
default <T> T[]	toArray(T[] a)

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getModel

Model getModel()

Gets the model this table is part of.

clearCaches

default void clearCaches()

Clears the caches for this table that apply to the current thread. This is used to end a caching session, generally short-term and associated with a single request or process. Any overriding method should call super.clearCaches().

tableUpdated

default void tableUpdated()

Called after the table is updated to ensure cache integrity. Cache coherency is maintained between users for global tables. For per-user caches only your own view is affected; no updates will be seen until the end of their caching transaction, generally a web request. Any overriding method should call super.tableUpdated().

clear

default void clear()

Specified by:

clear in interface Collection<R extends Row<K,?>>

retainAll

default boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<R extends Row<K,?>>

removeAll

default boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<R extends Row<K,?>>

addAll

default boolean addAll(Collection<? extends R> c)

Specified by:

addAll in interface Collection<R extends Row<K,?>>

containsAll

default boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<R extends Row<K,?>>

remove

default boolean remove(Object o)

Specified by:

remove in interface Collection<R extends Row<K,?>>

add

default boolean add(R e)

Specified by:

add in interface Collection<R extends Row<K,?>>

toArray

default <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<R extends Row<K,?>>

toArray

default Object[] toArray()

Specified by:

toArray in interface Collection<R extends Row<K,?>>

contains

default boolean contains(Object o)

Specified by:

contains in interface Collection<R extends Row<K,?>>

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface Collection<R extends Row<K,?>>

getSize

default int getSize()
             throws SQLException

Gets the number of accessible rows in this table. This also provides JavaBeans-compatible size.

Throws:

SQLException

size

default int size()

Specified by:

size in interface Collection<R extends Row<K,?>>

getIterator

default Iterator<? extends R> getIterator()
                                   throws SQLException

Iterates the rows in sorted order. This also provides JavaBeans-compatible iterator.

Throws:

SQLException

See Also:

Different calls may return different results, for snapshot-like behavior see getRows.

iterator

default Iterator<R> iterator()

Iterates the rows in sorted order.

Specified by:

iterator in interface Collection<R extends Row<K,?>>

Specified by:

iterator in interface Iterable<R extends Row<K,?>>

See Also:

getIterator()

getMap

Map<K,? extends R> getMap()

Gets a map view of this table.

getSortedMap

SortedMap<K,? extends R> getSortedMap()

Gets a sorted map view of this table.

getName

default String getName()

Gets the table name.

getUnsortedRows

Set<? extends R> getUnsortedRows()
                          throws SQLException

Gets all rows in no particular order. This is an unmodifiable snapshot of the data and will not change over time. It may be iterated multiple times with the same results. The contents are not changed by the transactions of the current user or any other user.

Throws:

SQLException

getRows

SortedSet<? extends R> getRows()
                        throws SQLException

Gets all rows, sorted by their natural ordering. This is an unmodifiable snapshot of the data and will not change over time. It may be iterated multiple times with the same results. The contents are not changed by the transactions of the current user or any other user.

Throws:

SQLException

canonicalize

default K canonicalize(K key)

Gets the canonical key used for internal indexing. In the case of case- insensitive matching, the key may have upper-case and lower-case matches, while the canonicalKey will convert to one format for matching. Any matches are performed on the canonical form the the query.

get

R get(K key)
throws com.aoindustries.dbc.NoRowException,
      SQLException

Gets the row with the provided key.

Throws:

com.aoindustries.dbc.NoRowException - if not found

SQLException - if database error occurs

getOrderedRows

default Set<? extends R> getOrderedRows(Iterable<? extends K> keys)
                                 throws com.aoindustries.dbc.NoRowException,
                                        SQLException

Gets an unmodifiable set of each object corresponding to the set of keys. The elements will be in the set in the same order as the keys iterator. If a key is found twice, the element we be in the position of the first key. This is an unmodifiable snapshot of the data and will not change over time. It may be iterated multiple times with the same results. The contents are not changed by the transactions of the current user or any other user.

Throws:

com.aoindustries.dbc.NoRowException - if any key is not found

SQLException - if database error occurs

getRows

default SortedSet<? extends R> getRows(Iterable<? extends K> keys)
                                throws com.aoindustries.dbc.NoRowException,
                                       SQLException

Gets an unmodifiable sorted set of each object corresponding to the set of keys, sorted by their natural ordering. This is an unmodifiable snapshot of the data and will not change over time. It may be iterated multiple times with the same results. The contents are not changed by the transactions of the current user or any other user.

Throws:

com.aoindustries.dbc.NoRowException - if any key is not found

SQLException - if database error occurs