svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.dal / org.gvsig.fmap.dal.api / src / main / java / org / gvsig / fmap / dal / feature / FeatureRule.java @ 44297
History | View | Annotate | Download (2.7 KB)
1 |
/**
|
---|---|
2 |
* gvSIG. Desktop Geographic Information System.
|
3 |
*
|
4 |
* Copyright (C) 2007-2013 gvSIG Association.
|
5 |
*
|
6 |
* This program is free software; you can redistribute it and/or
|
7 |
* modify it under the terms of the GNU General Public License
|
8 |
* as published by the Free Software Foundation; either version 3
|
9 |
* of the License, or (at your option) any later version.
|
10 |
*
|
11 |
* This program is distributed in the hope that it will be useful,
|
12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
14 |
* GNU General Public License for more details.
|
15 |
*
|
16 |
* You should have received a copy of the GNU General Public License
|
17 |
* along with this program; if not, write to the Free Software
|
18 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
19 |
* MA 02110-1301, USA.
|
20 |
*
|
21 |
* For any additional information, do not hesitate to contact us
|
22 |
* at info AT gvsig.com, or visit our website www.gvsig.com.
|
23 |
*/
|
24 |
package org.gvsig.fmap.dal.feature; |
25 |
|
26 |
import org.gvsig.fmap.dal.exception.DataException; |
27 |
|
28 |
/**
|
29 |
* Represents a Feature validation rule. These rules are used to
|
30 |
* check Feature state integrity in editing mode.
|
31 |
*
|
32 |
* Desde una rule que se ejecuta en el UPDATE podemos ejecutar un
|
33 |
* update de esta feature en el store. Pero si la rule se ejecuta
|
34 |
* en el FINISH_EDITING no es posible hacer update de ninguna feature
|
35 |
* del store.
|
36 |
*
|
37 |
*/
|
38 |
public interface FeatureRule { |
39 |
|
40 |
/**
|
41 |
* Returns the rule name
|
42 |
*
|
43 |
* @return
|
44 |
* the rule name
|
45 |
*/
|
46 |
public String getName(); |
47 |
|
48 |
/**
|
49 |
* Returns the rule description
|
50 |
*
|
51 |
* @return
|
52 |
* the rule description
|
53 |
*/
|
54 |
public String getDescription(); |
55 |
|
56 |
/**
|
57 |
* This is the method that applies this rule to the {@link Feature}, given also its associated {@link FeatureStore}.
|
58 |
* @param feature
|
59 |
* Feature to which apply the rule
|
60 |
* @param featureStore
|
61 |
* FeatureStore to which the Feature belongs
|
62 |
* @throws DataException
|
63 |
* if an error occurs during validation
|
64 |
*/
|
65 |
public void validate(Feature feature, FeatureStore featureStore) |
66 |
throws DataException;
|
67 |
|
68 |
/**
|
69 |
* Indicates whether this rule should be checked at update.
|
70 |
*
|
71 |
* Only in this rules can be updated the feature in the store.
|
72 |
*
|
73 |
* @return
|
74 |
* true if this rule should be checked at update, otherwise false.
|
75 |
*/
|
76 |
public boolean checkAtUpdate(); |
77 |
|
78 |
/**
|
79 |
* Returns true if this rule should be applied just when editing is being finished.
|
80 |
*
|
81 |
* In this rules, can't be updated any feature in the store.
|
82 |
*
|
83 |
* @return
|
84 |
* true if this rule should be applied when editing is being finished, otherwise false.
|
85 |
*/
|
86 |
public boolean checkAtFinishEditing(); |
87 |
} |