Revision 14426

View differences:

trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/VectorialIntervalLegend.java
67 67
    private Color endColor = Color.blue;
68 68
    private ZSort zSort;
69 69
    /**
70
     * Crea un nuevo VectorialIntervalLegend.
70
     * Constructor method
71 71
     */
72 72
    public VectorialIntervalLegend() {
73 73
        //defaultSymbol = LegendFactory.DEFAULT_POLYGON_SYMBOL;
74 74
    }
75 75

  
76 76
    /**
77
     * Crea un nuevo VectorialIntervalLegend.
77
     * Constructor method
78 78
     *
79
     * @param type tipo de shape.
79
     * @param type type of the shape.
80 80
     */
81 81
    public VectorialIntervalLegend(int type) {
82 82
        setShapeType(type);
83 83
    }
84 84

  
85
    /**
86
	 * creates the SLD String that defines this legend type.
87
	 */
85

  
88 86
    public String getSLDString(String layerName) {
89 87

  
90 88
    	try{
......
143 141
	    }
144 142
    }
145 143

  
146
    /**
147
     * DOCUMENT ME!
148
     *
149
     * @return DOCUMENT ME!
150
     *
151
     * @see com.iver.cit.gvsig.fmap.rendering.ILegend#getXMLEntity()
152
     */
144
    
153 145
    public XMLEntity getXMLEntity() {
154 146
        XMLEntity xml = new XMLEntity();
155 147
        xml.putProperty("className", this.getClass().getName());
......
192 184
        return xml;
193 185
    }
194 186

  
195
    /**
196
     * Inserta los atributos del XMLEntity.
197
     *
198
     * @param xml XMLEntity.
199
     */
187
    
200 188
    public void setXMLEntity03(XMLEntity xml) {
201 189
        fieldNames = new String[] {xml.getStringProperty("fieldName")};
202 190
        index = xml.getIntProperty("index");
......
237 225
                    "endColor"));
238 226
    }
239 227

  
240
    /**
241
     * Inserta los atributos del XMLEntity.
242
     *
243
     * @param xml XMLEntity.
244
     */
228
   
245 229
    public void setXMLEntity(XMLEntity xml) {
246 230
        fieldNames = new String[] {xml.getStringProperty("fieldName")};
247 231
        index = xml.getIntProperty("index");
......
281 265
                    "endColor"));
282 266
    }
283 267

  
284
    /*
285
     * @see com.iver.cit.gvsig.fmap.rendering.ILegend#cloneLegend()
286
     */
268
    
287 269
    public ILegend cloneLegend() throws XMLException {
288 270
        return LegendFactory.createFromXML(getXMLEntity());
289 271
    }
290 272

  
291 273
    /**
292
	 * Devuelve el color final.
293
	 * @return  color final.
274
	 * Returns the final color
275
	 * @return Color  final color.
294 276
	 * @uml.property  name="endColor"
295 277
	 */
296 278
    public Color getEndColor() {
......
298 280
    }
299 281

  
300 282
    /**
301
	 * Inserta el color final.
302
	 * @param endColor  Color final.
283
	 * Inserts the final color.
284
	 * @param endColor final color.
303 285
	 * @uml.property  name="endColor"
304 286
	 */
305 287
    public void setEndColor(Color endColor) {
......
307 289
    }
308 290

  
309 291
    /**
310
	 * Devuelve el color inicial.
311
	 * @return  Color inicial.
292
	 * Returns the initial color.
293
	 * @return  Color initial color.
312 294
	 * @uml.property  name="startColor"
313 295
	 */
314 296
    public Color getStartColor() {
......
316 298
    }
317 299

  
318 300
    /**
319
	 * Inserta el color inicial.
320
	 * @param startColor  Color inicial.
301
	 * Inserts the initial color
302
	 * @param startColor initial color.
321 303
	 * @uml.property  name="startColor"
322 304
	 */
