svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.mapcontext / org.gvsig.fmap.mapcontext.api / src / main / java / org / gvsig / fmap / mapcontext / rendering / legend / styling / ILabelingMethod.java @ 40559
History | View | Annotate | Download (3.39 KB)
1 | 40559 | jjdelcerro | /**
|
---|---|---|---|
2 | * gvSIG. Desktop Geographic Information System.
|
||
3 | 40435 | jjdelcerro | *
|
4 | 40559 | jjdelcerro | * Copyright (C) 2007-2013 gvSIG Association.
|
5 | 40435 | jjdelcerro | *
|
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 | 40559 | jjdelcerro | * as published by the Free Software Foundation; either version 3
|
9 | 40435 | jjdelcerro | * 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 | 40559 | jjdelcerro | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
19 | * MA 02110-1301, USA.
|
||
20 | 40435 | jjdelcerro | *
|
21 | 40559 | jjdelcerro | * For any additional information, do not hesitate to contact us
|
22 | * at info AT gvsig.com, or visit our website www.gvsig.com.
|
||
23 | 40435 | jjdelcerro | */
|
24 | /* CVS MESSAGES:
|
||
25 | *
|
||
26 | * $Id: ILabelingMethod.java 13913 2007-09-20 09:36:02Z jaume $
|
||
27 | * $Log$
|
||
28 | * Revision 1.4 2007-09-20 09:33:15 jaume
|
||
29 | * Refactored: fixed name of IPersistAnce to IPersistence
|
||
30 | *
|
||
31 | * Revision 1.3 2007/03/21 11:01:28 jaume
|
||
32 | * javadoc
|
||
33 | *
|
||
34 | * Revision 1.2 2007/03/09 08:33:43 jaume
|
||
35 | * *** empty log message ***
|
||
36 | *
|
||
37 | * Revision 1.1.2.2 2007/02/01 11:42:47 jaume
|
||
38 | * *** empty log message ***
|
||
39 | *
|
||
40 | * Revision 1.1.2.1 2007/01/30 18:10:45 jaume
|
||
41 | * start commiting labeling stuff
|
||
42 | *
|
||
43 | *
|
||
44 | */
|
||
45 | package org.gvsig.fmap.mapcontext.rendering.legend.styling; |
||
46 | |||
47 | import org.gvsig.fmap.dal.exception.DataException; |
||
48 | import org.gvsig.fmap.dal.feature.FeatureSet; |
||
49 | import org.gvsig.fmap.mapcontext.ViewPort; |
||
50 | import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect; |
||
51 | import org.gvsig.tools.persistence.Persistent; |
||
52 | |||
53 | |||
54 | /**
|
||
55 | * Interface that defines provides support to a ILabelingStrategy to supply
|
||
56 | * the set of <b>LabelClass</b>(es) that handle the label's style, content, etc..
|
||
57 | *
|
||
58 | * @author jaume dominguez faus - jaume.dominguez@iver.es
|
||
59 | */
|
||
60 | public interface ILabelingMethod extends Persistent { |
||
61 | |||
62 | /**
|
||
63 | * Returns all the labels defined by this Labeling Method
|
||
64 | * @return all the labels in this labeling method;
|
||
65 | */
|
||
66 | public ILabelClass[] getLabelClasses(); |
||
67 | |||
68 | /**
|
||
69 | * Returns the LabelClass contained by this ILabelingMethod whose name matches
|
||
70 | * with the string passed in <b>labelName</b>.
|
||
71 | * @param labelName
|
||
72 | * @return
|
||
73 | */
|
||
74 | public ILabelClass getLabelClassByName(String labelName); |
||
75 | |||
76 | /**
|
||
77 | * Adds a LabelClass to the set of LabelClass contained by this ILabelingMethod.
|
||
78 | * @param lbl
|
||
79 | */
|
||
80 | public void addLabelClass(ILabelClass lbl); |
||
81 | |||
82 | /**
|
||
83 | * Removes the LabelClass from the set of LabelClasses contained by this
|
||
84 | * ILabelingMethod.
|
||
85 | * @param lbl, the LabelClass to be removed
|
||
86 | */
|
||
87 | public void deleteLabelClass(ILabelClass lbl); |
||
88 | |||
89 | /**
|
||
90 | * Returns <b>true</b> if this ILabelingMethod allos the definition of more
|
||
91 | * LabelClasses than just the default LabelClass.
|
||
92 | * @return boolean
|
||
93 | */
|
||
94 | public boolean allowsMultipleClass(); |
||
95 | |||
96 | /**
|
||
97 | * Changes the mane of a given LabelClass
|
||
98 | * @param lbl, the LabelClass
|
||
99 | * @param newName, the new name
|
||
100 | */
|
||
101 | public void renameLabelClass(ILabelClass lbl, String newName); |
||
102 | |||
103 | public FeatureSet getFeatureIteratorByLabelClass(FLyrVect layer, ILabelClass lc, ViewPort viewPort, String[] usedFields) |
||
104 | throws DataException;
|
||
105 | |||
106 | public boolean definesPriorities(); |
||
107 | |||
108 | public void setDefinesPriorities(boolean flag); |
||
109 | |||
110 | public void clearAllClasses(); |
||
111 | |||
112 | public ILabelingMethod cloneMethod();
|
||
113 | } |