com.moximedia.aims
Class AimsExtract

java.lang.Object
  extended bycom.moximedia.aims.AimsExtract
All Implemented Interfaces:
java.io.Serializable

public class AimsExtract
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
AimsExtract(AimsMap map)
          Creates a new instance of AimsExtract using a Map object
 
Method Summary
 boolean extract()
          Executes the extract process based on the properties.
 java.lang.String getError()
          Gets the error message, if any.
 java.lang.String getRequest()
          Gets the AXL request.
 java.lang.String getResponse()
          Gets the AXL response.
 java.lang.String getUrl()
          Gets the url to the zipfile created.
 void setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value)
          Sets one of the attributes of this object using a string value.
 void setExtent(AimsEnvelope extent)
          Sets the extent.
 void setExtractServer(java.lang.String server)
          Sets the server to be used for extracting.
 void setExtractService(java.lang.String service)
          Sets the service to be used for extracting.
 void setExtractServlet(java.lang.String path)
          Sets the servlet path to be used for extracting.
 void setLayer(AimsFeatureLayer layer)
          Sets the layer to extract.
 void setLayers(AimsLayers layers)
          Sets the layers to extract.
 void setProjections(AimsCoordsys featureCoordsys, AimsCoordsys filterCoordsys)
          Sets the output projection and filter projection
 void useSelectedSets(boolean flag)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AimsExtract

public AimsExtract(AimsMap map)
Creates a new instance of AimsExtract using a Map object

Parameters:
map - The display map in the IMF.
Method Detail

getError

public java.lang.String getError()
Gets the error message, if any.

Returns:
The last error message.

getRequest

public java.lang.String getRequest()
Gets the AXL request.

Returns:
The last AXL request.

getResponse

public java.lang.String getResponse()
Gets the AXL response.

Returns:
The last AXL response.

getUrl

public java.lang.String getUrl()
Gets the url to the zipfile created.

Returns:
The URL, or null if there isn't one.

setExtent

public void setExtent(AimsEnvelope extent)
Sets the extent.

Parameters:
extent - The extent to select the features to extract. If the extent is null, all features will be extracted.

setExtractServer

public void setExtractServer(java.lang.String server)
Sets the server to be used for extracting. If this is null, use the same server as the map uses.

Parameters:
server - The server used for extracing.

setExtractServlet

public void setExtractServlet(java.lang.String path)
Sets the servlet path to be used for extracting. If this is null, use the same servlet path as the map uses.

Parameters:
path - The servlet path used for extracing.

setExtractService

public void setExtractService(java.lang.String service)
Sets the service to be used for extracting. If this is null, use the same service as the map uses.

Parameters:
service - The service used for extracing.

setProjections

public void setProjections(AimsCoordsys featureCoordsys,
                           AimsCoordsys filterCoordsys)
Sets the output projection and filter projection

Parameters:
featureCoordsys - The coordsys defining the extract projection.
filterCoordsys - The coordsys defining the query filter projection. This should be the same as the display projection of the map in the IMF display.

useSelectedSets

public void useSelectedSets(boolean flag)

setLayers

public void setLayers(AimsLayers layers)
Sets the layers to extract.

Parameters:
layers - The layers to be extracted.

setLayer

public void setLayer(AimsFeatureLayer layer)
Sets the layer to extract.

Parameters:
layer - The layer to be extracted.

extract

public boolean extract()
Executes the extract process based on the properties.

Returns:
True if the operation was successful, otherwise false.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)
Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:
tag - The AXL element tag containing this attribute (not used).
name - The AXL attribute name.
value - The AXL attribute value.