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

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

All Implemented Interfaces:

Serializable

public class LayoutOutput
extends Output

The LayoutOutput object is used in conjunction with the ArcIMS ArcMap Server. The LayoutOutput object holds the output locations for the associated layout file. The LayoutOutput object extends the Output object.

See Also:

Serialized Form

Constructor Summary

LayoutOutput()
Constructs an instance of a LayoutOutput object.

Method Summary

String	getBaseURL() Returns the baseurl value for the LayoutOutput 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 LayoutOutput object's extract file name value.
String	getPath() Returns the LayoutOutput objects path value.
String	getType() Returns the type of Output object, "Layout".
void	setBaseURL(String value) Sets the baseurl value for the LayoutOutput 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

LayoutOutput

public LayoutOutput()

Constructs an instance of a LayoutOutput object.

LayoutOutput layout = new LayoutOutput();

Method Detail

getType

public String getType()

Returns the type of Output object, "Layout".

String type = layout.getType();

Specified by:

getType in class Output

Returns:

String

setPath

public void setPath(String value)

Paired with setBaseURL. Assigns an output location for files to be generated based on request or response type. Example:

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

Parameters:

value - the output path value.

See Also:

getPath()

getPath

public String getPath()

Returns the LayoutOutput objects path value.

String path = layout.getPath();

Returns:

String

See Also:

setPath(java.lang.String)

setBaseURL

public void setBaseURL(String value)

Sets the baseurl value for the LayoutOutput object. Base URL 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 LayoutOutput object. Example:

String baseURL = LayoutOutput.getBaseURL();

Returns:

String

See Also:

setBaseURL(java.lang.String)

setName

public void setName(String value)

Sets the output filename. Example:

mapOutput.setName("Layout");

Parameters:

value - the file name value.

See Also:

getName()

getName

public String getName()

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

String name = LayoutOutput.getName();

Returns:

String

See Also:

setName(java.lang.String)

setFileType

public void setFileType(String value)

Sets the output image file type. Example:

LayoutOutput.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 = LayoutOutput.getFileType();

Returns:

String

See Also:

setFileType(java.lang.String)

setFile

public void setFile(String value)

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

layoutOutput.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 = layoutOutput.getFile();

Returns:

String

See Also:

setFile(java.lang.String)