Package com.vaadin.data
Contains interfaces for the data layer, mainly for binding typed data and data collections to components, and for validating data.
Data binding
The package contains a three-tiered structure for typed data objects and collections of them:
- A
Propertyrepresents a single, typed data value. - An
Itemembodies a set of Properties. A locally unique (inside theItem) Property identifier corresponds to each Property inside the Item. - A
Containercontains a set of Items, each corresponding to a locally unique Item identifier. Note that Container imposes a few restrictions on the data stored in it, seeContainerfor further information.
For more information on the data model, see the Data model chapter in Book of Vaadin.
Buffering
A Buffered implementor is able
to track and buffer changes and commit or discard them later.
Validation
Validator implementations are
used to validate data, typically the value of a Field. One or more Validators can be added to a Validatable implementor and then used to validate the value of the
Validatable.
-
Interface Summary Interface Description Buffered Defines the interface to commit and discard changes to an object, supporting buffering.BufferedValidatable This interface defines the combination ofValidatableandBufferedinterfaces.Collapsible Container needed by large lazy loading hierarchies displayed e.g.Container A specialized set of identified Items.Container.Editor Interface implemented by the editor classes supporting editing the Container.Container.Filter Filter interface for container filtering.Container.Filterable Interface that is implemented by containers which allow reducing their visible contents based on a set of filters.Container.Hierarchical Interface forContainerclasses whose Items can be arranged hierarchically.Container.Indexed Interface for Container classes whoseItems can be accessed by their position in the container.Container.Indexed.ItemAddEvent AnEventobject specifying information about the added items.Container.Indexed.ItemRemoveEvent AnEventobject specifying information about the removed items.Container.ItemSetChangeEvent AnEventobject specifying the Container whose Item set has changed (items added, removed or reordered).Container.ItemSetChangeListener Container Item set change listener interface.Container.ItemSetChangeNotifier The interface for adding and removingItemSetChangeEventlisteners.Container.Ordered Interface for Container classes whoseItems can be traversed in order.Container.PropertySetChangeEvent AnEventobject specifying the Container whose Property set has changed.Container.PropertySetChangeListener The listener interface for receivingPropertySetChangeEventobjects.Container.PropertySetChangeNotifier The interface for adding and removingPropertySetChangeEventlisteners.Container.SimpleFilterable Interface that is implemented by containers which allow reducing their visible contents based on a set of filters.Container.Sortable Interface for Container classes whoseItems can be sorted.Container.Viewer Interface implemented by viewer classes capable of using a Container as a data source.Item Provides a mechanism for handling a set of Properties, each associated to a locally unique non-null identifier.Item.Editor Interface implemented by theEditorclasses capable of editing the Item.Item.PropertySetChangeEvent AnEventobject specifying the Item whose contents has been changed through thePropertyinterface.Item.PropertySetChangeListener The listener interface for receivingPropertySetChangeEventobjects.Item.PropertySetChangeNotifier The interface for adding and removingPropertySetChangeEventlisteners.Item.Viewer Interface implemented by viewer classes capable of using an Item as a data source.Property<T> ThePropertyis a simple data object that contains one typed value.Property.Editor Interface implemented by the editor classes capable of editing the Property.Property.ReadOnlyStatusChangeEvent AnEventobject specifying the Property whose read-only status has been changed.Property.ReadOnlyStatusChangeListener The listener interface for receivingReadOnlyStatusChangeEventobjects.Property.ReadOnlyStatusChangeNotifier The interface for adding and removingReadOnlyStatusChangeEventlisteners.Property.Transactional<T> A Property that is capable of handle a transaction that can end in commit or rollback.Property.ValueChangeEvent AnEventobject specifying the Property whose value has been changed.Property.ValueChangeListener Thelistenerinterface for receivingValueChangeEventobjects.Property.ValueChangeNotifier The interface for adding and removingValueChangeEventlisteners.Property.Viewer Interface implemented by the viewer classes capable of using a Property as a data source.Validatable Interface for validatable objects.Validator Interface that implements a method for validating if anObjectis valid or not. -
Class Summary Class Description ContainerHelpers Contains helper methods for containers that can be used to ease development of containers in Vaadin. -
Exception Summary Exception Description Buffered.SourceException An exception that signals that one or more exceptions occurred while a buffered object tried to access its data source or if there is a problem in processing a data source.Property.ReadOnlyException Exceptionobject that signals that a requested Property modification failed because it's in read-only mode.Validator.EmptyValueException A specific type ofValidator.InvalidValueExceptionthat indicates that validation failed because the value was empty.Validator.InvalidValueException Exception that is thrown by aValidatorwhen a value is invalid.