com.itmill.toolkit.data.util
Class IndexedContainer

java.lang.Object
  com.itmill.toolkit.data.util.IndexedContainer

All Implemented Interfaces:

Container, Container.Indexed, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeNotifier, Container.Sortable, Property.ValueChangeNotifier, Cloneable, Comparator

Direct Known Subclasses:

HierarchicalContainer

public class IndexedContainer
extends Object
implements Container, Container.Indexed, Container.ItemSetChangeNotifier, Container.PropertySetChangeNotifier, Property.ValueChangeNotifier, Container.Sortable, Comparator, Cloneable

Indexed container implementation.

A list implementation of the com.itmill.toolkit.data.Container interface. A list is a ordered collection wherein the user has a precise control over where in the list each new Item is inserted. The user may access the Items by their integer index (position in the list) or by their Item ID.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

See Also:

Container

Nested Class Summary

Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Container

Container.Editor, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Sortable, Container.Viewer

Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Container

Container.Editor, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Sortable, Container.Viewer

Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Container

Container.Editor, Container.Hierarchical, Container.Indexed, Container.ItemSetChangeListener, Container.ItemSetChangeNotifier, Container.Ordered, Container.PropertySetChangeListener, Container.PropertySetChangeNotifier, Container.Sortable, Container.Viewer

Field Summary

Fields inherited from interface com.itmill.toolkit.data.Container

NULL_ITEM_ID

Fields inherited from interface com.itmill.toolkit.data.Container

NULL_ITEM_ID

Fields inherited from interface com.itmill.toolkit.data.Container

NULL_ITEM_ID

Constructor Summary

IndexedContainer()

IndexedContainer(Collection itemIds)

Method Summary

boolean	addContainerProperty(Object propertyId, Class type, Object defaultValue) Adds a new Property to all Items in the list.
Object	addItem() Creates a new Item into the list, and assign it an automatic ID.
Item	addItem(Object itemId) Creates a new Item with the given ID into the list.
Object	addItemAfter(Object previousItemId) Adds new item after the given item.
Item	addItemAfter(Object previousItemId, Object newItemId) Adds new item after the given item.
Object	addItemAt(int index) Adds new item at given index.
Item	addItemAt(int index, Object newItemId) Adds new item at given index.
void	addListener(Container.ItemSetChangeListener listener) Adds a Item set change listener for the list.
void	addListener(Container.PropertySetChangeListener listener) Registers a new Property set change listener for this list.
void	addListener(Property.ValueChangeListener listener) Registers a new value change listener for this object.
Object	clone() Supports cloning of the IndexedContainer cleanly.
int	compare(Object o1, Object o2) Compares two items for sorting.
boolean	containsId(Object itemId) Tests if the list contains the specified Item
boolean	equals(Object obj)
Object	firstItemId() Gets the ID of the first Item in the list.
Property	getContainerProperty(Object itemId, Object propertyId) Gets the Property identified by the given Item ID and Property ID from the lsit.
Collection	getContainerPropertyIds() Gets the ID's of all Properties stored in the list.
Object	getIdByIndex(int index) Gets ID with the index.
Item	getItem(Object itemId) Gets the Item with the given Item ID from the list.
Collection	getItemIds() Gets the ID's of all Items stored in the list.
Collection	getSortableContainerPropertyIds() Gets the container property IDs, which can be used to sort the item.
Class	getType(Object propertyId) Gets the type of a Property stored in the list.
int	hashCode()
int	indexOfId(Object itemId) Gets the index of an id.
boolean	isFirstId(Object itemId) Tests if the Item corresponding to the given Item ID is the first Item in the list.
boolean	isLastId(Object itemId) Tests if the Item corresponding to the given Item ID is the last Item in the list.
Object	lastItemId() Gets the ID of the last Item in the list.
Object	nextItemId(Object itemId) Gets the ID of the Item following the Item that corresponds to the itemId.
Object	prevItemId(Object itemId) Gets the ID of the Item preceding the Item that corresponds to the itemId.
boolean	removeAllItems() Removes all Items from the list.
boolean	removeContainerProperty(Object propertyId) Removes a Property specified by the given Property ID from the list.
boolean	removeItem(Object itemId) Removes the Item corresponding to the given Item ID from the list.
void	removeListener(Container.ItemSetChangeListener listener) Removes a Item set change listener from the object.
void	removeListener(Container.PropertySetChangeListener listener) Removes a previously registered Property set change listener.
void	removeListener(Property.ValueChangeListener listener) Removes a previously registered value change listener.
int	size() Gets the number of Items in the list.
void	sort(Object[] propertyId, boolean[] ascending) Sort method.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexedContainer

public IndexedContainer()

IndexedContainer

public IndexedContainer(Collection itemIds)

Method Detail

getItem

public Item getItem(Object itemId)

Gets the Item with the given Item ID from the list. If the list does not contain the requested Item, null is returned.

Specified by:

getItem in interface Container

Parameters:

itemId - the ID of the Item to retrieve.

Returns:

