diff options
| author | Artur Signell <artur.signell@itmill.com> | 2010-05-10 14:58:27 +0000 |
|---|---|---|
| committer | Artur Signell <artur.signell@itmill.com> | 2010-05-10 14:58:27 +0000 |
| commit | 39f7583a4937f921b762fbd78effe7ded96534ed (patch) | |
| tree | b909d6ebceb66898e47172a30ea09aa53e96e373 /src/com/vaadin/data | |
| parent | 5b5b4970584df91f136ef5c198ba2d42113deee3 (diff) | |
| download | vaadin-framework-39f7583a4937f921b762fbd78effe7ded96534ed.tar.gz vaadin-framework-39f7583a4937f921b762fbd78effe7ded96534ed.zip | |
Updated package javadoc for #4248
svn changeset:13122/svn branch:6.4
Diffstat (limited to 'src/com/vaadin/data')
| -rw-r--r-- | src/com/vaadin/data/doc-files/Container_full.gif | bin | 9870 -> 0 bytes | |||
| -rw-r--r-- | src/com/vaadin/data/doc-files/Container_simple.gif | bin | 7448 -> 0 bytes | |||
| -rw-r--r-- | src/com/vaadin/data/doc-files/Item.gif | bin | 2694 -> 0 bytes | |||
| -rw-r--r-- | src/com/vaadin/data/doc-files/Property.gif | bin | 1415 -> 0 bytes | |||
| -rw-r--r-- | src/com/vaadin/data/doc-files/datalayer.gif | bin | 7595 -> 0 bytes | |||
| -rw-r--r-- | src/com/vaadin/data/package.html | 95 | ||||
| -rw-r--r-- | src/com/vaadin/data/util/package.html | 31 | ||||
| -rw-r--r-- | src/com/vaadin/data/validator/package.html | 13 |
8 files changed, 43 insertions, 96 deletions
diff --git a/src/com/vaadin/data/doc-files/Container_full.gif b/src/com/vaadin/data/doc-files/Container_full.gif Binary files differdeleted file mode 100644 index 28ee720e32..0000000000 --- a/src/com/vaadin/data/doc-files/Container_full.gif +++ /dev/null diff --git a/src/com/vaadin/data/doc-files/Container_simple.gif b/src/com/vaadin/data/doc-files/Container_simple.gif Binary files differdeleted file mode 100644 index 6db32581b8..0000000000 --- a/src/com/vaadin/data/doc-files/Container_simple.gif +++ /dev/null diff --git a/src/com/vaadin/data/doc-files/Item.gif b/src/com/vaadin/data/doc-files/Item.gif Binary files differdeleted file mode 100644 index 4cd202ceba..0000000000 --- a/src/com/vaadin/data/doc-files/Item.gif +++ /dev/null diff --git a/src/com/vaadin/data/doc-files/Property.gif b/src/com/vaadin/data/doc-files/Property.gif Binary files differdeleted file mode 100644 index 4aff19db1c..0000000000 --- a/src/com/vaadin/data/doc-files/Property.gif +++ /dev/null diff --git a/src/com/vaadin/data/doc-files/datalayer.gif b/src/com/vaadin/data/doc-files/datalayer.gif Binary files differdeleted file mode 100644 index b3d25639e0..0000000000 --- a/src/com/vaadin/data/doc-files/datalayer.gif +++ /dev/null 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 @@ <body bgcolor="white"> -<p>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.</p> +<p>Contains interfaces for the data layer, mainly for binding typed +data and data collections to components, and for validating data.</p> -<h2>Package Specification</h2> +<h2>Data binding</h2> -<p>The package contains a three-tiered structure for typed data objects and -collections of them:</p> - -<center> -<p><a href=Property.html target="classFrame"><img src=doc-files/Property.gif></a></p> -<p><a href=Item.html target="classFrame"><img src=doc-files/Item.gif></a></p> -<p><a href=Container.html target="classFrame"><img src=doc-files/Container_simple.gif></a></p> -</center> +<p>The package contains a three-tiered structure for typed data +objects and collections of them:</p> <ul> - <li>The simplest of these is the - {@link com.vaadin.data.Property Property} which represents a - single typed data value. A Property may be read-only in which - case attempts to modify its contents will throw an exception. - - <li>The second level of the data layer is represented by the - {@link com.vaadin.data.Item Item} which embodies a set of - <i>Properties</i>. Each Property in an Item corresponds to a locally - unique(that is, inside the Item) identifier. - - <li>The third level is called the - {@link com.vaadin.data.Container Container} which can be - visualized as a set of Items, each corresponding to a locally unique - identifier. Note that the Container imposes a few restrictions on the - data stored in it, see further documentation in the - <a href=Container.html target="classFrame">class specification</a>. + <li>A {@link com.vaadin.data.Property Property} represents a + single, typed data value. + + <li>An {@link com.vaadin.data.Item Item} embodies a set of <i>Properties</i>. + A locally unique (inside the {@link com.vaadin.data.Item Item}) + Property identifier corresponds to each Property inside the Item.</li> + <li>A {@link com.vaadin.data.Container Container} contains 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, see + {@link com.vaadin.data.Container Container} for further information.</li> </ul> -<p>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.</p> - -<p>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.</p> +<p>For more information on the data model, see the <a + href="http://vaadin.com/book/-/page/datamodel.html">Data model +chapter</a> in Book of Vaadin.</p> -<h2>Validation</h2> - -<p>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 <code>null</code> value -can be valid value for one validator but invalid for another.<p> +<h2>Buffering</h2> -<p>In addition to <code>isValid()</code>, <code>Validatable</code> defines -methods to add, remove and list validators of a validatable object.</p> +<p>A {@link com.vaadin.data.Buffered Buffered} implementor is able +to track and buffer changes and commit or discard them later.</p> -<p>{@link com.vaadin.data.Validator Validator} defines the -interface for an external validator. These validators may be added to -any <code>Validatable</code> 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.</p> +<h2>Validation</h2> -<p>In addition to <code>check(Object)</code>, <code>Validator</code> defines -the <code>InvalidValueException</code> 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.</p><!-- Put @see and @since tags down here. --> +<p>{@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. </p> +<!-- Put @see and @since tags down here. --> </body> </html> 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 @@ <body bgcolor="white"> -<p>Provides various utility classes that implement the data layer -functionality.</p> +<p>Provides implementations of Property, Item and Container +interfaces, and utilities for the data layer.</p> -<p>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.</p> - -<p>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.</p> - -<p>The third level, the {@link com.vaadin.data.Container Container}, -has several implementations in the {@link com.vaadin.data.util} -package.</p> - -<!-- <h2>Package Specification</h2> --> - -<!-- Package spec here --> - - -<!-- Put @see and @since tags down here. --> +<p>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.</p> </body> </html> 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 @@ <!-- Package summary here --> -<p>Provides validators for data contained in data-bound objects..</p> +<p>Provides various {@link com.vaadin.data.Validator} +implementations.</p> -<!-- <h2>Package Specification</h2> --> +<p>{@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.</p> -<!-- Package spec here --> - -<!-- Put @see and @since tags down here. --> </body> </html> |
