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

java.lang.Object
  extended by com.esri.aims.mtier.model.map.output.Output
      extended by com.esri.aims.mtier.model.map.output.LegendOutput
All Implemented Interfaces:
Serializable

public class LegendOutput
extends Output

The LegendOutput object can be used to set specific parameters to be used in creating a legend image. The LegendOutput object is also used for storing the location for the newly created legend image. The LegendOutput object extends the Output object.

See Also:
Serialized Form

Constructor Summary
LegendOutput()
          Constructs an instance of a LegendOutput object.
 
Method Summary
 String getFile()
          Returns the file value associated with this LegendOutput object for the response.
 String getFileType()
          Returns the output image file type.
 String getLegendBaseURL()
          Returns the legendbaseurl property as a string.
 String getLegendName()
          Returns the associated legend name as string.
 String getLegendPath()
          Returns the associated legend path as string.
 String getLegendURL()
          Returns the associated legend URL.
 String getType()
          Returns the name string defining the type of Output object.
 void setFile(String value)
          Sets the LegendOutput objects file value.
 void setFileType(String value)
          Sets the output image file type.
 void setLegendBaseURL(String value)
          This method is paired with setLegendPath, and is used to set the legend image baseurl.
 void setLegendName(String value)
          This method, when paired with setLegendURL, assigns an output legend filename.
 void setLegendPath(String value)
          Sets the directory to output the legend file generated.
 void setLegendURL(String value)
          This method when paired with setLegendName, sets the URL location to place the generated legend image.
 
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

LegendOutput

public LegendOutput()
Constructs an instance of a LegendOutput object. The LegendOutput object extends the Output object. Example:
LegendOutput legendOutput = new LegendOutput();

Method Detail

getType

public String getType()
Returns the name string defining the type of Output object.

Specified by:
getType in class Output
Returns:
String

setLegendBaseURL

public void setLegendBaseURL(String value)
This method is paired with setLegendPath, and is used to set the legend image baseurl. It sets the URL of the output directory if the default legend filename is generated by ArcIMS. Example:
legendOutput.setLegendBaseURL("http://www.mapper.com");

Parameters:
value - the url.
See Also:
getLegendBaseURL()

getLegendBaseURL

public String getLegendBaseURL()
Returns the legendbaseurl property as a string. Example:
String legendBaseURL = legendOutput.getLegendBaseURL();

Returns:
the legendbaseurl property as a string.
See Also:
setLegendBaseURL(java.lang.String)

setLegendName

public void setLegendName(String value)
This method, when paired with setLegendURL, assigns an output legend filename. Note to use full pathname along with the filename. Example:
legendOutput.setLegendName("MyLegend");

Parameters:
value - the filename value.
See Also:
getLegendName(), setLegendURL(java.lang.String)

getLegendName

public String getLegendName()
Returns the associated legend name as string. Example:
String legendName = legendOutput.getLegendName();

Returns:
the legend name as string
See Also:
setLegendName(java.lang.String)

setLegendURL

public void setLegendURL(String value)
This method when paired with setLegendName, sets the URL location to place the generated legend image. Example:
legendOutput.setLegendURL("http://www.abcmap.com");

Parameters:
value - the url value.
See Also:
getLegendURL(), setLegendName(java.lang.String)

getLegendURL

public String getLegendURL()
Returns the associated legend URL. Example:
String legURL = legendOutput.getLegendURL();

Returns:
the legend URL as string
See Also:
setLegendURL(java.lang.String)

setFileType

public void setFileType(String value)
Sets the output image file type. Example:
legendOutput.setFileType("png");

Parameters:
value - the output file type.
See Also:
getFileType()

getFileType

public String getFileType()
Returns the output image file type. Example:
String fileType = legendOutput.getType();

Returns:
the output image file type as string.
See Also:
setFileType(java.lang.String)

setLegendPath

public void setLegendPath(String value)
Sets the directory to output the legend file generated. Example:
legendOutput.setLegendPath("C:/ArcIMS/Output");

Parameters:
value - the legend path value.
See Also:
getLegendPath()

getLegendPath

public String getLegendPath()
Returns the associated legend path as string. Example:
String legendPath = legendOutput.getLegendPath();

Returns:
the legend path as string
See Also:
setLegendPath(java.lang.String)

setFile

public void setFile(String value)
Sets the LegendOutput objects file value. Example:
legendOutput.setFile("legend");

Parameters:
value - the file value.
See Also:
getFile()

getFile

public String getFile()
Returns the file value associated with this LegendOutput object for the response. Example:
String file = legendOutput.getFile();

Returns:
String
See Also:
setFile(java.lang.String)