com.esri.aims.mtier.model.map.layer
Class ImageLayer

java.lang.Object
  com.esri.aims.mtier.model.map.layer.Layer
      com.esri.aims.mtier.model.map.layer.ImageLayer

All Implemented Interfaces:

Serializable

public class ImageLayer
extends Layer

Implements an ArcIMS image layer. An ImageLayer represents a raster image layer. The ImageLayer class extends the Layer class.

See Also:

Serialized Form

Constructor Summary

ImageLayer(String id, String maxScale, String minScale)
Constructs an instance of ImageLayer with given values.

Method Summary

CoordSys	getCoordSys() Returns the CoordSys object associated with this ImageLayer.
Dataset	getDataset() Returns the Dataset object associated with this ImageLayer.
Envelope	getEnvelope() Returns the Envelope associated with this ImageLayer.
RasterInfo	getRasterInfo() Returns the ImageLayer's RasterInfo object.
Raster	getRasterObject() Returns the RasterObject associated with this ImageLayer.
ArrayList	getTOCGroups() Returns the table of contents.
String	getTransColor() Returns the ImageLayer object's transparency value.
double	getTransparency() Returns the percentage value of transparency set for this ImageLayer.
String	getType() Returns a name string that describes the layer type.
void	setCoordSys(CoordSys obj) Sets the given CoordSys object to this ImageLayer.
void	setDataset(Dataset obj) Sets the given Dataset object to this ImageLayer.
void	setEnvelope(Envelope envelope) Sets the given Envelope to this ImageLayer.
void	setRasterInfo(RasterInfo obj) Sets the ImageLayer's RasterInfo object.
void	setRasterObject(Raster obj) Sets the given RasterObject object to this ImageLayer.
void	setTOCGroups(ArrayList tocGroups) Sets the table of contents associated with this feature layer.
void	setTransColor(String value) Sets the given value as the transparency color to this ImageLayer.
void	setTransparency(double value) Sets the given value as percentage of transparency.

Methods inherited from class com.esri.aims.mtier.model.map.layer.Layer

getID, getMaxScale, getMinScale, getName, isVisible, setID, setMaxScale, setMinScale, setName, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageLayer

public ImageLayer(String id,
                  String maxScale,
                  String minScale)

Constructs an instance of ImageLayer with given values. Example:

ImageLayer imageLayer = new ImageLayer("2","1:24000","1:50000");

Parameters:

id - the layer identifier to assign.

maxScale - the layers max- scale value to assign.

minScale - the layers min- scale value to assign.

Method Detail

getType

public String getType()

Returns a name string that describes the layer type.

Specified by:

getType in class Layer

Returns:

a name string that reads "Image".

setEnvelope

public void setEnvelope(Envelope envelope)

Sets the given Envelope to this ImageLayer. Example:

 Envelope env = new Envelope();
 env.setMinX(-125.00);
 env.setMaxX(-100.00);
 env.setMaxY(45.0);
 env.setMinY(10.0);
 imageLayer.setEnvelope(env);
 

Parameters:

envelope - the Envelope object

See Also:

getEnvelope()

getEnvelope

public Envelope getEnvelope()

Returns the Envelope associated with this ImageLayer. Example:

Envelope env = imageLayer.getEnvelope();

Returns:

the Envelope object.

See Also:

setEnvelope(com.esri.aims.mtier.model.envelope.Envelope)

setCoordSys

public void setCoordSys(CoordSys obj)

Sets the given CoordSys object to this ImageLayer. Example:

 CoordSys coordsys = new CoordSys();
 coordsys.setID(4326);
 imageLayer.setCoordSys(coordsys);
 

Parameters:

obj - the CoordSys object.

getCoordSys

public CoordSys getCoordSys()

Returns the CoordSys object associated with this ImageLayer. Example:

 CoordSys coordsys = imageLayer.getCoordSys();
 

Returns:

the CoordSys object.

See Also:

setCoordSys(com.esri.aims.mtier.model.map.projection.CoordSys)

setTransColor

public void setTransColor(String value)

Sets the given value as the transparency color to this ImageLayer. Example:

imageLayer.setTransColor("255,0,0");

Parameters:

value - the transparency color as a RGB value. Example, White is 255, 255, 255

See Also:

getTransColor()

getTransColor

public String getTransColor()

Returns the ImageLayer object's transparency value. Example:

String transColor = imageLayer.getTransColor();

Returns:

the transparency color value string.

See Also:

setTransColor(java.lang.String)

setTransparency

public void setTransparency(double value)

Sets the given value as percentage of transparency. Example, 1.0 is 0 percent transparent, and 0.0 is 100 percent transparent. Example:

imageLayer.setTransparency(1.0);

Parameters:

value - the precentage of transparency.

See Also:

getTransparency()

getTransparency

public double getTransparency()

Returns the percentage value of transparency set for this ImageLayer. Example:

double transparency = imageLayer.getTransparency();

Returns:

the percentage value of transparency as double.

See Also:

setTransparency(double)

setDataset

public void setDataset(Dataset obj)

Sets the given Dataset object to this ImageLayer. Example:

 Dataset dataset = new Dataset();
 dataset.setName("dataset1");
 imageLayer.setDataset(dataset);
 

Parameters:

obj - the Dataset object.

See Also:

getDataset()

getDataset

public Dataset getDataset()

Returns the Dataset object associated with this ImageLayer. Example:

Dataset dataset = imageLayer.getDataset();

Returns:

the Dataset object.

See Also:

setDataset(com.esri.aims.mtier.model.workspace.Dataset)

setRasterObject

public void setRasterObject(Raster obj)

Sets the given RasterObject object to this ImageLayer. Example:

 Raster raster = new Raster();
 raster.setX(-125.0);
 raster.setY(43.0);
 imageLayer.setRasterObject(raster);
 

Parameters:

obj - the RasterObject object.

See Also:

getRasterObject()

getRasterObject

public Raster getRasterObject()

Returns the RasterObject associated with this ImageLayer. Example:

Raster raster = imageLayer.getRasterObject();

Returns:

the RasterObject associated with this ImageLayer.

See Also:

setRasterObject(com.esri.aims.mtier.model.map.layer.raster.Raster)

setRasterInfo

public void setRasterInfo(RasterInfo obj)

Sets the ImageLayer's RasterInfo object. Gets created and set by response from the ArcIMS Application Server.

Parameters:

obj -

See Also:

getRasterInfo()

getRasterInfo

public RasterInfo getRasterInfo()

Returns the ImageLayer's RasterInfo object. Example:

RasterInfo rasterinfo = imageLayer.getRasterInfo();

Returns:

RasterInfo

See Also:

setRasterInfo(com.esri.aims.mtier.model.map.layer.raster.RasterInfo)

setTOCGroups

public void setTOCGroups(ArrayList tocGroups)

Sets the table of contents associated with this feature layer.

Parameters:

tocGroups - the table of contents details

getTOCGroups

public ArrayList getTOCGroups()

Returns the table of contents.

Returns:

ArrayList- the table of contents