Revision 775

View differences:

org.gvsig.scripting/trunk/org.gvsig.scripting/org.gvsig.scripting.app/org.gvsig.scripting.app.mainplugin/src/main/resources-plugin/scripting/lib/gvsig/javadocs/scripting/geom.java
43 43
    public static final int UNKNOWN = Geometry.SUBTYPES.UNKNOWN;
44 44

  
45 45
    /**
46
     * 
47
     * @param type
48
     * @param subtype, optional, default 2D
49
     * @return 
46
     * Returns a new geometry with a concrete type and subtype or None if can't
47
     * create geometry.
48
     *
49
     * @param type: geometry type
50
     * @type type: int
51
     * @param subtype, optional: geometry subtype
52
     * @type subtype: int
53
     * @return geometry
54
     * @rtype geometry
55
     *
50 56
     */
51 57
    public static Geometry createGeometry(int type, int subtype) {
52 58
        return null;
53 59
    }
54 60
  
55 61
    /**
62
     * Create a Point2D. If values of x and y are None, it will create an
63
     * empty Point2D geometry
64
     *
65
     * @param vertexes, optional: vertexes of a new line
66
     * @type vertexes, list of coordinates or list of geometry points
67
     * @return line geometry
68
     */
69
    public static Geometry createPoint2D(double x, double y, int subtype) {
70
        return null;
71
    }
72

  
73
    /**
74
     * Create a Line2D. If vertexes value is None it will 
75
     * create an empty Line2D geometry.
76
     *
77
     * @param vertexes, optional: vertexes of a new line
78
     * @type vertexes, list of coordinates or list of geometry points
79
     * @return line geometry
80
     */
81
    public static Geometry createLine2D(Object vertexes) {
82
        return null;
83
    }
84
    
85
    /**
86
     * Create a Polygon2D. If vertexes value is None it will 
87
     * create an empty Polygon2D.
88
     *
89
     * @param vertexes, optional: vertexes of a new line
90
     * @type vertexes, list of coordinates or list of geometry points
91
     * @return line geometry
92
     */
93
    public static Geometry createPolygon2D(Object vertexes) {
94
        return null;
95
    }
96
    
97
    /**
56 98
     * 
57
     * @param x
58
     * @param y
59
     * @param subtype, optional, defiult 2D
99
     * Returns a new point with a subtype and sets the value for the X, Y, Z and M
100
     * coordinates (default 0,0,0,0) or None if can't create point or none coordinates
101
     * are established.
102
     * 
103
     * If you pass a point geometry as a parameter, it will return the same geometry point.
104
     *
105
     *
106
     * Examples:
107
     *     createPoint(D2, 1, 2) -> Point2D(1, 2)
108
     *     createPoint(D2, [1, 2]) -> Point2D(1, 2)
109
     *
110
     *     createPoint(D3, 1, 2, 3) -> Point3D(1,2,3)
111
     *     createPoint(D2M, 1, 2, 4) -> Point (1, 2, 4)
112
     *     createPoint(D3M, 1, 2, 3, 4) -> Point (1, 2, 3, 4)
113
     *
114
     *     createPoint(D2, Point2D(1, 2) -> Point2D(1, 2)
115
     *     
116
     *
117
     * @param subtype, geometry subtype
118
     * @type subtype: int
119
     * @param coords, list of coordinates or points
60 120
     * @return 
61 121
     */
62
    public static Geometry createPoint(double x, double y, int subtype) {
122
    public static Geometry createPoint(int subtype, double... coords)  {
63 123
        return null;
64
    }
65
  
124
    }  
125
    
66 126
    /**
67 127
     * 
68
     * @param subtype, optional, defiult 2D
128
     * Returns a new multipoint with a subtype from a list of Points instancesor list
129
     * of coordinates.
130
     * If points are None, returns an empty multipoint geometry. If it can't create
131
     * the geometry, return None.
132
     *
133
     * @param subtype, geometry subtype
134
     * @type subtype, int
135
     * @param points, list of coordinates or points
136
     * @return 
69 137
     */
