com.moximedia.aims
Interface AimsLayer

All Known Implementing Classes:

AimsAcetateLayer, AimsFeatureLayer, AimsImageLayer, WmsLayer

public interface AimsLayer

This interface is implemented by FeatureLayer, etc.

Field Summary

static int	LAYER_TYPE_ACETATE
static int	LAYER_TYPE_FEATURE
static int	LAYER_TYPE_IMAGE
static int	LAYER_TYPE_WMS

Method Summary

void	addLayerListLegend(AimsLayerListLegend legend) Adds a layer list legend.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this layer.
void	adjustScaleFactors(java.lang.String inUnits, java.lang.String outUnits) Adjusts the scale factors for this layer.
boolean	canEdit()
boolean	canFindByAttribute()
boolean	canHideLabels()
boolean	canHideLayerListLegend() Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.
boolean	canSelectByAttribute()
boolean	canShowLayerListLegend() Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.
java.lang.Object	clone()
java.lang.String	getAlias()
boolean	getCanDrillIdentify()
boolean	getCanIdentify()
boolean	getCanSelect()
boolean	getCanSetVisibility()
boolean	getCanSetVisibilityBeyondScale()
boolean	getCanSymbolize() Gets an indicator of whether the layer can be symbolized.
boolean	getCanZoomToLayer()
AimsEnvelope	getExtent()
java.lang.String	getId()
boolean	getImmediateRefresh()
AimsLayerListLegend	getLayerListLegend() Gets and indicator of whether a layer list legend exists at this scale.
AimsLayerListLegends	getLayerListLegends() Gets the array of layer list legends for this group.
int	getLayerType()
boolean	getLegendVisible()
AimsMap	getMap()
double	getMaxScale()
java.lang.String	getMetadataUrl()
double	getMinScale()
java.lang.String	getName()
int	getObjectId()
java.lang.String	getProperty(java.lang.String name)
AimsRecordset	getRecordset()
AimsRenderer	getRenderer()
boolean	getShowSymbolizeIcon() Gets an indicator of whether the symbolize icon shows up in the layer list.
java.lang.Object	getTag() Gets the user defined object tag assosciated with this object.
java.lang.String	getType()
boolean	getVisible()
boolean	hasLayerListLegend() Gets and indicator of whether a layer list legend exists at this scale.
boolean	isBufferLayer()
boolean	isClone()
boolean	isDynamic()
boolean	isHighlightLayer()
boolean	isLayerWithinThreshold()
boolean	isServiceLayer()
boolean	labelsHidden()
void	setExtent(AimsEnvelope envelope)
void	setLegendVisible(boolean isVisible)
void	setMap(AimsMap map)
void	setMaxScale(double scale)
void	setMinScale(double scale)
void	setModified(boolean isModified)
void	setProperty(java.lang.String name, java.lang.String value)
void	setTag(java.lang.Object tag) Sets the user defined object associated to this object.
void	setVisible(boolean visible)
void	showLabels(boolean showLabels)
java.lang.String	toAxlString(java.lang.String requestType)
java.lang.String	toString()

Field Detail

LAYER_TYPE_FEATURE

public static final int LAYER_TYPE_FEATURE

See Also:

Constant Field Values

LAYER_TYPE_IMAGE

public static final int LAYER_TYPE_IMAGE

See Also:

Constant Field Values

LAYER_TYPE_ACETATE

public static final int LAYER_TYPE_ACETATE

See Also:

Constant Field Values

LAYER_TYPE_WMS

public static final int LAYER_TYPE_WMS

See Also:

Constant Field Values

Method Detail

canEdit

public boolean canEdit()

canHideLabels

public boolean canHideLabels()

clone

public java.lang.Object clone()

getAlias

public java.lang.String getAlias()

getCanDrillIdentify

public boolean getCanDrillIdentify()

getCanIdentify

public boolean getCanIdentify()

canFindByAttribute

public boolean canFindByAttribute()

canSelectByAttribute

public boolean canSelectByAttribute()

getCanSelect

public boolean getCanSelect()

getCanSetVisibility

public boolean getCanSetVisibility()

getCanSetVisibilityBeyondScale

