io.permazen.vaadin

Class SnapshotJObjectContainer

java.lang.Object

com.vaadin.data.util.AbstractContainer

com.vaadin.data.util.AbstractInMemoryContainer<I,String,org.dellroad.stuff.vaadin7.BackedItem<T>>

org.dellroad.stuff.vaadin7.AbstractSimpleContainer<I,T>

org.dellroad.stuff.vaadin7.SimpleKeyedContainer<ObjId,JObject>

io.permazen.vaadin.JObjectContainer

io.permazen.vaadin.ReloadableJObjectContainer

io.permazen.vaadin.SnapshotJObjectContainer

All Implemented Interfaces:

Container, Container.Filterable, Container.Indexed, Container.ItemSetChangeNotifier, Container.Ordered, Container.SimpleFilterable, Container.Sortable, Serializable, org.dellroad.stuff.vaadin7.Connectable, org.dellroad.stuff.vaadin7.PropertyExtractor<JObject>, org.dellroad.stuff.vaadin7.SortingPropertyExtractor<JObject>

public abstract class SnapshotJObjectContainer
extends ReloadableJObjectContainer

Specialized JObjectContainer for use with key/value stores that implement KVTransaction.mutableSnapshot().

This container is loaded by taking a key/value store snapshot and then iterating the desired backing objects directly via iterateObjects(); no copying of objects is required.

Instances are (re)loaded at any time by invoking reload(). During reload, the container opens a JTransaction and then creates a SnapshotJTransaction using the CloseableKVStore returned by KVTransaction.mutableSnapshot(). This SnapshotJTransaction is set as the current transaction while iterateObjects() returns the JObjects to be actually included in the container. The CloseableKVStore will remain open until the container is reload()'ed or disconnect()'ed.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.permazen.vaadin.JObjectContainer

JObjectContainer.ObjFieldPropertyDef, JObjectContainer.ObjIdPropertyDef, JObjectContainer.ObjPropertyDef<T>, JObjectContainer.ObjTypePropertyDef, JObjectContainer.ObjVersionPropertyDef, JObjectContainer.RefLabelPropertyDef

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractInMemoryContainer

AbstractInMemoryContainer.BaseItemAddEvent, AbstractInMemoryContainer.BaseItemRemoveEvent

Nested classes/interfaces inherited from class com.vaadin.data.util.AbstractContainer

AbstractContainer.BaseItemSetChangeEvent, AbstractContainer.BasePropertySetChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Container

Container.Editor, Container.Filter, Container.Filterable, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeEvent, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeEvent, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.SimpleFilterable, Container.Sortable, Container.Viewer

Nested classes/interfaces inherited from interface com.vaadin.data.Container.Indexed

Container.Indexed.ItemAddEvent, Container.Indexed.ItemRemoveEvent

Field Summary

Fields inherited from class io.permazen.vaadin.JObjectContainer

jdb, log, OBJECT_ID_PROPERTY, REFERENCE_LABEL_PROPERTY, TYPE_PROPERTY, VERSION_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnapshotJObjectContainer(Permazen jdb, Class<?> type) Constructor.

Method Summary

Modifier and Type	Method and Description
void	disconnect()
protected abstract Iterator<? extends JObject>	iterateObjects() Iterate the database objects that will be used to fill this container.
void	reload() (Re)load this container.

Methods inherited from class io.permazen.vaadin.ReloadableJObjectContainer

connect, reloadAfterCommit

Methods inherited from class io.permazen.vaadin.JObjectContainer

canSort, doInTransaction, getKeyFor, getOrderedPropertyNames, getPropertyValue, getType, load, load, setType, sort, updateItem

Methods inherited from class org.dellroad.stuff.vaadin7.SimpleKeyedContainer

generateItemId, getItemIdFor, getItemIdForSame, getJavaObject, resetItemIds

Methods inherited from class org.dellroad.stuff.vaadin7.AbstractSimpleContainer

addContainerFilter, addContainerFilter, afterReload, createBackedItem, getContainerFilters, getContainerProperty, getContainerPropertyIds, getItemIds, getPropertyExtractor, getSortableContainerPropertyIds, getType, getUnfilteredItem, internalRemoveAllItems, removeAllContainerFilters, removeContainerFilter, removeContainerFilters, setProperties, setProperty, setPropertyExtractor, sort

Methods inherited from class com.vaadin.data.util.AbstractInMemoryContainer

addContainerProperty, addFilter, addItem, addItem, addItemAfter, addItemAfter, addItemAt, addItemAt, addItemSetChangeListener, addListener, containsId, doFilterContainer, doSort, filterAll, fireItemAdded, fireItemRemoved, fireItemsAdded, fireItemsRemoved, firstItemId, getAllItemIds, getFilteredItemIds, getFilters, getFirstVisibleItem, getIdByIndex, getItem, getItemIds, getItemSorter, getSortablePropertyIds, getVisibleItemIds, hasContainerFilters, indexOfId, internalAddItemAfter, internalAddItemAt, internalAddItemAtEnd, internalRemoveItem, isFiltered, isFirstId, isLastId, isPropertyFiltered, lastItemId, nextItemId, passesFilters, prevItemId, registerNewItem, removeAllFilters, removeAllItems, removeContainerProperty, removeFilter, removeFilters, removeItem, removeItemSetChangeListener, removeListener, setAllItemIds, setFilteredItemIds, setFilters, setItemSorter, size, sortContainer

Methods inherited from class com.vaadin.data.util.AbstractContainer

addListener, addPropertySetChangeListener, fireContainerPropertySetChange, fireContainerPropertySetChange, fireItemSetChange, fireItemSetChange, getItemSetChangeListeners, getListeners, getPropertySetChangeListeners, removeListener, removePropertySetChangeListener, setItemSetChangeListeners, setPropertySetChangeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.data.Container.Ordered

addItemAfter, addItemAfter, firstItemId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId

Methods inherited from interface com.vaadin.data.Container

addContainerProperty, addItem, addItem, containsId, getItem, removeAllItems, removeContainerProperty, removeItem, size

Constructor Detail

SnapshotJObjectContainer

protected SnapshotJObjectContainer(Permazen jdb,
                                   Class<?> type)

Constructor.

Parameters:

jdb - Permazen database

type - type restriction, or null for no restriction

Throws:

IllegalArgumentException - if jdb is null

Method Detail

disconnect

public void disconnect()

Specified by:

disconnect in interface org.dellroad.stuff.vaadin7.Connectable

Overrides:

disconnect in class ReloadableJObjectContainer

reload

public void reload()

(Re)load this container.

This method opens a JTransaction, creates a SnapshotJTransaction using the CloseableKVStore returned by KVTransaction.mutableSnapshot(), and loads the container using the objects returned by iterateObjects().

Specified by:

reload in class ReloadableJObjectContainer

iterateObjects

protected abstract Iterator<? extends JObject> iterateObjects()

Iterate the database objects that will be used to fill this container. Objects should be returned in the desired order; duplicates and null values will be ignored.

A JTransaction will be open in the current thread when this method is invoked.

Returns:

database objects