70
    public static Geometry createMultiPoint(int subtype, Object... parameters) {
138
    public static Geometry createMultiPoint(int subtype, Object points) {
71 139
        return null;
72 140
    }
73 141

  
74
    public static Geometry createPolygon(int subtype, Object... parameters) {
142
    /**
143
     * 
144
     * Returns a new polygon with a subtype from a list of Points instances or list
145
     * of tuples/lists like [[x1, y1], [x2, y2], ...., [xn, yn]] are
146
     * allowed. If points are None, returns an empty polygon geometry. If it can't create
147
     * the geometry, return None.
148
     *
149
     * Example:
150
     * createPolygon( D2, [point1, point2, [10, 10], point1])
151
     *
152
     * @param subtype, geometry subtype
153
     * @type subtype, int
154
     * @param vertexes, list of coordinates or points
155
     * @return 
156
     */
157
    public static Geometry createPolygon(int subtype, Object vertexes) {
75 158
        return null;
76 159
    }
77 160

  
78
    public static Geometry createMultiPolygon(int subtype, Object... parameters) {
161
    /**
162
     * 
163
     * Returns a new multipolygon with a subtype from a list of Polygon instances or list
164
     * of coordinates.
165
     * If polygons are None, returns an empty multipolygon geometry. If it can't create
166
     * the geometry, return None.
167
     *
168
     * Example:
169
     * createMultiPolygon( D2, [polygon1, [[0,0],[10,0],point1,[0,0]], polygon3])
170
     *
171
     * @param subtype, geometry subtype
172
     * @type subtype, int
173
     * @param polygons, list of polygons.
174
     * @return 
175
     */
176
    public static Geometry createMultiPolygon(int subtype, Object polygons) {
79 177
        return null;        
80 178
    }  
81
  
82
    public static Geometry createLine(int subtype, Object... parameters) {
179
    
180
    /**
181
     * 
182
     * Returns a new line with a subtype from a list of Points instances or list 
183
     * of coordinates as tuples/lists like ([x1, y1], [x2, y2], ...., [xn, yn]) are
184
     * allowed. If points are None, returns an empty line geometry. If it can't create
185
     * the geometry, return None.
186
     *
187
     * Example:
188
     * createLine( D2, [point0, [10,0], [10, 10], point0]) 
189
     *
190
     * @param subtype, geometry subtype
191
     * @type subtype, int
192
     * @param vertexes, list of coordinates or points
193
     * @return 
194
     */
195
    public static Geometry createLine(int subtype, Object vertexes) {
83 196
        return null;        
84 197
    }  
85

  
86
    public static Geometry createMultiLine(int subtype, Object... parameters) {
198
    
199
    /**
200
     * 
201
     * Returns a new multiline with a subtype from a list of Line instances or list
202
     * of coordinates.
203
     * If polygons are None, returns an empty multipolygon geometry. If it can't create
204
     * the geometry, return None.
205
     *
206
     * Example:
207
     * createMultiLine( D2, [line1, [[0,0],[10,0],point1], line3])
208
     *
209
     * @param subtype, geometry subtype
210
     * @type subtype, int
211
     * @param lines, list of lines.
212
     * @return 
213
     */
214
    public static Geometry createMultiLine(int subtype, Object lines) {
87 215
        return null;        
88 216
    }  
217
    
89 218

  
90 219
    /**
91
     * 
92
     * @param pointMax
93
     * @param pointMin
220
     * Returns envelope as a minimum bounding box or rectangle. This envelope is
221
     * equivalent to the GM_Envelope specified in ISO 19107. If points are None it will
222
     * create an empty Envelope
223
     *
224
     * @param pointMax, optional, None by default
225
     * @type pointMax, list of coordinates or geometry point
226
     * @param pointMin, optional, None by default
227
     * @type pointMin, list of coordinates or geometry point
94 228
     * @param dimension
95 229
     * @return 
96 230
     */
97 231
    public static Envelope createEnvelope(Object pointMax, Object pointMin, int dimension) {
98 232
        return null;        
99 233
    }  
234
        
235
    /**
236
     * Create geometry from WKT (Well Known Text)
237
     *
238
     * @param WKT
239
     * @type WKT, string
240
     * @return 
241
     */
242
    public static Geometry createGeometryFromWKT(String WKT) {
243
        return null;
244
    }  
100 245
    
246
    
247
    
101 248
}
org.gvsig.scripting/trunk/org.gvsig.scripting/org.gvsig.scripting.app/org.gvsig.scripting.app.mainplugin/src/main/resources-plugin/scripting/lib/gvsig/javadocs/scripting/gvsig.java
73 73
     *
74 74
     * Excamples of use:<br>
75 75
     * <code>
76
     * TODO
76
     * layer = createLayer(schema=schema,
77
     *                   servertype="FilesystemExplorer",
78
     *                   layertype="Shape",
79
     *                   shpFile="/home/osc/temp/test1.shp",
80
     *                   CRS="EPSG:25830",
81
     *                   geometryType=POINT
82
     *                   )
77 83
     * </code>
78 84
     *
79 85
     * @param schema the schema to use to create la layer.
......
83 89
     * @return the new created layer
84 90
     *
85 91
     */
86
    public static FLayer creaetLayer(FeatureType schema, String serverType, String layerType, Object... parameters) {
92
    public static FLayer createLayer(FeatureType schema, String serverType, String layerType, Object... parameters) {
87 93
        return null;
88 94
    }
89 95

  
......
97 103
     * @param parameters
98 104
     * @return
99 105
     */
100
    public static FLayer creaetLayer(FeatureType schema, String layerType, Object... parameters) {
106
    public static FLayer createLayer(FeatureType schema, String layerType, Object... parameters) {
101 107
        return null;
102 108
    }
103 109

  
......
129 135
    /**
130 136
     * Load an existing layer and return it.
131 137
     *
132
     * Valid values of layer type are: - Shape - TODO
138
     * Valid values of layer type are: 
139
     * - Shape 
140
     * - Gdal Store
141
     * - TODO
133 142
     *
143
     * Examples:
144
     *     loadLayer("Shape", shpFile=xfile, CRS="EPSG:25830")
145
     *     loadLayer("Gdal Store", uri=raster_uri)
146
     *
134 147
     * @param layerType
135 148
     * @param parameters
136 149
     * @return
......
195 208
     * <li>Gdal Store</li>
196 209
     * </ul>
197 210
     *
211
     * Example with PostgreSQL connection:
212
     * <code>
213
     * from gvsig.utils import openStore
214
     *
215
     * os = openStore('PostgreSQL',_entity_='Persistence%3APostgreSQLStoreParameters',
216
     *                             port='5432',
217
     *                             JDBCDriverClass='org.postgresql.Driver',
218
     *                             UseSSL='false',
219
     *                             Schema='public',
220
     *                             Catalog='',
221
     *                             URL='jdbc%3Apostgresql%3A%2F%2Flocalhost%3A5432%2Fej1',
222
     *                             BaseOrder='',
223
     *                             Workingarea=None,
224
     *                             CRS='EPSG:23030',
225
     *                             PKFields='gid',
226
     *                             BaseFilter='',
227
     *                             DefaultGeometryField='geom',
228
     *                             Fields='gid%2Cnombre%2Cpoblacion%2Cgeom',
229
     *                             Table='ciudades',
230
     *                             SQL='',
231
     *                             password='postgres',
232
     *                             dbname='ej1',
233
     *                             host='localhost',
234
     *                             dbuser='postgres',
235
     *                             ProviderName='PostgreSQL')
236
     * </code>
237
     *
198 238
     * @param storeType the type of store to open.
199 239
     * @param parameters to open the store.
200 240
     * @return the opened data store

Also available in: Unified diff