From 39f7583a4937f921b762fbd78effe7ded96534ed Mon Sep 17 00:00:00 2001 From: Artur Signell Date: Mon, 10 May 2010 14:58:27 +0000 Subject: Updated package javadoc for #4248 svn changeset:13122/svn branch:6.4 --- src/com/vaadin/data/doc-files/Container_full.gif | Bin 9870 -> 0 bytes src/com/vaadin/data/doc-files/Container_simple.gif | Bin 7448 -> 0 bytes src/com/vaadin/data/doc-files/Item.gif | Bin 2694 -> 0 bytes src/com/vaadin/data/doc-files/Property.gif | Bin 1415 -> 0 bytes src/com/vaadin/data/doc-files/datalayer.gif | Bin 7595 -> 0 bytes src/com/vaadin/data/package.html | 95 +++++++-------------- src/com/vaadin/data/util/package.html | 31 ++----- src/com/vaadin/data/validator/package.html | 13 +-- 8 files changed, 43 insertions(+), 96 deletions(-) delete mode 100644 src/com/vaadin/data/doc-files/Container_full.gif delete mode 100644 src/com/vaadin/data/doc-files/Container_simple.gif delete mode 100644 src/com/vaadin/data/doc-files/Item.gif delete mode 100644 src/com/vaadin/data/doc-files/Property.gif delete mode 100644 src/com/vaadin/data/doc-files/datalayer.gif (limited to 'src/com/vaadin/data') diff --git a/src/com/vaadin/data/doc-files/Container_full.gif b/src/com/vaadin/data/doc-files/Container_full.gif deleted file mode 100644 index 28ee720e32..0000000000 Binary files a/src/com/vaadin/data/doc-files/Container_full.gif and /dev/null differ diff --git a/src/com/vaadin/data/doc-files/Container_simple.gif b/src/com/vaadin/data/doc-files/Container_simple.gif deleted file mode 100644 index 6db32581b8..0000000000 Binary files a/src/com/vaadin/data/doc-files/Container_simple.gif and /dev/null differ diff --git a/src/com/vaadin/data/doc-files/Item.gif b/src/com/vaadin/data/doc-files/Item.gif deleted file mode 100644 index 4cd202ceba..0000000000 Binary files a/src/com/vaadin/data/doc-files/Item.gif and /dev/null differ diff --git a/src/com/vaadin/data/doc-files/Property.gif b/src/com/vaadin/data/doc-files/Property.gif deleted file mode 100644 index 4aff19db1c..0000000000 Binary files a/src/com/vaadin/data/doc-files/Property.gif and /dev/null differ diff --git a/src/com/vaadin/data/doc-files/datalayer.gif b/src/com/vaadin/data/doc-files/datalayer.gif deleted file mode 100644 index b3d25639e0..0000000000 Binary files a/src/com/vaadin/data/doc-files/datalayer.gif and /dev/null differ diff --git a/src/com/vaadin/data/package.html b/src/com/vaadin/data/package.html index f6e0a2d645..a14ea1ac88 100644 --- a/src/com/vaadin/data/package.html +++ b/src/com/vaadin/data/package.html @@ -5,82 +5,45 @@ -

Provides interfaces for the data layer which contains classes -for typed data values, data collections, and handlers. A -{@link com.vaadin.data.Property Property} is a simple typed data -value; an {@link com.vaadin.data.Item Item} is a collection of -Properties, each corresponding to a unique identifier; a -{@link com.vaadin.data.Container Container} is a collection of -identified Items with special constraints; a -{@link com.vaadin.data.Buffered Buffered} class is able to track -its changes and to commit or discard them later.

+

Contains interfaces for the data layer, mainly for binding typed +data and data collections to components, and for validating data.

-

Package Specification

+

Data binding

-

The package contains a three-tiered structure for typed data objects and -collections of them:

- -
-

-

-

-
+

The package contains a three-tiered structure for typed data +objects and collections of them:

-