323 305
    public void setStartColor(Color startColor) {
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/SingleSymbolLegend.java
56 56

  
57 57

  
58 58
/**
59
 * Leyenda se s?mbolo ?nico.
59
 * Implements a legend composed by single symbols.
60
 * 
60 61
 * @author   Vicente Caballero Navarro
61 62
 */
62 63
public class SingleSymbolLegend extends AbstractLegend implements IVectorLegend {
......
64 65
    private int shapeType = FShape.POLYGON; // Por defecto, tipo pol?gono
65 66
	private ZSort zSort;
66 67

  
67

  
68
	/**
69
	 * Constructor method 
70
	 */
68 71
	public SingleSymbolLegend() {	}
69 72

  
70 73

  
71 74
	/**
72
	 * Crea un nuevo SingleSymbolLegend.
75
	 * Constructor method.
73 76
	 *
74 77
	 * @param style S?mbolo.
75 78
	 */
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/QuantityByCategoryLegend.java
17 17
import com.iver.cit.gvsig.fmap.layers.XMLException;
18 18
import com.iver.utiles.XMLEntity;
19 19
/**
20
 * Implements a legend where the user can compare two different characteristics
21
 * of a region in the map. These two "fields" will be compared, on one side, 
22
 * using a color for the region and , on the other side, using a graduated symbol.
23
 * Both methods will change (the color or the size of the symbol) depending on 
24
 * the value of the fields.  
25
 * 
20 26
 * @author jaume dominguez faus - jaume.dominguez@iver.es
21 27
 */
22 28
public class QuantityByCategoryLegend extends AbstractClassifiedVectorLegend implements IClassifiedVectorLegend  {
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/IVectorLegend.java
50 50

  
51 51

  
52 52
/**
53
 * Interfaz de Leyenda Vectorial.
53
 * Interface of a vectorial legend.
54 54
 *
55 55
 * @author Vicente Caballero Navarro
56 56
 */
57 57
public interface IVectorLegend extends ILegend {
58 58
	/**
59
	 * Inserta el DataSource.
59
	 * Inserts the DataSource.
60 60
	 *
61 61
	 * @param ds DataSource.
62 62
	 *
63
	 * @throws FieldNotFoundException cuando el campo no se encuentre.
64
	 * @throws DriverException Cuando falle el driver.
63
	 * @throws FieldNotFoundException when the field is not found.
64
	 * @throws DriverException When the driver fails.
65 65
	 */
66 66
	void setDataSource(DataSource ds)
67 67
		throws FieldNotFoundException, ReadDriverException;
......
80 80
    ISymbol getSymbolByFeature(IFeature feat);
81 81

  
82 82
	/**
83
	 * Devuelve el tipo de shape.
83
	 * Returns the type of the shape.
84 84
	 *
85
	 * @return Devuelve el tipo de shapes para los que est? preparada la
86
	 * 		   leyenda
85
	 * @return Returns the type of the shapes that the legend is ready to use.
86
	 * 
87 87
	 */
88 88
	int getShapeType();
89 89

  
90 90
	/**
91
	 * Inserta el tipo de shape.
91
	 * Defines the type of the shape.
92 92
	 *
93
	 * @param shapeType Tipo de shape.
93
	 * @param shapeType type of the shape.
94 94
	 */
95 95
	void setShapeType(int shapeType);
96 96

  
97 97
	/**
98
	 * Establece el s?mbolo por defecto del Legend. En un Legend de s?mbolo
99
	 * ?nico, el s?mbolo se establece invocando este m?todo
98
	 * Establishes the default symbol of a legend. In a SingleSymbolLegend the symbol
99
	 * is established by calling this method.
100 100
	 *
101
	 * @param s S?mbolo por defecto.
101
	 * @param s default symbol.
102 102
	 * @throws IllegalArgumentException, if the symbol isn't suitable for the
103 103
	 * layer's data type.
104 104
	 */
105 105
	void setDefaultSymbol(ISymbol s) throws IllegalArgumentException;
106 106

  
107 107
	/**
108
	 * Devuelve el XMLEntity.
108
	 * Returns the XMLEntity.
109 109
	 *
110 110
	 * @return XMLEntity.
111 111
	 */
112 112
	XMLEntity getXMLEntity();
113 113

  
114 114
	/**
115
	 * Inserta el XMLEntity.
115
	 * Inserts the XMLEntity.
116 116
	 *
117 117
	 * @param xml XMLEntity.
118 118
	 */
119 119
	void setXMLEntity(XMLEntity xml);
120 120

  
121 121
    /**
122
     * Inserta el XMLEntity.
122
     * Inserts the XMLEntity.
123 123
     *
124 124
     * @param xml XMLEntity.
125 125
     */
126 126
    void setXMLEntity03(XMLEntity xml);
127 127

  
128 128
    /**
129
	 * Devuelve si se utiliza o no el resto de valores para representarse.
130
	 * @return  True si se utiliza el resto de valores.
129
     * Returns true or false depending on if the rest of values are used.
130
	 * 
131
	 * @return  True if the rest of values are used.
131 132
	 */
132 133
    public boolean isUseDefaultSymbol();
133 134

  
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/VectorialUniqueValueLegend.java
71 71
import com.iver.utiles.XMLEntity;
72 72

  
73 73
/**
74
 * Leyenda vectorial por valores ?nicos.
74
 * Vectorial legend for unique values
75
 * 
75 76
 * @author   Vicente Caballero Navarro
76 77
 */
77 78
//public class VectorialUniqueValueLegend implements IVectorialUniqueValueLegend {
......
152 153

  
153 154

  
154 155
    /**
155
     * Crea un nuevo VectorialUniqueValueLegend.
156
     * Constructor method
156 157
     */
157 158
    public VectorialUniqueValueLegend() {
158 159
    }
159 160

  
160 161
    /**
161
     * Crea un nuevo VectorialUniqueValueLegend.
162
     * Constructor method 
162 163
     *
163
     * @param shapeType Tipo de shape.
164
     * @param shapeType Type of the shape.
164 165
     */
165 166
    public VectorialUniqueValueLegend(int shapeType) {
166 167
        setShapeType(shapeType);
......
181 182
    }
182 183

  
183 184
    /**
184
     * Se usa en la tabla que muestra una leyenda.
185
     *	@deprecated use setValueSymbolByID(int id, ISymbol symbol);
185
     * Used in the table that shows the legend
186
     * 
187
     * @deprecated use setValueSymbolByID(int id, ISymbol symbol);
186 188
     * @param id
187 189
     * @param symbol
188 190
     */
......
529 531

  
530 532
    }
531 533
    /**
532
	 * Devuelve el valor a partir de su valor en un string.
534
     * Returns the value using the its value in a string.
535
	 * 
533 536
	 *
534
	 * @param s
535
	 *            String con el valor.
536
	 * @deprecated M?todo utilizado hasta la 1.0 alpha 855 Debes utilizar a partir de ahora getValue(String s,int type);
537
	 * @param s String with the value.
538
	 * @deprecated Method used until 1.0 alpha 855 You should use getValue(String s,int type);
537 539
	 * @return Value.
538 540
	 */
539 541
    private Value getValue(String s) {
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/IVectorialUniqueValueLegend.java
45 45

  
46 46

  
47 47
/**
48
 * Interfaz de leyenda de valores ?nicos.
48
 * Interface for the legend with unique values.
49
 * 
49 50
 */
50 51
public interface IVectorialUniqueValueLegend extends IClassifiedVectorLegend {
51 52
    /**
52
     * Establece el s?mbolo para el valor que se pasa como par?metro
53
     * Establishes the symbol for the value which is the argument of the function. 
53 54
     *
54
     * @param id ?ndice.
55
     * @param symbol s?mbolo.
55
     * @param id index.
56
     * @param symbol symbol.
56 57
     */
57 58
    void setValueSymbolByID(int id, ISymbol symbol);
58 59

  
59 60

  
60 61
    /**
61
     * Devuelve un s?mbolo a partir del ID. Mira en el m_ArrayKeys  el elemento
62
     * ID, y con esa clave recupera el FSymbol por valor
63
     *
62
     * Returns the symbols starting from an ID. It looks in m_ArrayKeys for the
63
     * element ID and with this key obtains the FSymbol. 
64
     
64 65
     * @param key ID.
65 66
     *
66
     * @return s?mbolo que corresponde a ese ID.
67
     * @return symbol associated with the ID
67 68
     */
68 69

  
69 70
    // public FSymbol getSymbolByID(int ID);
70 71

  
71 72
    /**
72
     * Devuelve un s?mbolo a partir de su clave.
73
     * Returns the symbols starting from its key.
73 74
     *
74 75
     * @param key ID.
75 76
     *
76
     * @return s?mbolo que corresponde a ese ID.
77
     * @return symbol associated with the key.
77 78
     */
78 79
    public ISymbol getSymbolByValue(Value key);
79 80
}
trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/rendering/IVectorialIntervalLegend.java
50 50

  
51 51

  
52 52
/**
53
 * Interfaz que ofrece los m?todos para clasificar la Leyenda por intervalos.
53
 * Interface that allows the methods to classify the legend through intervals.
54
 * 
54 55
 */
55 56
public interface IVectorialIntervalLegend extends IClassifiedVectorLegend {
56 57

  
......
65 66
    public ISymbol getSymbol(int recordIndex) throws ReadDriverException;
66 67

  
67 68
    /**
68
	 * Devuelve un s?mbolo a partir de una IFeature.
69
	 * OJO!! Cuando usamos un feature iterator de base de datos
70
	 * el ?nico campo que vendr? rellenado es el de fieldID.
71
	 * Los dem?s vendr?n a nulos para ahorra tiempo de creaci?n.
69
     * Returns a symbol starting from an IFeature.
70
	 * 
71
	 * TAKE CARE!! When we are using a feature iterator as a database
72
	 * the only field that will be filled is the fieldID.
73
	 * The rest of fields will be null to reduce the time of creation
72 74
	 *
73 75
	 * @param feat IFeature.
74 76
	 *
......
77 79
    public ISymbol getSymbolByFeature(IFeature feat);
78 80

  
79 81
	/**
80
	 * Devuelve el s?mbolo a partir del intervalo.
82
	 * 
83
	 * Returns the symbol starting from an interval
81 84
	 *
82
	 * @param key intervalo.
85
	 * @param key interval.
83 86
	 *
84
	 * @return s?mbolo.
87
	 * @return symbol.
85 88
	 */
86 89
    public ISymbol getSymbolByInterval(IInterval key);
87 90

  
88 91

  
89 92
    /**
90
	 * Devuelve si se utiliza o no el resto de valores para representarse.
93
     * Returns if the rest of values are used or not to be represented.
91 94
	 * @deprecated 18-09-07 when moving definitely to FeatureIterators
92
	 * @return True si se utiliza el resto de valores.
95
	 * 
96
	 * @return True if the rest of values are used.
93 97
	 */
94 98

  
95 99
    public void setDataSource(DataSource ds) throws FieldNotFoundException, ReadDriverException;
96 100

  
97 101
    /**
98
	 * Inserta el tipo de clasificaci?n de los intervalos.
102
     * Inserts the type of the classification of the intervals.
99 103
	 *
100
	 * @param tipoClasificacion Tipo de clasificaci?n.
104
	 * @param tipoClasificacion type of the classification.
101 105
	 */
102 106
    public void setIntervalType(int tipoClasificacion);
103 107
}

Also available in: Unified diff