Geomajas Community Documentation
The commands are all registered in the Spring context. The "registry key" as indicated below is used to retrieve the commands. These are services, so a singleton should be sufficient for this.
The default naming for the keys is derived from the fully qualified class name. This is automatically assigned when the command is in a (sub package of) the "command" package. To determine the bean name, all parent packages of the "command" package are removed. Then the name is simplified. It will end up having "command." as prefix, optionally followed by a package, followed by the name. As there already is a "command" prefix, the "Command" suffix is removed from the name if present. When the resulting name starts or end with the sub package, then that is removed as well. For example the "org.geomajas.command.configuration.GetConfigurationCommand" class will get "command.configuration.Get" as registry key.
CopyrightCommand | |
---|---|
Registry key | command.general.Copyright |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.EmptyCommandRequest |
Parameters | none |
Description | This allows you to obtain copyright and license information for Geomajas, it's dependencies, the plg-ins and the dependencies of the plug-ins. This can be used to display that information in a "about" box to assure the copyright and license conditions are adhered. |
Response object class | org.geomajas.command.dto.CopyrightResponse |
Response values | List of CopyrightInfo objects for the
dependencies. Any duplicates are removed based on the
copyright info key. |
Table 6.1. CopyrightCommand
GetConfigurationCommand | |
---|---|
Registry key | command.configuration.Get |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.EmptyCommandRequest |
Parameters | none |
Description | Get the client side configuration information. This returns information about all maps which have been configured. |
Response object class | org.geomajas.command.dto.GetConfigurationResponse |
Response values |
|
Table 6.2. GetConfigurationCommand
GetMapConfigurationCommand | |
---|---|
Registry key | command.configuration.GetMap |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.GetMapConfigurationRequest |
Parameters |
|
Description | Get the client side configuration information for the specified map. |
Response object class | org.geomajas.command.dto.GetMapConfigurationResponse |
Response values |
|
Table 6.3. GetMapConfigurationCommand
GetRasterTilesCommand | |
---|---|
Registry key | command.render.GetRasterTiles |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.GetRasterTilesRequest |
Parameters |
|
Description | Retrieve a set of raster tiles as image links for a given layer within a certain bounding box expressed in a certain coordinate reference system. |
Response object class | org.geomajas.command.dto.GetRasterTilesResponse |
Response values |
|
Table 6.4. GetRasterTilesCommand
GetVectorTileCommand | |
---|---|
Registry key | command.render.GetVectorTile |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.GetVectorTileRequest |
Parameters |
|
Description | Fetches a single tile for a vector layer. The tile can contain both vectors and labels. This command is used to paint vector layers in the map. |
Response object class | org.geomajas.command.dto.GetVectorTileResponse |
Response values |
|
Table 6.5. GetVectorTileCommand
LogCommand | |
---|---|
Registry key | command.general.Log |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.LogRequest |
Parameters |
|
Description | This allows you to send a statement to the server side which will be logged there. |
Response object class | org.geomajas.command.CommandResponse |
Response values | none |
Table 6.6. LogCommand
MergePolygonCommand | |
---|---|
Registry key | command.geometry.MergePolygon |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.MergePolygonRequest |
Parameters |
|
Description | This command allows the user to merge multiple polygons into a single polygon or multipolygon. |
Response object class | org.geomajas.command.dto.MergePolygonResponse |
Response values |
|
Table 6.7. MergePolygonCommand
PersistFeatureTransactionCommand | |
---|---|
Registry key | command.feature.PersistTransaction |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.PersistTransactionRequest |
Parameters |
|
Description | Persist a single transaction on the backend (create, update, delete of features). |
Response object class | org.geomajas.command.dto.PersistTransactionResponse |
Response values |
|
Table 6.8. PersistTransactionCommand
SearchAttributesCommand | |
---|---|
Registry key | command.feature.SearchAttributes |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.SearchAttributesRequest |
Parameters |
|
Description | Search for attribute possible values for a certain attribute. This command is only used for many-to-one and one-to-many relationships, to search for possible values. |
Response object class | org.geomajas.command.dto.SearchAttributesResponse |
Response values |
|
Table 6.9. SearchAttributesCommand
SearchByLocationCommand | |
---|---|
Registry key | command.feature.SearchByLocation |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.SearchByLocationRequest |
Parameters |
|
Description | This command allows you to search for features, based on geographic location. |
Response object class | org.geomajas.command.dto.SearchByLocationResponse |
Response values |
|
Table 6.10. SearchByLocationCommand
SearchFeaturesCommand | |
---|---|
Registry key | command.feature.Search |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.SearchFeatureRequest |
Parameters |
|
Description | This command allows you to search for features, based criteria which allow matching on feature attributes. You can specify multiple search criteria and a filter. |
Response object class | org.geomajas.command.dto.SearchFeatureResponse |
Response values |
|
Table 6.11. SearchFeatureCommand
SplitPolygonCommand | |
---|---|
Registry key | command.geometry.SplitPolygon |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.SplitPolygonRequest |
Parameters |
|
Description | Split up a geometry into many pieces by means of a splitting geometry. |
Response object class | org.geomajas.command.dto.SplitPolygonResponse |
Response values |
|
Table 6.12. SplitPolygonCommand
UserMaximumExtentCommand | |
---|---|
Registry key | command.configuration.UserMaximumExtent |
Module which provides this command | geomajas-command |
Request object class | org.geomajas.command.dto.UserMaximumExtentRequest |
Parameters |
|
Description | Get the bounding box of the visible features across the requested layers (visible area for the raster layers). |
Response object class | org.geomajas.command.dto.UserMaximumExtentResponse |
Response values |
|
Table 6.13. UserMaximumExtentCommand