jcoverage | summary | package | file

Coverage details for edu.umn.gis.mapscript.imp.classObj

LineHitsSource
1 // A Java MapScript module for MapServer.
2 // See <http://mapserver.gis.umn.edu> for information on MapServer.
3 //
4 // Copyright (C) 2003 Andrew Collins <andrewrcollins@yahoo.com>
5 //
6 // This library is free software; you can redistribute it
7 // and/or modify it under the terms of the GNU Lesser General
8 // Public License as published by the Free Software Foundation;
9 // either version 2.1 of the License, or (at your option) any
10 // later version.
11 //
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty
14 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 // See the GNU Lesser General Public License for more details.
16 //
17 // You should have received a copy of the GNU Lesser General
18 // Public License along with this library; if not, write to
19 // the Free Software Foundation, Inc., 59 Temple Place,
20 // Suite 330, Boston, MA 02111-1307 USA
21 package edu.umn.gis.mapscript.imp;
22  
23 /**
24  * DOCUMENT ME!
25  *
26  * @author <a href="mailto:ADDRESS">NAME</a>
27  *
28  * @todo CLASS_DESCRIPTION
29  */
30 public class classObj
31 {
32   /**
33    * DOCUMENT ME!
34    *
35    * @todo FIELD_DESCRIPTION
36    */
37   protected boolean swigCMemOwn;
38  
39   /**
40    * DOCUMENT ME!
41    *
42    * @todo FIELD_DESCRIPTION
43    */
44   private long swigCPtr;
45  
46   /**
47    * Creates a new classObj object.
48    *
49    * @param layer PARAMETER
50    */
51   public classObj(layerObj layer)
52   {
530    this(MapScriptJNI.new_classObj(layerObj.getCPtr(layer)), true);
540  }
55  
56   /**
57    * Creates a new classObj object.
58    *
59    * @param cPtr PARAMETER
60    * @param cMemoryOwn PARAMETER
61    */
62   protected classObj(long cPtr, boolean cMemoryOwn)
630  {
640    swigCMemOwn = cMemoryOwn;
650    swigCPtr = cPtr;
660  }
67  
68   /**
69    * Creates a new classObj object.
70    */
71   protected classObj()
72   {
730    this(0, false);
740  }
75  
76   /**
77    * DOCUMENT ME!
78    *
79    * @param backgroundcolor PARAMETER
80    *
81    * @todo METHOD_DESCRIPTION
82    */
83   public void setBackgroundcolor(int backgroundcolor)
84   {
850    MapScriptJNI.set_classObj_backgroundcolor(swigCPtr, backgroundcolor);
860  }
87  
88   /**
89    * DOCUMENT ME!
90    *
91    * @return RETURN
92    *
93    * @todo METHOD_DESCRIPTION
94    */
95   public int getBackgroundcolor()
96   {
970    return MapScriptJNI.get_classObj_backgroundcolor(swigCPtr);
98   }
99  
100   /**
101    * DOCUMENT ME!
102    *
103    * @param color PARAMETER
104    *
105    * @todo METHOD_DESCRIPTION
106    */
107   public void setColor(int color)
108   {
1090    MapScriptJNI.set_classObj_color(swigCPtr, color);
1100  }
111  
112   /**
113    * DOCUMENT ME!
114    *
115    * @return RETURN
116    *
117    * @todo METHOD_DESCRIPTION
118    */
119   public int getColor()
120   {
1210    return MapScriptJNI.get_classObj_color(swigCPtr);
122   }
123  
124   /**
125    * DOCUMENT ME!
126    *
127    * @param string PARAMETER
128    *
129    * @return RETURN
130    *
131    * @todo METHOD_DESCRIPTION
132    */
133   public int setExpression(String string)
134   {
1350    return MapScriptJNI.classObj_setExpression(swigCPtr, string);
136   }
137  
138   /**
139    * DOCUMENT ME!
140    *
141    * @param joins PARAMETER
142    *
143    * @todo METHOD_DESCRIPTION
144    */
145   public void setJoins(SWIGTYPE_p_joinObj joins)
146   {
1470    MapScriptJNI.set_classObj_joins(swigCPtr, SWIGTYPE_p_joinObj.getCPtr(joins));
1480  }
149  
150   /**
151    * DOCUMENT ME!
152    *
153    * @return RETURN
154    *
155    * @todo METHOD_DESCRIPTION
156    */
157   public SWIGTYPE_p_joinObj getJoins()
158   {
1590    return new SWIGTYPE_p_joinObj(MapScriptJNI.get_classObj_joins(swigCPtr),
160       false);
161   }
162  
163   /**
164    * DOCUMENT ME!
165    *
166    * @param label PARAMETER
167    *
168    * @todo METHOD_DESCRIPTION
169    */
170   public void setLabel(labelObj label)
171   {
1720    MapScriptJNI.set_classObj_label(swigCPtr, labelObj.getCPtr(label));
1730  }
174  
175   /**
176    * DOCUMENT ME!
177    *
178    * @return RETURN
179    *
180    * @todo METHOD_DESCRIPTION
181    */
182   public labelObj getLabel()
183   {
1840    return new labelObj(MapScriptJNI.get_classObj_label(swigCPtr), false);
185   }
186  
187   /**
188    * DOCUMENT ME!
189    *
190    * @param maxscale PARAMETER
191    *
192    * @todo METHOD_DESCRIPTION
193    */
194   public void setMaxscale(double maxscale)
195   {
1960    MapScriptJNI.set_classObj_maxscale(swigCPtr, maxscale);
1970  }
198  
199   /**
200    * DOCUMENT ME!
201    *
202    * @return RETURN
203    *
204    * @todo METHOD_DESCRIPTION
205    */
206   public double getMaxscale()
207   {
2080    return MapScriptJNI.get_classObj_maxscale(swigCPtr);
209   }
210  
211   /**
212    * DOCUMENT ME!
213    *
214    * @param maxsize PARAMETER
215    *
216    * @todo METHOD_DESCRIPTION
217    */
218   public void setMaxsize(int maxsize)
219   {
2200    MapScriptJNI.set_classObj_maxsize(swigCPtr, maxsize);
2210  }
222  
223   /**
224    * DOCUMENT ME!
225    *
226    * @return RETURN
227    *
228    * @todo METHOD_DESCRIPTION
229    */
230   public int getMaxsize()
231   {
2320    return MapScriptJNI.get_classObj_maxsize(swigCPtr);
233   }
234  
235   /**
236    * DOCUMENT ME!
237    *
238    * @param name PARAMETER
239    * @param value PARAMETER
240    *
241    * @return RETURN
242    *
243    * @todo METHOD_DESCRIPTION
244    */
245   public int setMetaData(String name, String value)
246   {
2470    return MapScriptJNI.classObj_setMetaData(swigCPtr, name, value);
248   }
249  
250   /**
251    * DOCUMENT ME!
252    *
253    * @param name PARAMETER
254    *
255    * @return RETURN
256    *
257    * @todo METHOD_DESCRIPTION
258    */
259   public String getMetaData(String name)
260   {
2610    return MapScriptJNI.classObj_getMetaData(swigCPtr, name);
262   }
263  
264   /**
265    * DOCUMENT ME!
266    *
267    * @param minscale PARAMETER
268    *
269    * @todo METHOD_DESCRIPTION
270    */
271   public void setMinscale(double minscale)
272   {
2730    MapScriptJNI.set_classObj_minscale(swigCPtr, minscale);
2740  }
275  
276   /**
277    * DOCUMENT ME!
278    *
279    * @return RETURN
280    *
281    * @todo METHOD_DESCRIPTION
282    */
283   public double getMinscale()
284   {
2850    return MapScriptJNI.get_classObj_minscale(swigCPtr);
286   }
287  
288   /**
289    * DOCUMENT ME!
290    *
291    * @param minsize PARAMETER
292    *
293    * @todo METHOD_DESCRIPTION
294    */
295   public void setMinsize(int minsize)
296   {
2970    MapScriptJNI.set_classObj_minsize(swigCPtr, minsize);
2980  }
299  
300   /**
301    * DOCUMENT ME!
302    *
303    * @return RETURN
304    *
305    * @todo METHOD_DESCRIPTION
306    */
307   public int getMinsize()
308   {
3090    return MapScriptJNI.get_classObj_minsize(swigCPtr);
310   }
311  
312   /**
313    * DOCUMENT ME!
314    *
315    * @param name PARAMETER
316    *
317    * @todo METHOD_DESCRIPTION
318    */
319   public void setName(String name)
320   {
3210    MapScriptJNI.set_classObj_name(swigCPtr, name);
3220  }
323  
324   /**
325    * DOCUMENT ME!
326    *
327    * @return RETURN
328    *
329    * @todo METHOD_DESCRIPTION
330    */
331   public String getName()
332   {
3330    return MapScriptJNI.get_classObj_name(swigCPtr);
334   }
335  
336   /**
337    * DOCUMENT ME!
338    *
339    * @param numjoins PARAMETER
340    *
341    * @todo METHOD_DESCRIPTION
342    */
343   public void setNumjoins(int numjoins)
344   {
3450    MapScriptJNI.set_classObj_numjoins(swigCPtr, numjoins);
3460  }
347  
348   /**
349    * DOCUMENT ME!
350    *
351    * @return RETURN
352    *
353    * @todo METHOD_DESCRIPTION
354    */
355   public int getNumjoins()
356   {
3570    return MapScriptJNI.get_classObj_numjoins(swigCPtr);
358   }
359  
360   /**
361    * DOCUMENT ME!
362    *
363    * @param outlinecolor PARAMETER
364    *
365    * @todo METHOD_DESCRIPTION
366    */
367   public void setOutlinecolor(int outlinecolor)
368   {
3690    MapScriptJNI.set_classObj_outlinecolor(swigCPtr, outlinecolor);
3700  }
371  
372   /**
373    * DOCUMENT ME!
374    *
375    * @return RETURN
376    *
377    * @todo METHOD_DESCRIPTION
378    */
379   public int getOutlinecolor()
380   {
3810    return MapScriptJNI.get_classObj_outlinecolor(swigCPtr);
382   }
383  
384   /**
385    * DOCUMENT ME!
386    *
387    * @param overlaybackgroundcolor PARAMETER
388    *
389    * @todo METHOD_DESCRIPTION
390    */
391   public void setOverlaybackgroundcolor(int overlaybackgroundcolor)
392   {
3930    MapScriptJNI.set_classObj_overlaybackgroundcolor(swigCPtr,
394       overlaybackgroundcolor);
3950  }
396  
397   /**
398    * DOCUMENT ME!
399    *
400    * @return RETURN
401    *
402    * @todo METHOD_DESCRIPTION
403    */
404   public int getOverlaybackgroundcolor()
405   {
4060    return MapScriptJNI.get_classObj_overlaybackgroundcolor(swigCPtr);
407   }
408  
409   /**
410    * DOCUMENT ME!
411    *
412    * @param overlaycolor PARAMETER
413    *
414    * @todo METHOD_DESCRIPTION
415    */
416   public void setOverlaycolor(int overlaycolor)
417   {
4180    MapScriptJNI.set_classObj_overlaycolor(swigCPtr, overlaycolor);
4190  }
420  
421   /**
422    * DOCUMENT ME!
423    *
424    * @return RETURN
425    *
426    * @todo METHOD_DESCRIPTION
427    */
428   public int getOverlaycolor()
429   {
4300    return MapScriptJNI.get_classObj_overlaycolor(swigCPtr);
431   }
432  
433   /**
434    * DOCUMENT ME!
435    *
436    * @param overlaymaxsize PARAMETER
437    *
438    * @todo METHOD_DESCRIPTION
439    */
440   public void setOverlaymaxsize(int overlaymaxsize)
441   {
4420    MapScriptJNI.set_classObj_overlaymaxsize(swigCPtr, overlaymaxsize);
4430  }
444  
445   /**
446    * DOCUMENT ME!
447    *
448    * @return RETURN
449    *
450    * @todo METHOD_DESCRIPTION
451    */
452   public int getOverlaymaxsize()
453   {
4540    return MapScriptJNI.get_classObj_overlaymaxsize(swigCPtr);
455   }
456  
457   /**
458    * DOCUMENT ME!
459    *
460    * @param overlayminsize PARAMETER
461    *
462    * @todo METHOD_DESCRIPTION
463    */
464   public void setOverlayminsize(int overlayminsize)
465   {
4660    MapScriptJNI.set_classObj_overlayminsize(swigCPtr, overlayminsize);
4670  }
468  
469   /**
470    * DOCUMENT ME!
471    *
472    * @return RETURN
473    *
474    * @todo METHOD_DESCRIPTION
475    */
476   public int getOverlayminsize()
477   {
4780    return MapScriptJNI.get_classObj_overlayminsize(swigCPtr);
479   }
480  
481   /**
482    * DOCUMENT ME!
483    *
484    * @param overlayoutlinecolor PARAMETER
485    *
486    * @todo METHOD_DESCRIPTION
487    */
488   public void setOverlayoutlinecolor(int overlayoutlinecolor)
489   {
4900    MapScriptJNI.set_classObj_overlayoutlinecolor(swigCPtr, overlayoutlinecolor);
4910  }
492  
493   /**
494    * DOCUMENT ME!
495    *
496    * @return RETURN
497    *
498    * @todo METHOD_DESCRIPTION
499    */
500   public int getOverlayoutlinecolor()
501   {
5020    return MapScriptJNI.get_classObj_overlayoutlinecolor(swigCPtr);
503   }
504  
505   /**
506    * DOCUMENT ME!
507    *
508    * @param overlaysize PARAMETER
509    *
510    * @todo METHOD_DESCRIPTION
511    */
512   public void setOverlaysize(int overlaysize)
513   {
5140    MapScriptJNI.set_classObj_overlaysize(swigCPtr, overlaysize);
5150  }
516  
517   /**
518    * DOCUMENT ME!
519    *
520    * @return RETURN
521    *
522    * @todo METHOD_DESCRIPTION
523    */
524   public int getOverlaysize()
525   {
5260    return MapScriptJNI.get_classObj_overlaysize(swigCPtr);
527   }
528  
529   /**
530    * DOCUMENT ME!
531    *
532    * @param overlaysizescaled PARAMETER
533    *
534    * @todo METHOD_DESCRIPTION
535    */
536   public void setOverlaysizescaled(int overlaysizescaled)
537   {
5380    MapScriptJNI.set_classObj_overlaysizescaled(swigCPtr, overlaysizescaled);
5390  }
540  
541   /**
542    * DOCUMENT ME!
543    *
544    * @return RETURN
545    *
546    * @todo METHOD_DESCRIPTION
547    */
548   public int getOverlaysizescaled()
549   {
5500    return MapScriptJNI.get_classObj_overlaysizescaled(swigCPtr);
551   }
552  
553   /**
554    * DOCUMENT ME!
555    *
556    * @param overlaysymbol PARAMETER
557    *
558    * @todo METHOD_DESCRIPTION
559    */
560   public void setOverlaysymbol(int overlaysymbol)
561   {
5620    MapScriptJNI.set_classObj_overlaysymbol(swigCPtr, overlaysymbol);
5630  }
564  
565   /**
566    * DOCUMENT ME!
567    *
568    * @return RETURN
569    *
570    * @todo METHOD_DESCRIPTION
571    */
572   public int getOverlaysymbol()
573   {
5740    return MapScriptJNI.get_classObj_overlaysymbol(swigCPtr);
575   }
576  
577   /**
578    * DOCUMENT ME!
579    *
580    * @param overlaysymbolname PARAMETER
581    *
582    * @todo METHOD_DESCRIPTION
583    */
584   public void setOverlaysymbolname(String overlaysymbolname)
585   {
5860    MapScriptJNI.set_classObj_overlaysymbolname(swigCPtr, overlaysymbolname);
5870  }
588  
589   /**
590    * DOCUMENT ME!
591    *
592    * @return RETURN
593    *
594    * @todo METHOD_DESCRIPTION
595    */
596   public String getOverlaysymbolname()
597   {
5980    return MapScriptJNI.get_classObj_overlaysymbolname(swigCPtr);
599   }
600  
601   /**
602    * DOCUMENT ME!
603    *
604    * @param size PARAMETER
605    *
606    * @todo METHOD_DESCRIPTION
607    */
608   public void setSize(int size)
609   {
6100    MapScriptJNI.set_classObj_size(swigCPtr, size);
6110  }
612  
613   /**
614    * DOCUMENT ME!
615    *
616    * @return RETURN
617    *
618    * @todo METHOD_DESCRIPTION
619    */
620   public int getSize()
621   {
6220    return MapScriptJNI.get_classObj_size(swigCPtr);
623   }
624  
625   /**
626    * DOCUMENT ME!
627    *
628    * @param sizescaled PARAMETER
629    *
630    * @todo METHOD_DESCRIPTION
631    */
632   public void setSizescaled(int sizescaled)
633   {
6340    MapScriptJNI.set_classObj_sizescaled(swigCPtr, sizescaled);
6350  }
636  
637   /**
638    * DOCUMENT ME!
639    *
640    * @return RETURN
641    *
642    * @todo METHOD_DESCRIPTION
643    */
644   public int getSizescaled()
645   {
6460    return MapScriptJNI.get_classObj_sizescaled(swigCPtr);
647   }
648  
649   /**
650    * DOCUMENT ME!
651    *
652    * @param status PARAMETER
653    *
654    * @todo METHOD_DESCRIPTION
655    */
656   public void setStatus(int status)
657   {
6580    MapScriptJNI.set_classObj_status(swigCPtr, status);
6590  }
660  
661   /**
662    * DOCUMENT ME!
663    *
664    * @return RETURN
665    *
666    * @todo METHOD_DESCRIPTION
667    */
668   public int getStatus()
669   {
6700    return MapScriptJNI.get_classObj_status(swigCPtr);
671   }
672  
673   /**
674    * DOCUMENT ME!
675    *
676    * @param symbol PARAMETER
677    *
678    * @todo METHOD_DESCRIPTION
679    */
680   public void setSymbol(int symbol)
681   {
6820    MapScriptJNI.set_classObj_symbol(swigCPtr, symbol);
6830  }
684  
685   /**
686    * DOCUMENT ME!
687    *
688    * @return RETURN
689    *
690    * @todo METHOD_DESCRIPTION
691    */
692   public int getSymbol()
693   {
6940    return MapScriptJNI.get_classObj_symbol(swigCPtr);
695   }
696  
697   /**
698    * DOCUMENT ME!
699    *
700    * @param symbolname PARAMETER
701    *
702    * @todo METHOD_DESCRIPTION
703    */
704   public void setSymbolname(String symbolname)
705   {
7060    MapScriptJNI.set_classObj_symbolname(swigCPtr, symbolname);
7070  }
708  
709   /**
710    * DOCUMENT ME!
711    *
712    * @return RETURN
713    *
714    * @todo METHOD_DESCRIPTION
715    */
716   public String getSymbolname()
717   {
7180    return MapScriptJNI.get_classObj_symbolname(swigCPtr);
719   }
720  
721   /**
722    * DOCUMENT ME!
723    *
724    * @param template PARAMETER
725    *
726    * @todo METHOD_DESCRIPTION
727    */
728   public void setTemplate(String template)
729   {
7300    MapScriptJNI.set_classObj_template(swigCPtr, template);
7310  }
732  
733   /**
734    * DOCUMENT ME!
735    *
736    * @return RETURN
737    *
738    * @todo METHOD_DESCRIPTION
739    */
740   public String getTemplate()
741   {
7420    return MapScriptJNI.get_classObj_template(swigCPtr);
743   }
744  
745   /**
746    * DOCUMENT ME!
747    *
748    * @param layer PARAMETER
749    * @param string PARAMETER
750    *
751    * @return RETURN
752    *
753    * @todo METHOD_DESCRIPTION
754    */
755   public int setText(layerObj layer, String string)
756   {
7570    return MapScriptJNI.classObj_setText(swigCPtr, layerObj.getCPtr(layer),
758       string);
759   }
760  
761   /**
762    * DOCUMENT ME!
763    *
764    * @param title PARAMETER
765    *
766    * @todo METHOD_DESCRIPTION
767    */
768   public void setTitle(String title)
769   {
7700    MapScriptJNI.set_classObj_title(swigCPtr, title);
7710  }
772  
773   /**
774    * DOCUMENT ME!
775    *
776    * @return RETURN
777    *
778    * @todo METHOD_DESCRIPTION
779    */
780   public String getTitle()
781   {
7820    return MapScriptJNI.get_classObj_title(swigCPtr);
783   }
784  
785   /**
786    * DOCUMENT ME!
787    *
788    * @param type PARAMETER
789    *
790    * @todo METHOD_DESCRIPTION
791    */
792   public void setType(int type)
793   {
7940    MapScriptJNI.set_classObj_type(swigCPtr, type);
7950  }
796  
797   /**
798    * DOCUMENT ME!
799    *
800    * @return RETURN
801    *
802    * @todo METHOD_DESCRIPTION
803    */
804   public int getType()
805   {
8060    return MapScriptJNI.get_classObj_type(swigCPtr);
807   }
808  
809   /**
810    * DOCUMENT ME!
811    *
812    * @param map PARAMETER
813    * @param layer PARAMETER
814    * @param width PARAMETER
815    * @param height PARAMETER
816    *
817    * @return RETURN
818    *
819    * @todo METHOD_DESCRIPTION
820    */
821   public imageObj createLegendIcon(mapObj map, layerObj layer, int width,
822     int height)
823   {
8240    return new imageObj(MapScriptJNI.classObj_createLegendIcon(swigCPtr,
825         mapObj.getCPtr(map), layerObj.getCPtr(layer), width, height), false);
826   }
827  
828   /**
829    * DOCUMENT ME!
830    *
831    * @todo METHOD_DESCRIPTION
832    */
833   public void delete()
834   {
8350    if ((swigCPtr != 0) && swigCMemOwn)
836     {
8370      MapScriptJNI.delete_classObj(swigCPtr);
8380      swigCMemOwn = false;
839     }
840  
8410    swigCPtr = 0;
8420  }
843  
844   /**
845    * DOCUMENT ME!
846    *
847    * @param map PARAMETER
848    * @param layer PARAMETER
849    * @param width PARAMETER
850    * @param height PARAMETER
851    * @param dstImage PARAMETER
852    * @param dstX PARAMETER
853    * @param dstY PARAMETER
854    *
855    * @return RETURN
856    *
857    * @todo METHOD_DESCRIPTION
858    */
859   public int drawLegendIcon(mapObj map, layerObj layer, int width, int height,
860     imageObj dstImage, int dstX, int dstY)
861   {
8620    return MapScriptJNI.classObj_drawLegendIcon(swigCPtr, mapObj.getCPtr(map),
863       layerObj.getCPtr(layer), width, height, imageObj.getCPtr(dstImage), dstX,
864       dstY);
865   }
866  
867   /**
868    * DOCUMENT ME!
869    *
870    * @param obj PARAMETER
871    *
872    * @return RETURN
873    *
874    * @todo METHOD_DESCRIPTION
875    */
876   public boolean equals(Object obj)
877   {
8780    boolean equal = false;
879  
8800    if (obj instanceof classObj)
881     {
8820      equal = (((classObj) obj).swigCPtr == this.swigCPtr);
883     }
884  
8850    return equal;
886   }
887  
888   /**
889    * DOCUMENT ME!
890    *
891    * @param obj PARAMETER
892    *
893    * @return RETURN
894    *
895    * @todo METHOD_DESCRIPTION
896    */
897   protected static long getCPtr(classObj obj)
898   {
8990    return obj.swigCPtr;
900   }
901  
902   /**
903    * DOCUMENT ME!
904    *
905    * @todo METHOD_DESCRIPTION
906    */
907   protected void finalize()
908   {
9090    delete();
9100  }
911 }

jcoverage | summary | package | file

this report was generated by version 1.0.2 of jcoverage.
visit www.jcoverage.com for updates.

copyright © 2003, jcoverage ltd. all rights reserved.
Java is a trademark of Sun Microsystems, Inc. in the United States and other countries.