info.magnolia.dam.external.app.contentview

Class AbstractAssetContainer

java.lang.Object

info.magnolia.ui.workbench.container.AbstractContainer

info.magnolia.dam.external.app.contentview.AbstractAssetContainer

All Implemented Interfaces:

com.vaadin.data.Container, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Ordered, com.vaadin.data.Container.Sortable, info.magnolia.ui.workbench.container.Refreshable, Serializable

Direct Known Subclasses:

FlatAssetContainer, HierarchicalAssetContainer

public abstract class AbstractAssetContainer
extends info.magnolia.ui.workbench.container.AbstractContainer
implements com.vaadin.data.Container.Sortable, com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeNotifier, info.magnolia.ui.workbench.container.Refreshable

Vaadin container that stores copies of items obtained via AssetProvider implementations. Implements a simple mechanism for lazy loading items and a cache for items and item ids.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAssetContainer.BaseItemSetChangeEvent Basic itemSet change event.

Nested classes/interfaces inherited from class info.magnolia.ui.workbench.container.AbstractContainer

info.magnolia.ui.workbench.container.AbstractContainer.ItemSetChangeEvent, info.magnolia.ui.workbench.container.AbstractContainer.PropertySetChangeEvent

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

com.vaadin.data.Container.Indexed.ItemAddEvent, com.vaadin.data.Container.Indexed.ItemRemoveEvent

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CACHE_RATIO
static int	DEFAULT_PAGE_LENGTH

Constructor Summary

Constructors

Constructor and Description
AbstractAssetContainer(AssetContentConnector assetContentConnector)

Method Summary

Methods

Modifier and Type	Method and Description
Object	addItem()
com.vaadin.data.Item	addItem(Object itemId)
Object	addItemAfter(Object previousItemId)
com.vaadin.data.Item	addItemAfter(Object previousItemId, Object newItemId)
Object	addItemAt(int index)
com.vaadin.data.Item	addItemAt(int index, Object newItemId)
void	addItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
void	addListener(com.vaadin.data.Container.ItemSetChangeListener listener)
void	addSortableProperty(String sortableProperty)
protected void	clearItemIndexes()
protected info.magnolia.dam.api.AssetQuery	constructQuery(long pageSize, long offset, boolean considerSorting)
boolean	containsId(Object itemId)
void	fireItemSetChange()
Object	firstItemId()
protected info.magnolia.dam.api.Item	getAssetItem(Object itemKey)
info.magnolia.dam.api.AssetProvider	getAssetProvider()
int	getCacheRatio()
com.vaadin.data.Property<?>	getContainerProperty(Object itemId, Object propertyId)
protected int	getCurrentOffset()
protected info.magnolia.dam.api.AssetQuery.OrderBy	getDefaultOrderBy(String property)
info.magnolia.dam.api.ItemKey	getIdByIndex(int index)
com.vaadin.data.util.BeanItem<info.magnolia.dam.api.Item>	getItem(Object itemId)
Collection<String>	getItemIds()
List<?>	getItemIds(int startIndex, int numberOfItems)
int	getPageLength()
List<String>	getSortableContainerPropertyIds()
int	indexOfId(Object itemId)
boolean	isFirstId(Object itemId)
boolean	isLastId(Object itemId)
Object	lastItemId()
Object	nextItemId(Object itemId)
Object	prevItemId(Object itemId)
void	refresh() Refreshes the container - clears all caches and resets size and offset.
boolean	removeAllItems()
boolean	removeItem(Object itemId)
void	removeItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
void	removeListener(com.vaadin.data.Container.ItemSetChangeListener listener)
protected void	resetOffset()
void	setAssetProvider(info.magnolia.dam.api.AssetProvider assetProvider)
void	setCacheRatio(int cacheRatio)
void	setPageLength(int pageLength)
protected void	setSize(int size)
int	size()
void	sort(Object[] propertyId, boolean[] ascending)

Methods inherited from class info.magnolia.ui.workbench.container.AbstractContainer

addContainerProperty, getContainerPropertyIds, getType, removeContainerProperty

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

addContainerProperty, getContainerPropertyIds, getType, removeContainerProperty

Field Detail

DEFAULT_PAGE_LENGTH

public static final int DEFAULT_PAGE_LENGTH

See Also:

Constant Field Values

DEFAULT_CACHE_RATIO

public static final int DEFAULT_CACHE_RATIO

See Also:

Constant Field Values

Constructor Detail

AbstractAssetContainer

@Inject
public AbstractAssetContainer(AssetContentConnector assetContentConnector)

Method Detail

setAssetProvider

public void setAssetProvider(info.magnolia.dam.api.AssetProvider assetProvider)

getAssetProvider

public info.magnolia.dam.api.AssetProvider getAssetProvider()

getPageLength

public int getPageLength()

setPageLength

public void setPageLength(int pageLength)

getCacheRatio

public int getCacheRatio()

setCacheRatio

public void setCacheRatio(int cacheRatio)

addSortableProperty

public void addSortableProperty(String sortableProperty)

size

public int size()

Specified by:

size in interface com.vaadin.data.Container