In addition to these interfaces the package contains the -{@link com.vaadin.data.Buffered Buffered} interface, which defines -the methods to make an object buffered, that is, track the changes to an -object and allow committing or discarding them at a later time.

- -

Provides interfaces for the validation framework. The framework -defines two interfaces; one for classes that need to support external -validation, and another one for the validators themselves.

+

For more information on the data model, see the Data model +chapter in Book of Vaadin.

-

Validation

- -

The most important method defined by the -{@link com.vaadin.data.Validatable Validatable} interface is -{@link com.vaadin.data.Validatable#isValid() isValid()}. It -asks all registered validators to verify if the object's value is valid -or not. Note that it depends on the validators registered for a object which -values are valid and which are not. For example, a null value -can be valid value for one validator but invalid for another.

+

Buffering

-

In addition to isValid(), Validatable defines -methods to add, remove and list validators of a validatable object.

+

A {@link com.vaadin.data.Buffered Buffered} implementor is able +to track and buffer changes and commit or discard them later.

-

{@link com.vaadin.data.Validator Validator} defines the -interface for an external validator. These validators may be added to -any Validatable object, and their task is to check, when -requested, that the object which they are attached to contains a valid -value. The actual validation logic is hidden in the -{@link com.vaadin.data.Validator#validate(Object) validate(Object)} -method.

+

Validation

-

In addition to check(Object), Validator defines -the InvalidValueException which is used to signal that a -checked value is invalid, and the -{@link com.vaadin.data.Validator.Suggestive Suggestive} -subinterface which includes functionality to suggest a valid value for -the validated object.

+

{@link com.vaadin.data.Validator Validator} implementations are +used to validate data, typically the value of a {@link +com.vaadin.ui.Field Field}. One or more {@link com.vaadin.data.Validator +Validators} can be added to a {@link com.vaadin.data.Validatable +Validatable} implementor and then used to validate the value of the +Validatable.

+ diff --git a/src/com/vaadin/data/util/package.html b/src/com/vaadin/data/util/package.html index 332d8f8143..07e3acde9e 100644 --- a/src/com/vaadin/data/util/package.html +++ b/src/com/vaadin/data/util/package.html @@ -6,32 +6,13 @@ -

Provides various utility classes that implement the data layer -functionality.

+

Provides implementations of Property, Item and Container +interfaces, and utilities for the data layer.

-

The first {@link com.vaadin.data.Property Property} class, -{@link com.vaadin.data.util.ObjectProperty ObjectProperty}, provides -a simple class containing a typed data value. The second, -{@link com.vaadin.data.util.MethodProperty MethodProperty}, provides -a way to bind a field of an object to the Property interface using the -accessor methods for the field.

- -

The next level of the data layer, the -{@link com.vaadin.data.Item Item}, is implemented by -{@link com.vaadin.data.util.BeanItem BeanItem}, though it is only a -simple wrapper to the former to provide the Item interface for any regular -Java Bean.

- -

The third level, the {@link com.vaadin.data.Container Container}, -has several implementations in the {@link com.vaadin.data.util} -package.

- - - - - - - +

Various Property, Item and Container implementations are provided +in this package. Each implementation can have its own sets of +constraints on the data it encapsulates and on how the implementation +can be used. See the class javadocs for more information.

diff --git a/src/com/vaadin/data/validator/package.html b/src/com/vaadin/data/validator/package.html index 8697eb6313..c991bfc82a 100644 --- a/src/com/vaadin/data/validator/package.html +++ b/src/com/vaadin/data/validator/package.html @@ -8,13 +8,16 @@ -

Provides validators for data contained in data-bound objects..

+

Provides various {@link com.vaadin.data.Validator} +implementations.

- +

{@link com.vaadin.data.validator.AbstractValidator +AbstractValidator} provides an abstract implementation of the {@link +com.vaadin.data.Validator} interface and can be extended for custom +validation needs. {@link +com.vaadin.data.validator.AbstractStringValidator +AbstractStringValidator} can also be extended if the value is a String.

- - - -- cgit v1.2.3