Revision 29391 branches/v2_0_0_prep/libraries/libFMap_dal/src/org/gvsig/fmap/dal/feature/spi/FeatureReferenceProviderServices.java

View differences:

FeatureReferenceProviderServices.java
1
/* gvSIG. Geographic Information System of the Valencian Government
2
 *
3
 * Copyright (C) 2007-2008 Infrastructures and Transports Department
4
 * of the Valencian Government (CIT)
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 2
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
 */
22

  
23
/*
24
 * AUTHORS (In addition to CIT):
25
 * 2008 {{Company}}   {{Task}}
26
 */
27

  
1 28
package org.gvsig.fmap.dal.feature.spi;
2 29

  
3 30
import org.gvsig.fmap.dal.feature.FeatureReference;
31
import org.gvsig.fmap.dal.feature.FeatureType;
4 32

  
33
/**
34
 * Interface for feature references services for feature based data providers
35
 *
36
 *
37
 * @author jmvivo
38
 *
39
 */
5 40
public interface FeatureReferenceProviderServices extends FeatureReference {
6 41

  
42
	/**
43
	 * Return the OID (Object IDentifier) object that represents this reference
44
	 *
45
	 * <strong>Note:</strong> this can be <code>null</code> if provider does not
46
	 * support OID
47
	 *
48
	 * @return <code>Object</code> that identifies a feature
49
	 *
50
	 * @see FeatureStoreProvider#getOIDType()
51
	 * @see FeatureType#hasOID()
52
	 */
7 53
	public Object getOID();
8 54

  
55
	/**
56
	 * Return the attribute names that compound the Primary Key of represented
57
	 * feature
58
	 *
59
	 * @return attribute names
60
	 *
61
	 * @see #getKeyValue(String)
62
	 */
9 63
	public String[] getKeyNames();
10 64

  
65
	/**
66
	 * Return the value of an attribute that compound the Primary Key of
67
	 * represented feature
68
	 *
69
	 * @param name
70
	 * @return
71
	 *
72
	 * @see #getKeyNames()
73
	 */
11 74
	public Object getKeyValue(String name);
12 75

  
76
	/**
77
	 * Inform that represented feature is not stored in the original data store
78
	 *
79
	 * @return true if not in the original store
80
	 */
13 81
	public boolean isNewFeature();
14 82

  
83
	/**
84
	 * Return the identifier of the {@link FeatureType} of the represented
85
	 * feature
86
	 *
87
	 * @return
88
	 */
15 89
	public String getFeatureTypeId();
16 90

  
17 91
}

Also available in: Unified diff