/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 - Diff - gvSIG scripting - gvSIG

Revision 742 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

     package scripting;
     import org.cresques.cts.IProjection;
     import org.gvsig.fmap.dal.DataStore;
     import org.gvsig.fmap.dal.feature.FeatureType;
     import org.gvsig.fmap.mapcontext.layers.FLayer;
     import org.gvsig.scripting.app.extension.ScriptingExtension;
     /**
      * Representa al modulo python "gvsig".
+     *
      * Es el modulo base que nos facilita el acceso a todos
      * los componentes de gvSIG.
+     *
      * Puede encontrar un modelo simplificado de objetos mas usadas en
      * <a href="../doc-files/simplified-object-model.html">Modelo simplificado de objetos</a>
      * Es el modulo base que nos facilita el acceso a todos los componentes de
      * gvSIG.
+     *
+     *
      */
     public class gvsig {
       /**
        * Returns a new and empty attributes definition.
+       *
        * @deprecated use createFeatureType instead
        */
       public static FeatureType createSchema() {
         return null;
+      }
       /**
        * Returns a new and empty attributes definition based in an
        * existing schema.
+       *
        * @deprecated use createFeatureType instead
        */
       public static FeatureType createSchema(FeatureType schema) {
         return null;
+      }
       /**
        * Returns a new and empty attributes definition.
+       *
        */
       public static FeatureType createFeatureType() {
         return null;
+      }
       /**
        * Returns a new and empty attributes definition based in an
        * existing schema.
+       *
        */
       public static FeatureType createFeatureType(FeatureType schema) {
         return null;
+      }
         public static int LOGGER_INFO = ScriptingExtension.INFO;
         public static int LOGGER_WARN = ScriptingExtension.WARN;
         public static int LOGGER_ERROR = ScriptingExtension.ERROR;
       /**
         * Create a new layer with the specified parameters.
+        *
         * The paramaters "..." are used to connect to the server type and
         * create the layer.
+        *
         * Valid values of server type are:
         * - FilesystemExplorer
         * - TODO
+        *
         * Valid values of layer type are:
         * - Shape
         * - TODO
+        *
         * Excamples of use:
         * TODO
+        *
         * @param schema the schema to use to create la layer.
         * @param serverType The server type (filesystem, BBDD, ...)
         * @param layerType The layer type to create (Shape, ...)
+        *
         */
       public static FLayer creaetLayer(FeatureType schema, String serverType, String layerType, Object... parameters) {
         return null;
+      }
       /**
         * Create a new layer with the specified parameters.
+        *
         * Use as default serverType the "FilesystemExplorer".
+        *
         */
       public static FLayer creaetLayer(FeatureType schema, String layerType, Object... parameters) {
         return null;
+      }
         /**
          * Returns a new and empty attributes definition.
+         *
          * @return the new FeatureType
          */
         public static FeatureType createFeatureType() {
             return null;
+        }
       /**
         * Load an existing shape file in the current view.
+        *
         * @param path path to the shape file to load
         * @param projection to use to load the shape file
          * @return
+        *
         */
       public static FLayer loadShapeFile(String path, String projection) {
         return null;
+      }
       /**
         * Load an existing shape file in the current view.
+        *
         * Use as default projection "CRS:84"
+        *
         * @param path path to the shape file to load
          * @return
+        *
         */
       public static FLayer loadShapeFile(String path) {
         return null;
+      }
       /**
         * Load an existing layer and return it.
+        *
         * Valid values of layer type are:
         * - Shape
         * - TODO
+        *
         * @param layerType
          * @param <error>
          * @return
+        *
         */
       public static FLayer loadLayer(String layerType, Object... parameters) {
         return null;
+      }
         /**
          * Returns a new and empty attributes definition based in an existing
          * FeatureType.
+         *
          * All attributes in the feature type pased as parameters are created in the
          * new definition
+         *
          * @param featureType from the new attributes are copied
          * @return The new FeatureType
          */
         public static FeatureType createFeatureType(FeatureType featureType) {
             return null;
+        }
       /*
       def createShape(definition, filename, geometryType, CRS="CRS:84"):
       """
       Return new shape layer
       :param definition: layer data definition
       :type definition: Schema
       :param filename: absolute path for shape files.
       :type filename: string
       :param geometryType: geometry type for shape
       :type geometryType: string
       :return: new shape layer
       :rtype: Layer
       """
       return createLayer(
         definition,
         "FilesystemExplorer",
         "Shape",
         shpFile=filename,
         CRS=CRS,
         geometryType = geometryType
+      )
         /**
          * Create a new layer with the specified parameters.
+         *
          * The paramaters are used to connect to the server type and create the
          * layer. These parameters are specific of each type of layer.
+         *
          * Valid values of server type are:
          * <ul>
          * <li>FilesystemExplorer</li>
          * <li>PostgreSQLExplorer</li>
          * <li>WFSServerExplorer</li>
          * <li>Wms Store</li>
          * <li>...</li>
          * </ul>
+         *
          * Valid values of layer type are:
          * <ul>
          * <li>Shape</li>
          * <li>Dbf</li>
          * <li>DXF</li>
          * <li>DGN</li>
          * <li>DWG</li>
          * <li>JExcel</li>
          * <li>PostgreSQL</li>
          * <li>WFSStore</li>
          * <li>Gdal Store</li>
          * <li>...</li>
          * </ul>
+         *
          * Excamples of use:<br>
          * <code>
          * TODO
          * </code>
+         *
          * @param schema the schema to use to create la layer.
          * @param serverType The server type (filesystem, BBDD, ...)
          * @param layerType The layer type to create (Shape, ...)
          * @param parameters the specific parameters to create the new layer
          * @return the new created layer
+         *
          */
         public static FLayer creaetLayer(FeatureType schema, String serverType, String layerType, Object... parameters) {
             return null;
+        }
     def createTable(schema, servertype, tableType=None, **parameters):
       """Creates a new Table document"""
       if tableType == None:
         tableType = servertype
         servertype = "FilesystemExplorer"
         /**
          * Create a new layer with the specified parameters.
+         *
          * Use as default serverType the "FilesystemExplorer".
+         *
          * @param schema
          * @param layerType
          * @param parameters
          * @return
          */
         public static FLayer creaetLayer(FeatureType schema, String layerType, Object... parameters) {
             return null;
+        }
       try:
         application = ApplicationLocator.getManager()
         datamanager =  application.getDataManager()
         server_parameters = datamanager.createServerExplorerParameters(servertype)
         copyToDynObject(parameters, server_parameters)
         /**
          * Load an existing shape file in the current view.
+         *
          * @param path path to the shape file to load
          * @param projection to use to load the shape file
          * @return
+         *
          */
         public static FLayer loadShapeFile(String path, String projection) {
             return null;
+        }
         server = datamanager.openServerExplorer(servertype, server_parameters)
         store_parameters = server.getAddParameters(tableType)
         copyToDynObject(parameters, store_parameters)
         store_parameters.setDefaultFeatureType(schema())
         server.add(tableType, store_parameters, True)
         /**
          * Load an existing shape file in the current view.
+         *
          * Use as default projection "CRS:84"
+         *
          * @param path path to the shape file to load
          * @return
+         *
          */
         public static FLayer loadShapeFile(String path) {
             return null;
+        }
         store = datamanager.openStore(tableType, store_parameters)
         return store
       except Throwable, ex:
         raise RuntimeException("Can't create table, "+ str(ex))
     def createDBF(definition, DbfFile, CRS="CRS:84"):
       """
       Creates a new dbf document
       :param definition: layer data definition
       :type definition: Schema
       :param DbfFile: absolute path for shape files.
       :type DbfFile: string
       :return: new dbf
       :rtype: Table
       """
       return createTable(
         definition,
         "FilesystemExplorer",
         "DBF",
         DbfFile=DbfFile,
         CRS=CRS,
+      )
         /**
          * Load an existing layer and return it.
+         *
          * Valid values of layer type are: - Shape - TODO
+         *
          * @param layerType
          * @param parameters
          * @return
+         *
          */
         public static FLayer loadLayer(String layerType, Object... parameters) {
             return null;
+        }
         /**
          * Send a message to the log system.
+         *
          * The values of mode are:
          * <ul>
          * <li>LOGGER_INFO</li>
          * <li>LOGGER_WARN</li>
          * <li>LOGGER_ERROR</li>
          * </ul>
+         *
          * @param msg to send to log
          * @param mode message type, is optional with defaul of LOGGER_INFO.
          * @param exception an exception to log, is optional.
          */
         public static void logger(String msg, int mode, Throwable exception) {
     #=====================#
     # Simbology Functions #
     #=====================#
     COLORS = {
         'black': Color.black,
         'blue': Color.blue,
         'cyan': Color.cyan,
         'darkGray': Color.darkGray,
         'gray': Color.gray,
         'green': Color.green,
         'lightGray': Color.lightGray,
         'magenta': Color.magenta,
         'orange': Color.orange,
         'pink': Color.pink,
         'red': Color.red,
         'white': Color.white,
         'yellow': Color.yellow,
+    }
     def simplePointSymbol(color=None):
       """
       Returns simple point symbol using parameter color. If no color
       use a ramdom color
       :param color: String color name or Java awt Color
       :return: gvSIG point symbol
       """
       if isinstance(color, str) and COLORS.has_key(color.lower()):
         color = COLORS.get(color)
       if not isinstance(color, Color):
           color = getDefaultColor()
       return MapContextLocator.getSymbolManager().createSymbol(
             Geometry.TYPES.POINT, color)
+        }
     def simpleLineSymbol(color=None):
       """
       Returns simple line symbol using parameter color. If no color use a
       ramdom color
       :param color: String color name or Java awt Color
       :return: gvSIG line symbol
       """
       if isinstance(color, str) and COLORS.has_key(color.lower()):
         color = COLORS.get(color)
         /**
          * Create the path to a resource.
+         *
          * This function runs like the os.path.join, but if the first argument is a
          * full path name to a file, it only get the dirname of it.
+         *
          * This is usefull to use with the variable __file__ as the first argument
          * to get a path name to a resource relative to the current module.
+         *
          * Explample:<br>
          * <code>
          *  pathname = getResource(__file__,"data","icon.png")
          * </code>
+         *
          * @param parameters parts of path to the resource.
          * @return the path name to the resource.
          */
         public String getResource(String... parameters) {
             return null;
+        }
       if not isinstance(color, Color):
           color = getDefaultColor()
       return MapContextLocator.getSymbolManager().createSymbol(
             Geometry.TYPES.CURVE, color)
     def simplePolygonSymbol(color = None):
       """
       Returns simple polygon symbol using parameter color. If no color
       use a ramdom color.
       :param color: String color name or Java awt Color
       :return: gvSIG polygon symbol
       """
       if isinstance(color, str) and COLORS.has_key(color.lower()):
         color = COLORS.get(color)
       if not isinstance(color, Color):
           color = getDefaultColor()
       return MapContextLocator.getSymbolManager().createSymbol(
             Geometry.TYPES.SURFACE, color)
     #=========================================#
     # gvSIG Application Preferences Functions #
     #=========================================#
     def getDataFolder():
       """
       Returns gvSIG data folder. This folder is defined in application
       preferences. If is not defined returns None.
       """
       return Preferences.userRoot().node("gvsig.foldering").get('DataFolder', None)
     def getProjectsFolder():
       """
       Returns gvSIG projects folder. This folder is defined in application
       preferences. If is not defined returns None.
       """
       return Preferences.userRoot().node("gvsig.foldering").get(
             'ProjectsFolder', None)
     def getColorFromRGB(r, g, b, a=None):
       """
       Returns an sRGB color with the specified red, green, blue, and alpha
       (optional) values in the range (0 - 255).
       """
       if a:
         color = Color(r, g, b, a)
       else:
         color = Color(r, g, b)
       return color
     def getDefaultColor(c = None):
       """Returns gvsig default symbol fill color or ramdom color"""
       if MapContextLocator.getSymbolManager().isDefaultSymbolFillColorAleatory():
         color = Color(random.randint(0-255),
                     random.randint(0-255),
                     random.randint(0-255)
+                )
       else:
         sp = MapContextLocator.getSymbolManager().getSymbolPreferences()
         color = sp.getDefaultSymbolFillColor()
       return color
     */
         /**
          * Open an existen data store an return it.
+         *
          * The type of store depened of store to be opened. It can be:
          * <ul>
          * <li>Shape</li>
          * <li>Dbf</li>
          * <li>DXF</li>
          * <li>DGN</li>
          * <li>DWG</li>
          * <li>JExcel</li>
          * <li>PostgreSQL</li>
          * <li>WFSStore</li>
          * <li>Gdal Store</li>
          * </ul>
+         *
          * @param storeType the type of store to open.
          * @param parameters to open the store.
          * @return the opened data store
          */
         public DataStore openStore(String storeType, Object... parameters) {
             return null;
+        }
         /**
          * Create a new projectionobject associated with the passed name of
          * the projection.
+         *
          * Usually, the name is the abbreviation of the projection.
+         *
          * Is preferable to use this method <code>CRSFactory.getCRS(name)</code> instead.
+         *
          * @param name abbreviation of the projection
          * @return the projection object associated with the name
          */
         public IProjection getCRS(String name) {
             return null;
+        }
         /**
          * Return the default data folder of gvSIG.
          * This is configured in the preferences of gvSIG.
+         *
          * @return the data folder of gvSIG
          */
         public String getDataFolder() {
             return null;
+        }
         /**
          * Return the default projects folder of gvSIG.
          * This is configured in the preferences of gvSIG.
+         *
          * @return the projects folder of gvSIG.
          */
         public String getProjectsFolder() {
             return null;
+        }
+    }

Also available in: Unified diff

Application: gvSIG desktop » gvSIG scripting

Revision 742 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