CacheBrowserContainer (Magnolia Module Cache (Parent POM) 5.4 API)

java.lang.Object
- info.magnolia.ui.workbench.container.AbstractContainer
- - info.magnolia.cache.browser.app.CacheBrowserContainer

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
```
public class CacheBrowserContainer
extends info.magnolia.ui.workbench.container.AbstractContainer
implements com.vaadin.data.Container.Indexed, com.vaadin.data.Container.ItemSetChangeNotifier, com.vaadin.data.Container.Sortable, info.magnolia.ui.workbench.container.Refreshable
```
Container that holds all cache entries.

See Also:
Serialized Form

Nested Class Summary
- 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

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

Constructor Summary

Constructors
Constructor and Description
`CacheBrowserContainer(CacheBrowserContentConnectorDefinition contentConnectorDefinition, CacheServiceFactory cacheServiceFactory, info.magnolia.event.EventBus eventBus)`

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)`
`boolean`	`containsId(Object itemId)`
`void`	`fireItemSetChange()`
`Object`	`firstItemId()`
`com.vaadin.data.Property<?>`	`getContainerProperty(Object itemId, Object propertyId)`
`Object`	`getIdByIndex(int index)`
`com.vaadin.data.Item`	`getItem(Object itemId)`
`Collection<CacheKey>`	`getItemIds()`
`List<?>`	`getItemIds(int startIndex, int numberOfItems)`
`Collection<String>`	`getSortableContainerPropertyIds()`
`int`	`indexOfId(Object itemId)`
`void`	`initialize(String username, String password)`
`boolean`	`isFirstId(Object itemId)`
`boolean`	`isLastId(Object itemId)`
`Object`	`lastItemId()`
`Object`	`nextItemId(Object itemId)`
`Object`	`prevItemId(Object itemId)`
`void`	`refresh()`
`boolean`	`removeAllItems()`
`boolean`	`removeItem(Object itemId)`
`void`	`removeItemSetChangeListener(com.vaadin.data.Container.ItemSetChangeListener listener)`
`void`	`removeListener(com.vaadin.data.Container.ItemSetChangeListener listener)`
`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
  - CacheBrowserContainer
```
public CacheBrowserContainer(CacheBrowserContentConnectorDefinition contentConnectorDefinition,
                     CacheServiceFactory cacheServiceFactory,
                     info.magnolia.event.EventBus eventBus)
```
- Method Detail
  - initialize
```
public void initialize(String username,
              String password)
```
  - getItem
```
public com.vaadin.data.Item getItem(Object itemId)
```
    Specified by:
    
    getItem in interface com.vaadin.data.Container
  - getItemIds
```
public Collection<CacheKey> getItemIds()
```
    Specified by:
    
    getItemIds 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
  - size
```
public int size()
```
    Specified by:
    
    size in interface com.vaadin.data.Container
  - containsId
```
public boolean containsId(Object itemId)
```
    Specified by:
    
    containsId 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
  - removeItem
```
public boolean removeItem(Object itemId)
                   throws UnsupportedOperationException
```
    Specified by:
    
    removeItem 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
  - 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
  - indexOfId
```
public int indexOfId(Object itemId)
```
    Specified by:
    
    indexOfId in interface com.vaadin.data.Container.Indexed
  - getIdByIndex
```
public Object 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 Object addItemAt(int index)
                 throws UnsupportedOperationException
```
    Specified by:
    
    addItemAt in interface com.vaadin.data.Container.Indexed
    
    Throws:
    
    UnsupportedOperationException
  - 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
  - addItemAfter
```
public Object addItemAfter(Object previousItemId)
                    throws UnsupportedOperationException
```
    Specified by:
    
    addItemAfter in interface com.vaadin.data.Container.Ordered
    
    Throws:
    
    UnsupportedOperationException
  - 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
  - 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()
```
  - sort
```
public void sort(Object[] propertyId,
        boolean[] ascending)
```
    Specified by:
    
    sort in interface com.vaadin.data.Container.Sortable
  - getSortableContainerPropertyIds
```
public Collection<String> getSortableContainerPropertyIds()
```
    Specified by:
    
    getSortableContainerPropertyIds in interface com.vaadin.data.Container.Sortable
  - refresh
```
public void refresh()
```
    Specified by:
    
    refresh in interface info.magnolia.ui.workbench.container.Refreshable

Class CacheBrowserContainer

Nested Class Summary

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

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

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

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.data.Container

Field Detail

DEFAULT_PAGE_LENGTH

DEFAULT_CACHE_RATIO

Constructor Detail

CacheBrowserContainer

Method Detail

initialize

getItem

getItemIds

getContainerProperty

size

containsId

addItem

addItem

removeItem

removeAllItems

nextItemId

prevItemId

firstItemId

lastItemId

isFirstId

isLastId

indexOfId

getIdByIndex

getItemIds

addItemAt

addItemAt

addItemAfter

addItemAfter

addItemSetChangeListener

addListener

removeItemSetChangeListener

removeListener

fireItemSetChange

sort

getSortableContainerPropertyIds

refresh