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

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

All Implemented Interfaces:

Serializable

public class ExtractOutput
extends Output

Supports parameters that describe an extract response from an ArcIMS service. The ExtractOutput object extends the Output object.

See Also:

Serialized Form

Constructor Summary

ExtractOutput()
Constructs a new instance of an ExtractOutput object.

Method Summary

String	getBaseURL() Returns the baseurl for this ExtractOutput object.
String	getFile() Returns the full pathname and filename of the output file.
String	getName() Returns the extract file name associated with this ExtractOutput object.
String	getPath() Returns the file path of this ExtractOutput object from the response.
String	getType() Returns the output file type as string.
void	setBaseURL(String value) Sets the given string as the Baseurl for the ExtractOutput object.
void	setFile(String value) Sets the full pathname and filename for the output file.
void	setName(String value) Sets the name of the output file.
void	setPath(String value) This method is paired with the setBaseURL method and is used to assign an output location for the files to be generated.

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

ExtractOutput

public ExtractOutput()

Constructs a new instance of an ExtractOutput object. Example:

ExtractOutput extractOutput = new ExtractOutput();

Method Detail

getType

public String getType()

Returns the output file type as string. Example:

String type = extractOutput.getType();

Specified by:

getType in class Output

Returns:

an output string - "Extract"

setFile

public void setFile(String value)

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

extractOutput.setFile("extract");

Parameters:

value - the pathname and filename value.

See Also:

getFile()

getFile

public String getFile()

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

String file = extractOutput.getFile();

Returns:

the pathname and filename of the output file as string

See Also:

setFile(java.lang.String)

setBaseURL

public void setBaseURL(String value)

Sets the given string as the Baseurl for the ExtractOutput object. The Baseurl is the output directory used, if the default filename is generated by ArcIMS. Do not include filename. Example:

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

Parameters:

value - the url value.

See Also:

getBaseURL()

getBaseURL

public String getBaseURL()

Returns the baseurl for this ExtractOutput object. Example:

String baseURL = extractOutput.getBaseURL();

Returns:

String

See Also:

setBaseURL(java.lang.String)

setName

public void setName(String value)

Sets the name of the output file. Example:

extractOutput.setName("extract");

Parameters:

value - the file name value.

See Also:

getName()

getName

public String getName()

Returns the extract file name associated with this ExtractOutput object. Example:

String name = extractOutput.getName();

Returns:

the extract file name as a String

See Also:

setName(java.lang.String)

setPath

public void setPath(String value)

This method is paired with the setBaseURL method and is used to assign an output location for the files to be generated. Example: >

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

Parameters:

value - the output path value.

See Also:

getPath()

getPath

public String getPath()

Returns the file path of this ExtractOutput object from the response. Example:

String path = extractOutput.getPath();

Returns:

the file path as a String

See Also:

setPath(java.lang.String)