the Item with the given ID or null if the Item is not found in the list

getItemIds

public Collection getItemIds()

Gets the ID's of all Items stored in the list. The ID's are returned as a unmodifiable collection.

Specified by:

getItemIds in interface Container

Returns:

unmodifiable collection of Item IDs

getContainerPropertyIds

public Collection getContainerPropertyIds()

Gets the ID's of all Properties stored in the list. The ID's are returned as a unmodifiable collection.

Specified by:

getContainerPropertyIds in interface Container

Returns:

unmodifiable collection of Property IDs

getType

public Class getType(Object propertyId)

Gets the type of a Property stored in the list.

Specified by:

getType in interface Container

Parameters:

id - the ID of the Property.

Returns:

Type of the requested Property

getContainerProperty

public Property getContainerProperty(Object itemId,
                                     Object propertyId)

Gets the Property identified by the given Item ID and Property ID from the lsit. If the list does not contain the Property, null is returned.

Specified by:

getContainerProperty in interface Container

Parameters:

itemId - the ID of the Item which contains the requested Property.

propertyId - the ID of the Property to retrieve.

Returns:

Property with the given ID or null

See Also:

Container.getContainerProperty(Object, Object)

size

public int size()

Gets the number of Items in the list.

Specified by:

size in interface Container

Returns:

number of Items in the list

containsId

public boolean containsId(Object itemId)

Tests if the list contains the specified Item

Specified by:

containsId in interface Container

Parameters:

itemId - the ID the of Item to be tested for.

Returns:

true if the operation succeeded, false if not

addContainerProperty

public boolean addContainerProperty(Object propertyId,
                                    Class type,
                                    Object defaultValue)

Adds a new Property to all Items in the list. The Property ID, data type and default value of the new Property are given as parameters.

Specified by:

addContainerProperty in interface Container

Parameters:

propertyId - the ID of the new Property.

type - the Data type of the new Property.

defaultValue - the value all created Properties are initialized to.

Returns:

true if the operation succeeded, false if not

removeAllItems

public boolean removeAllItems()

Removes all Items from the list.

Note : The Property ID and type information is preserved.

Specified by:

removeAllItems in interface Container

Returns:

true if the operation succeeded, false if not

addItem

public Object addItem()

Creates a new Item into the list, and assign it an automatic ID. The new ID is returned, or null if the operation fails. After a successful call you can use the getItemmethod to fetch the Item.

Specified by:

addItem in interface Container

Returns:

ID of the newly created Item, or null in case of a failure

addItem

public Item addItem(Object itemId)

Creates a new Item with the given ID into the list. The new Item is returned, and it is ready to have its Properties modified. Returns null if the operation fails or the Container already contains a Item with the given ID.

Specified by:

addItem in interface Container

Parameters:

itemId - the ID of the Item to be created.

Returns:

Created new Item, or null in case of a failure

removeItem

public boolean removeItem(Object itemId)

Removes the Item corresponding to the given Item ID from the list.

Specified by:

removeItem in interface Container

Parameters:

itemId - the ID of the Item to remove.

Returns:

true if the operation succeeded, false if not

removeContainerProperty

public boolean removeContainerProperty(Object propertyId)

Removes a Property specified by the given Property ID from the list. Note that the Property will be removed from all Items in the list.

Specified by:

removeContainerProperty in interface Container

Parameters:

propertyId - the ID of the Property to remove.

Returns:

true if the operation succeeded, false if not

firstItemId

public Object firstItemId()

Gets the ID of the first Item in the list.

Specified by:

firstItemId in interface Container.Ordered

Returns:

ID of the first Item in the list

lastItemId

public Object lastItemId()

Gets the ID of the last Item in the list.

Specified by:

lastItemId in interface Container.Ordered

Returns:

ID of the last Item in the list

nextItemId

public Object nextItemId(Object itemId)

Gets the ID of the Item following the Item that corresponds to the itemId. If the given Item is the last or not found in the list, null is returned.

Specified by:

nextItemId in interface Container.Ordered

Parameters:

itemId - the ID of an Item in the list.

Returns:

ID of the next Item or null

prevItemId

public Object prevItemId(Object itemId)

Gets the ID of the Item preceding the Item that corresponds to the itemId. If the given Item is the first or not found in the list, null is returned.

Specified by:

prevItemId in interface Container.Ordered

Parameters:

itemId - the ID of an Item in the list.

Returns:

ID of the previous Item or null

isFirstId

public boolean isFirstId(Object itemId)

Tests if the Item corresponding to the given Item ID is the first Item in the list.

Specified by:

isFirstId in interface Container.Ordered

Parameters:

itemId - the ID of an Item in the list.

Returns:

true if the Item is first in the list, false if not

isLastId

public boolean isLastId(Object itemId)

Tests if the Item corresponding to the given Item ID is the last Item in the list.

Specified by:

isLastId in interface Container.Ordered

Parameters:

itemId - the ID of an Item in the list.

Returns:

true if the Item is last in the list, false if not

addItemAfter

