Revision 43215 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/FeatureStoreTransform.java

View differences:

FeatureStoreTransform.java
21 21
 * For any additional information, do not hesitate to contact us
22 22
 * at info AT gvsig.com, or visit our website www.gvsig.com.
23 23
 */
24

  
25 24
package org.gvsig.fmap.dal.feature;
26 25

  
27 26
import java.util.List;
......
37 36
 * to a target FeatureType, allowing to build different views (as in database
38 37
 * view) over different feature types even from different stores.
39 38
 *
40
 * @author jmvivo
41
 *
42 39
 */
43
public interface FeatureStoreTransform extends Persistent, Cloneable {
40
public interface FeatureStoreTransform
41
    extends Persistent, Cloneable {
44 42

  
45
	/**
46
	 * Returns the default {@link FeatureType}.
47
	 *
48
	 * @return default {@link FeatureType}
49
	 *
50
	 * @throws DataException
51
	 */
52
	public FeatureType getDefaultFeatureType() throws DataException;
43
    /**
44
     * Returns the default {@link FeatureType}.
45
     *
46
     * @return default {@link FeatureType}
47
     *
48
     * @throws DataException
49
     */
50
    public FeatureType getDefaultFeatureType() throws DataException;
53 51

  
54
	/**
55
	 * Returns this FeatureStoreTransform's FeatureType(s)
56
	 * @return
57
	 * @throws DataException
58
	 */
59
	public List getFeatureTypes() throws DataException;
52
    /**
53
     * Returns this FeatureStoreTransform's FeatureType(s)
54
     *
55
     * @return
56
     * @throws DataException
57
     */
58
    public List<FeatureType> getFeatureTypes() throws DataException;
60 59

  
61
	/**
62
	 * Returns the original store {@link FeatureType} that replaces
63
	 * targetFeatureType of this FeatureStoreTransform's
64
	 *
65
	 * @return source {@link FeatureType}
66
	 * @throws DataException
67
	 */
68
	public FeatureType getSourceFeatureTypeFrom(FeatureType targetFeatureType);
60
    /**
61
     * Returns the original store {@link FeatureType} that replaces
62
     * targetFeatureType of this FeatureStoreTransform's
63
     *
64
     * @return source {@link FeatureType}
65
     */
66
    public FeatureType getSourceFeatureTypeFrom(FeatureType targetFeatureType);
69 67

  
70
	/**
71
	 * Applies this transform between two features, copying the source data to
72
	 * the target feature.
73
	 *
74
	 * @param source
75
	 *            feature whose data will be used as source
76
	 *
77
	 * @param target
78
	 *            feature in which the source data will be copied
79
	 *
80
	 * @throws DataException
81
	 */
82
	public void applyTransform(Feature source, EditableFeature target)
83
			throws DataException;
68
    /**
69
     * Applies this transform between two features, copying the source data to
70
     * the target feature.
71
     *
72
     * @param source feature whose data will be used as source
73
     *
74
     * @param target feature in which the source data will be copied
75
     *
76
     * @throws DataException
77
     */
78
    public void applyTransform(Feature source, EditableFeature target)
79
        throws DataException;
84 80

  
85
	/**
86
	 * Sets the FeatureStore to which this transform is applied.
87
	 *
88
	 * @param featureStore
89
	 *            FeatureStore to which this transform is applied.
90
	 */
91
	public void setFeatureStore(FeatureStore featureStore);
81
    /**
82
     * Sets the FeatureStore to which this transform is applied.
83
     *
84
     * @param featureStore FeatureStore to which this transform is applied.
85
     */
86
    public void setFeatureStore(FeatureStore featureStore);
92 87

  
93
	/**
94
	 * Returns the FeatureStore to which this transform belongs.
95
	 *
96
	 * @return FeatureStore to which this transform belongs.
97
	 */
98
	public FeatureStore getFeatureStore();
88
    /**
89
     * Returns the FeatureStore to which this transform belongs.
90
     *
91
     * @return FeatureStore to which this transform belongs.
92
     */
93
    public FeatureStore getFeatureStore();
99 94

  
100
	/**
101
	 * Retruns true if this make changes of any attributes values or false if
102
	 * only {@link FeatureType} definitions is changed.
103
	 *
104
	 * @see {@link FeatureStoreTransforms#isTransformsOriginalValues()}
105
	 * 
106
	 * @return
107
	 */
108
	public boolean isTransformsOriginalValues();
109
	
110
	public String getName();
111
	
112
	public String getDescription();
95
    /**
96
     * Retruns true if this make changes of any attributes values or false if
97
     * only {@link FeatureType} definitions is changed.
98
     *
99
     * @return
100
     * @see {@link FeatureStoreTransforms#isTransformsOriginalValues()}
101
     *
102
     */
103
    public boolean isTransformsOriginalValues();
113 104

  
114
	/**
115
	 * Sets the original metadata for this transform
116
	 * 
117
	 * @param metadata
118
	 */
119
	public void setSourceMetadata(DynObject metadata);
120
	
121
    public void setDynValue(String name, Object value)
122
            throws DynFieldNotFoundException;
123
    
105
    public String getName();
106

  
107
    public String getDescription();
108

  
109
    /**
110
     * Sets the original metadata for this transform
111
     *
112
     * @param metadata
113
     */
114
    public void setSourceMetadata(DynObject metadata);
115

  
116
    public void setDynValue(String name, Object value) throws DynFieldNotFoundException;
117

  
124 118
    public boolean hasDynValue(String name);
125
    
119

  
126 120
    public Object getDynValue(String name) throws DynFieldNotFoundException;
127
	
121

  
122
    /**
123
     * This method must perform the necessary actions to set up the transformation.
124
     * 
125
     * It is called automatically when adding the transformation to the store 
126
     * and when the store is retrieved from the persistence.
127
     * 
128
     * @throws Exception 
129
     */
130
    public void  setUp() throws Exception ;
128 131
}

Also available in: Unified diff