getItem

public com.vaadin.data.util.BeanItem<info.magnolia.dam.api.Item> getItem(Object itemId)

Specified by:

getItem in interface com.vaadin.data.Container

containsId

public boolean containsId(Object itemId)

Specified by:

containsId in interface com.vaadin.data.Container

getContainerProperty

public com.vaadin.data.Property<?> getContainerProperty(Object itemId,
                                               Object propertyId)

Specified by:

getContainerProperty in interface com.vaadin.data.Container

getItemIds

public Collection<String> getItemIds()

Specified by:

getItemIds in interface com.vaadin.data.Container

addItem

public com.vaadin.data.Item addItem(Object itemId)
                             throws UnsupportedOperationException

Specified by:

addItem in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

addItem

public Object addItem()
               throws UnsupportedOperationException

Specified by:

addItem in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

removeAllItems

public boolean removeAllItems()
                       throws UnsupportedOperationException

Specified by:

removeAllItems in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

removeItem

public boolean removeItem(Object itemId)
                   throws UnsupportedOperationException

Specified by:

removeItem in interface com.vaadin.data.Container

Throws:

UnsupportedOperationException

refresh

public void refresh()

Refreshes the container - clears all caches and resets size and offset. Does NOT remove sorting or filtering rules!

Specified by:

refresh in interface info.magnolia.ui.workbench.container.Refreshable

addItemSetChangeListener

public void addItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

addItemSetChangeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

addListener

public void addListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

addListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

removeItemSetChangeListener

public void removeItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

removeItemSetChangeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

removeListener

public void removeListener(com.vaadin.data.Container.ItemSetChangeListener listener)

Specified by:

removeListener in interface com.vaadin.data.Container.ItemSetChangeNotifier

fireItemSetChange

public void fireItemSetChange()

nextItemId

public Object nextItemId(Object itemId)

Specified by:

nextItemId in interface com.vaadin.data.Container.Ordered

prevItemId

public Object prevItemId(Object itemId)

Specified by:

prevItemId in interface com.vaadin.data.Container.Ordered

firstItemId

public Object firstItemId()

Specified by:

firstItemId in interface com.vaadin.data.Container.Ordered

lastItemId

public Object lastItemId()

Specified by:

lastItemId in interface com.vaadin.data.Container.Ordered

isFirstId

public boolean isFirstId(Object itemId)

Specified by:

isFirstId in interface com.vaadin.data.Container.Ordered

isLastId

public boolean isLastId(Object itemId)

Specified by:

isLastId in interface com.vaadin.data.Container.Ordered

addItemAfter

public com.vaadin.data.Item addItemAfter(Object previousItemId,
                                Object newItemId)
                                  throws UnsupportedOperationException

Specified by:

addItemAfter in interface com.vaadin.data.Container.Ordered

Throws:

UnsupportedOperationException

addItemAfter

public Object addItemAfter(Object previousItemId)
                    throws UnsupportedOperationException

Specified by:

addItemAfter in interface com.vaadin.data.Container.Ordered

Throws:

UnsupportedOperationException

constructQuery

protected final info.magnolia.dam.api.AssetQuery constructQuery(long pageSize,
                                              long offset,
                                              boolean considerSorting)

Parameters:

considerSorting - an optional ORDER BY is added if this parameter is true.

Returns:

a AssetQuery representing a statement to retrieve this container's items.

getDefaultOrderBy

protected info.magnolia.dam.api.AssetQuery.OrderBy getDefaultOrderBy(String property)

Returns:

an AssetQuery.OrderBy object for the passed in property to be used for the default order by clause.

getAssetItem

protected info.magnolia.dam.api.Item getAssetItem(Object itemKey)

resetOffset

protected void resetOffset()

clearItemIndexes

protected void clearItemIndexes()

getCurrentOffset

protected int getCurrentOffset()

setSize

protected void setSize(int size)

indexOfId

public int indexOfId(Object itemId)

Specified by:

indexOfId in interface com.vaadin.data.Container.Indexed

getIdByIndex

public info.magnolia.dam.api.ItemKey getIdByIndex(int index)

Specified by:

getIdByIndex in interface com.vaadin.data.Container.Indexed

getItemIds

public List<?> getItemIds(int startIndex,
                 int numberOfItems)

Specified by:

getItemIds in interface com.vaadin.data.Container.Indexed

addItemAt

public com.vaadin.data.Item addItemAt(int index,
                             Object newItemId)
                               throws UnsupportedOperationException

Specified by:

addItemAt in interface com.vaadin.data.Container.Indexed

Throws:

UnsupportedOperationException

addItemAt

public Object addItemAt(int index)
                 throws UnsupportedOperationException

Specified by:

addItemAt in interface com.vaadin.data.Container.Indexed

Throws:

UnsupportedOperationException

sort

public void sort(Object[] propertyId,
        boolean[] ascending)

Specified by:

sort in interface com.vaadin.data.Container.Sortable

getSortableContainerPropertyIds

public List<String> getSortableContainerPropertyIds()

Specified by:

getSortableContainerPropertyIds in interface com.vaadin.data.Container.Sortable