Package muntjac :: Package data
[hide private]
[frames] | no frames]

Source Code for Package muntjac.data

 1  # Copyright (C) 2012 Vaadin Ltd.  
 2  # Copyright (C) 2012 Richard Lincoln 
 3  #  
 4  # Licensed under the Apache License, Version 2.0 (the "License");  
 5  # you may not use this file except in compliance with the License.  
 6  # You may obtain a copy of the License at  
 7  #  
 8  #     http://www.apache.org/licenses/LICENSE-2.0  
 9  #  
10  # Unless required by applicable law or agreed to in writing, software  
11  # distributed under the License is distributed on an "AS IS" BASIS,  
12  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
13  # See the License for the specific language governing permissions and  
14  # limitations under the License. 
15   
16  """Contains interfaces for the data layer, mainly for binding typed 
17  data and data collections to components, and for validating data. 
18   
19  Data binding 
20  ============ 
21   
22  The package contains a three-tiered structure for typed data 
23  objects and collections of them: 
24   
25      - A L{IProperty} represents a single, typed data value. 
26   
27      - An L{IItem} embodies a set of I{Properties}. 
28        A locally unique (inside the L{IItem}) 
29        Property identifier corresponds to each Property inside the Item. 
30      - A L{IContainer} contains a set of Items, each corresponding to a 
31        locally unique Item identifier. Note that Container imposes a few 
32        restrictions on the data stored in it, see L{IContainer} for further 
33        information. 
34   
35  Buffering 
36  ========= 
37   
38  A L{IBuffered} implementor is able to track and buffer changes and commit 
39  or discard them later. 
40   
41  Validation 
42  ========== 
43   
44  L{IValidator} implementations are used to validate data, typically the value 
45  of a L{IField}. One or more L{IValidator} can be added to a L{IValidatable} 
46  implementor and then used to validate the value of the Validatable. 
47  """ 
48