Statistics
| Revision:

root / trunk / libraries / libFMap / src / com / iver / cit / gvsig / fmap / rendering / VectorialLegend.java @ 1034

History | View | Annotate | Download (2.36 KB)

1
package com.iver.cit.gvsig.fmap.rendering;
2

    
3
import com.hardcode.gdbms.engine.data.DataSource;
4
import com.hardcode.gdbms.engine.instruction.FieldNotFoundException;
5

    
6
import com.iver.cit.gvsig.fmap.DriverException;
7
import com.iver.cit.gvsig.fmap.core.v02.FSymbol;
8

    
9
import com.iver.utiles.XMLEntity;
10

    
11

    
12
/**
13
 * Interfaz de Leyenda Vectorial.
14
 *
15
 * @author Vicente Caballero Navarro
16
 */
17
public interface VectorialLegend extends Legend {
18
        /**
19
         * Inserta el DataSource.
20
         *
21
         * @param ds DataSource.
22
         *
23
         * @throws FieldNotFoundException cuando el campo no se encuentre.
24
         * @throws DriverException Cuando falle el driver.
25
         */
26
        void setDataSource(DataSource ds)
27
                throws FieldNotFoundException, DriverException;
28

    
29
        /**
30
         * Devuelve el s?mbolo asociado al objeto que se pasa como par?metro. Si se
31
         * pasa null se devuelve el s?mbolo por defecto. En un Legend de s?mbolo
32
         * ?nico siempre se devuelve dicho s?mbolo
33
         *
34
         * @param recordIndex ?ndice
35
         *
36
         * @return S?mbolo.
37
         *
38
         * @throws DriverException
39
         */
40
        FSymbol getSymbol(int recordIndex) throws DriverException;
41

    
42
        /**
43
         * Devuelve el tipo de shape.
44
         *
45
         * @return Devuelve el tipo de shapes para los que est? preparada la
46
         *                    leyenda
47
         */
48
        int getShapeType();
49

    
50
        /**
51
         * Inserta el tipo de shape.
52
         *
53
         * @param shapeType Tipo de shape.
54
         */
55
        void setShapeType(int shapeType);
56

    
57
        /**
58
         * Establece el s?mbolo por defecto del Legend. En un Legend de s?mbolo
59
         * ?nico, el s?mbolo se establece invocando este m?todo
60
         *
61
         * @param s S?mbolo por defecto.
62
         */
63
        void setDefaultSymbol(FSymbol s);
64

    
65
        /**
66
         * Establece el campo por el que se etiqueta. -1 quita el etiquetado
67
         *
68
         * @param fieldName Nombre del campo.
69
         */
70
        void setLabelField(String fieldName);
71

    
72
        /**
73
         * Obtiene el ?ndice del campo que sirve de etiquetado o -1 si no ha sido
74
         * etiquetado
75
         *
76
         * @return nombre del campo.
77
         */
78
        String getLabelField();
79

    
80
        /**
81
         * Devuelve el alto de campo.
82
         *
83
         * @return alto.
84
         */
85
        String getLabelHeightField();
86

    
87
        /**
88
         * Devuelve la rotaci?n.
89
         *
90
         * @return Rotaci?n.
91
         */
92
        String getLabelRotationField();
93

    
94
        /**
95
         * Devuelve el XMLEntity.
96
         *
97
         * @return XMLEntity.
98
         */
99
        XMLEntity getXMLEntity();
100

    
101
        /**
102
         * Inserta el XMLEntity.
103
         *
104
         * @param xml XMLEntity.
105
         */
106
        void setXMLEntity(XMLEntity xml);
107

    
108
        /*
109
         * supplierCardinality 0..*
110
         *
111
               /*# FInterval lnkFInterval; */
112
        /*supplierCardinality 0..*
113
         *
114
               private LegendListener[] listeners;*/
115
}