public boolean getCanSetVisibilityBeyondScale()

getCanZoomToLayer

public boolean getCanZoomToLayer()

getExtent

public AimsEnvelope getExtent()

getId

public java.lang.String getId()

getImmediateRefresh

public boolean getImmediateRefresh()

getLayerType

public int getLayerType()

getLegendVisible

public boolean getLegendVisible()

getMap

public AimsMap getMap()

getMaxScale

public double getMaxScale()

getMetadataUrl

public java.lang.String getMetadataUrl()

getMinScale

public double getMinScale()

getName

public java.lang.String getName()

getObjectId

public int getObjectId()

getProperty

public java.lang.String getProperty(java.lang.String name)

getRenderer

public AimsRenderer getRenderer()

getRecordset

public AimsRecordset getRecordset()

getType

public java.lang.String getType()

getVisible

public boolean getVisible()

isBufferLayer

public boolean isBufferLayer()

isClone

public boolean isClone()

isDynamic

public boolean isDynamic()

isHighlightLayer

public boolean isHighlightLayer()

isLayerWithinThreshold

public boolean isLayerWithinThreshold()

isServiceLayer

public boolean isServiceLayer()

labelsHidden

public boolean labelsHidden()

setExtent

public void setExtent(AimsEnvelope envelope)

setLegendVisible

public void setLegendVisible(boolean isVisible)

setMap

public void setMap(AimsMap map)

setMaxScale

public void setMaxScale(double scale)

setMinScale

public void setMinScale(double scale)

setModified

public void setModified(boolean isModified)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

setVisible

public void setVisible(boolean visible)

showLabels

public void showLabels(boolean showLabels)

toAxlString

public java.lang.String toAxlString(java.lang.String requestType)

toString

public java.lang.String toString()

addLayerListLegend

public void addLayerListLegend(AimsLayerListLegend legend)

Adds a layer list legend.

Parameters:

legend - The legend to add.

hasLayerListLegend

public boolean hasLayerListLegend()

Gets and indicator of whether a layer list legend exists at this scale.

Returns:

True if the layer has a legend which could be shown.

getLayerListLegend

public AimsLayerListLegend getLayerListLegend()

Gets and indicator of whether a layer list legend exists at this scale.

Returns:

True if the layer has a legend which could be shown.

getLayerListLegends

public AimsLayerListLegends getLayerListLegends()

Gets the array of layer list legends for this group.

Returns:

An AimsLayerListLegends object containing the legends.

canHideLayerListLegend

public boolean canHideLayerListLegend()

Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.

Returns:

True if the layer has a legend which could be shown.

canShowLayerListLegend

public boolean canShowLayerListLegend()

Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.

Returns:

True if the layer has a legend which could be shown.

getCanSymbolize

public boolean getCanSymbolize()

Gets an indicator of whether the layer can be symbolized.

Returns:

True if the layer can be symbolized, otherwise false;

getShowSymbolizeIcon

public boolean getShowSymbolizeIcon()

Gets an indicator of whether the symbolize icon shows up in the layer list.

Returns:

True if the icon is displayed, otherwise false;

getTag

public java.lang.Object getTag()

Gets the user defined object tag assosciated with this object.

Returns:

A programmer defined object that is associated with this object using the setTag() method. Note that this request returns an Object that must be cast to the appropriate object type before using.

setTag

public void setTag(java.lang.Object tag)

Sets the user defined object associated to this object. The programmer may associate any object to this one using this method, but must cast the object to an Object class before calling this method.

Parameters:

tag - Any Object.

adjustScaleFactors

public void adjustScaleFactors(java.lang.String inUnits,
                               java.lang.String outUnits)

Adjusts the scale factors for this layer. Used when changing the units of a map.

Parameters:

inUnits - The original units, "METERS", FEET" or "DECIMAL_DEGREES".

outUnits - The target units, "METERS", FEET" or "DECIMAL_DEGREES".

adjustScaleFactors

public void adjustScaleFactors(double multiplier)

Adjusts the scale factors for this layer. Used when changing the units of a map.

Parameters:

multiplier - The multiplication factor for adjusting scale factors.