<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>
<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>
<body bgcolor="white">
-<p>This package is the base of Vaadin. The base package
-contains the Application class, the starting point of any aplication that uses Vaadin.
-The sub-packages from this point contain application components and utilities.
-</p>
+<p>The Vaadin base package. Contains the Application class, the
+starting point of any application that uses Vaadin.</p>
-<h2>Package Specification</h2>
+<p>Contains all Vaadin core classes. A Vaadin application is based
+on the {@link com.vaadin.Application} class and deployed as a servlet
+using {@link com.vaadin.terminal.gwt.server.ApplicationServlet} or
+{@link com.vaadin.terminal.gwt.server.GAEApplicationServlet} (for Google
+App Engine).</p>
- <b>Vaadin is composed of the following packages:</b>
- <dl>
- <dt>com.vaadin.data</dt>
- <dd>A library of interfaces for transparently binding UI components to datasources.</dd>
- <dt>com.vaadin.data.util</dt>
- <dd>Basic implementations of data-intfaces and utidtties for working with data-bound components.</dd>
- <dt>com.vaadin.data.validator</dt>
- <dd>Classes providing data-validation for Properties.</dd>
- <dt>com.vaadin.event</dt>
- <dd>Interfaces defining how to send and recieve events.</dd>
- <dt>com.vaadin.service</dt>
- <dd>Classes provding miscelaneous utidtty services.</dd>
- <dt>com.vaadin.terminal</dt>
- <dd>Classes and interfaces for implementing the terminal specific adapters.</dd>
- <dt>com.vaadin.terminal.web</dt>
- <dd>Classes that implement support both for AJAX-based and more limited web browsers.</dd>
- <dt>com.vaadin.ui</dt>
- <dd>UI components.</dd>
- </dl>
+<p>Vaadin applications can also be deployed as portlets using {@link
+com.vaadin.terminal.gwt.server.ApplicationPortlet] (JSR-168) or {@link
+com.vaadin.terminal.gwt.server.ApplicationPortlet2} (JSR-286).</p>
+
+<p>All classes in Vaadin are serializable unless otherwise noted.
+This allows Vaadin applications to run in cluster and cloud
+environments.</p>
-<!-- Put @see and @since tags down here. -->
</body>
</html>
projects / vaadin-framework.git / commitdiff
