com.esri.aims.mtier.model.map.output
Class MapOutput

java.lang.Object
  com.esri.aims.mtier.model.map.output.Output
      com.esri.aims.mtier.model.map.output.MapOutput

All Implemented Interfaces:

Serializable

public class MapOutput
extends Output

The MapOutput object contains all of the map images output properties. The MapOutput object also holds the locations for generated map image. The MapOutput object extends the Output object.

See Also:

Serialized Form

Constructor Summary

MapOutput()
Creates an instance of the MapOutput object.

Method Summary

String	getBaseURL() Returns the baseurl value for the MapOutput object.
String	getFile() Returns the full pathname and filename for location of output file.
String	getFileType() Returns the output image file type.
String	getName() Returns the ExtractOutput object's extract file name value.
String	getPath() Returns the MapOutput file path value from the response.
String	getType() Returns the type of Output, "Map".
void	setBaseURL(String value) Sets the baseurl value for the MapOutput object.
void	setFile(String value) Sets the full pathname and filename for location of output file.
void	setFileType(String value) Sets the output image file type.
void	setName(String value) Sets the output filename.
void	setPath(String value) Paired with setBaseURL.

Methods inherited from class com.esri.aims.mtier.model.map.output.Output

getOutputURL, getURL, setOutputURL, setURL, setURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapOutput

public MapOutput()

Creates an instance of the MapOutput object. Example:

MapOutput mapOutput = new MapOutput();

Method Detail

getType

public String getType()

Returns the type of Output, "Map". Example:

String type= mapOutput.getType();

Specified by:

getType in class Output

Returns:

String

setFile

public void setFile(String value)

Sets the full pathname and filename for location of output file. Example:

mapOutput.setFile("Map");

Parameters:

value - the pathname and filename value.

See Also:

getFile()

getFile

public String getFile()

Returns the full pathname and filename for location of output file. Example:

String file = mapOutput.getFile();

Returns:

String

See Also:

setFile(java.lang.String)

setBaseURL

public void setBaseURL(String value)

Sets the baseurl value for the MapOutput object. baseurl is the output directory if default filename is generated by ArcIMS. Do not include filename. Example:

mapOutput.setBaseURL("http://www.mapper.com");

Parameters:

value - the url value.

See Also:

getBaseURL()

getBaseURL

public String getBaseURL()

Returns the baseurl value for the MapOutput object. Example:

String baseURL = mapOutput.getBaseURL();

Returns:

String

See Also:

setBaseURL(java.lang.String)

setName

public void setName(String value)

Sets the output filename. Example:

mapOutput.setName("Map");

Parameters:

value - the file name value.

See Also:

getName()

getName

public String getName()

Returns the ExtractOutput object's extract file name value. Example:

String name = mapOutput.getName();

Returns:

String

See Also:

setName(java.lang.String)

setPath

public void setPath(String value)

Paired with setBaseURL. Assigns an output location for files to be generated. Example:

mapOutput.setPath("C:/ArcIMS/Output");

Parameters:

value - the output path value.

See Also:

getPath()

getPath

public String getPath()

Returns the MapOutput file path value from the response. Example:

String path = mapOutput.getPath();

Returns:

String

See Also:

setPath(java.lang.String)

setFileType

public void setFileType(String value)

Sets the output image file type. Example:

mapOutput.setFileType("png");

Parameters:

value - the output file type value.

See Also:

getFileType()

getFileType

public String getFileType()

Returns the output image file type. Example:

String type = mapOutput.getFileType();

Returns:

String

See Also:

setFileType(java.lang.String)