public Item addItemAfter(Object previousItemId,
                         Object newItemId)

Description copied from interface: Container.Ordered

Adds new item after the given item.

Adding an item after null item adds the item as first item of the ordered container.

Specified by:

addItemAfter in interface Container.Ordered

Parameters:

previousItemId - Id of the previous item in ordered container.

newItemId - Id of the new item to be added.

Returns:

Returns new item or null if the operation fails.

See Also:

Container.Ordered.addItemAfter(Object, Object)

addItemAfter

public Object addItemAfter(Object previousItemId)

Description copied from interface: Container.Ordered

Adds new item after the given item.

Adding an item after null item adds the item as first item of the ordered container.

Specified by:

addItemAfter in interface Container.Ordered

Parameters:

previousItemId - Id of the previous item in ordered container.

Returns:

Returns item id the the created new item or null if the operation fails.

See Also:

Container.Ordered.addItemAfter(Object)

getIdByIndex

public Object getIdByIndex(int index)

Gets ID with the index. The following is true for the index: 0 <= index < size().

Specified by:

getIdByIndex in interface Container.Indexed

Parameters:

index - Index of the requested ID in the container.

Returns:

ID in the given index.

indexOfId

public int indexOfId(Object itemId)

Gets the index of an id. The following is true for the index: 0 <= index < size().

Specified by:

indexOfId in interface Container.Indexed

Parameters:

itemId - ID of an Item in the collection

Returns:

Index of the Item or -1 if the Item is not in the container.

addItemAt

public Item addItemAt(int index,
                      Object newItemId)

Description copied from interface: Container.Indexed

Adds new item at given index.

The indexes of the item currently in the given position and all the following items are incremented.

Specified by:

addItemAt in interface Container.Indexed

Parameters:

index - Index to add the new item.

newItemId - Id of the new item to be added.

Returns:

Returns new item or null if the operation fails.

See Also:

Container.Indexed.addItemAt(int, Object)

addItemAt

public Object addItemAt(int index)

Description copied from interface: Container.Indexed

Adds new item at given index.

The indexes of the item currently in the given position and all the following items are incremented.

Specified by:

addItemAt in interface Container.Indexed

Parameters:

index - Index to add the new item.

Returns:

Returns item id the the created new item or null if the operation fails.

See Also:

Container.Indexed.addItemAt(int)

addListener

public void addListener(Container.PropertySetChangeListener listener)

Registers a new Property set change listener for this list.

Specified by:

addListener in interface Container.PropertySetChangeNotifier

Parameters:

listener - the new Listener to be registered.

removeListener

public void removeListener(Container.PropertySetChangeListener listener)

Removes a previously registered Property set change listener.

Specified by:

removeListener in interface Container.PropertySetChangeNotifier

Parameters:

listener - the listener to be removed.

addListener

public void addListener(Container.ItemSetChangeListener listener)

Adds a Item set change listener for the list.

Specified by:

addListener in interface Container.ItemSetChangeNotifier

Parameters:

listener - the listener to be added.

removeListener

public void removeListener(Container.ItemSetChangeListener listener)

Removes a Item set change listener from the object.

Specified by:

removeListener in interface Container.ItemSetChangeNotifier

Parameters:

listener - the listener to be removed.

addListener

public void addListener(Property.ValueChangeListener listener)

Registers a new value change listener for this object.

Specified by:

addListener in interface Property.ValueChangeNotifier

Parameters:

listener - the new Listener to be registered

removeListener

public void removeListener(Property.ValueChangeListener listener)

Removes a previously registered value change listener.

Specified by:

removeListener in interface Property.ValueChangeNotifier

Parameters:

listener - the listener to be removed.

sort

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

Description copied from interface: Container.Sortable

Sort method. Sorts the container items.

Specified by:

sort in interface Container.Sortable

Parameters:

propertyId - Array of container property IDs, which values are used to sort the items in container as primary, secondary, ... sorting criterion. All of the item IDs must be in the collection returned by getSortableContainerPropertyIds

ascending - Array of sorting order flags corresponding to each property ID used in sorting. If this array is shorter than propertyId array, ascending order is assumed for items where the order is not specified. Use true to sort in ascending order, false to use descending order.

See Also:

Container.Sortable.sort(java.lang.Object[], boolean[])

getSortableContainerPropertyIds

public Collection getSortableContainerPropertyIds()

Description copied from interface: Container.Sortable

Gets the container property IDs, which can be used to sort the item.

Specified by:

getSortableContainerPropertyIds in interface Container.Sortable

Returns:

The sortable field ids.

See Also:

Container.Sortable.getSortableContainerPropertyIds()

compare

public int compare(Object o1,
                   Object o2)

Compares two items for sorting.

Specified by:

compare in interface Comparator

See Also:

Comparator.compare(java.lang.Object, java.lang.Object), #sort((java.lang.Object[], boolean[])

clone

public Object clone()
             throws CloneNotSupportedException

Supports cloning of the IndexedContainer cleanly.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException - if an object cannot be cloned. .

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()