com.moximedia.aims
Class AimsFeatureLayer

java.lang.Object
  com.moximedia.aims.AimsFeatureLayer

All Implemented Interfaces:

AimsLayer, java.lang.Cloneable, java.io.Serializable

public class AimsFeatureLayer

extends java.lang.Object

implements AimsLayer, java.io.Serializable, java.lang.Cloneable

AimsFeatureLayer class represents all of the geographic features in a dataset that are contained in a single layer. The valid feature classes contained in a Map Service's AimsFeatureLayer object are points, lines, and polygons.

See Also:

Serialized Form

Field Summary

static int	SHAPE_TYPE_LINE
static int	SHAPE_TYPE_POINT
static int	SHAPE_TYPE_POLYGON

Fields inherited from interface com.moximedia.aims.AimsLayer

LAYER_TYPE_ACETATE, LAYER_TYPE_FEATURE, LAYER_TYPE_IMAGE, LAYER_TYPE_WMS

Constructor Summary

	AimsFeatureLayer() Do not use.
protected	AimsFeatureLayer(AimsMap map) Creates a new AimsFeatureLayer

Method Summary

void	addIdentifyLink(AimsIdentifyLink link)
void	addIdentifyReport(AimsReport report) Adds an identify report for this layer.
void	addLayerListLegend(AimsLayerListLegend legend) Adds a layer list legend.
void	addSelectReport(AimsReport report) Adds a select report for this layer.
void	adjustScaleFactors(double multiplier) Adjusts the scale factors for this layer and its renderers.
void	adjustScaleFactors(java.lang.String inUnits, java.lang.String outUnits) Adjusts the scale factors for this layer and its renderers.
boolean	canEdit()
boolean	canExtract()
boolean	canExtractExcel() Returns an indicator of whether this layer supports Excel extraction.
boolean	canExtractGml() Returns an indicator of whether this layer supports GML extraction.
boolean	canFindByAttribute() Gets a boolean value indicating whether a feature layer can be queried using the find location by attribute tool.
boolean	canHideLabels() Returns a boolean value indicating whether labels can be hidden.
boolean	canHideLayerListLegend() Gets and indicator of whether the legend could be shown, true regardless of whether or not it is turned off.
boolean	canSelectByAttribute() Gets a boolean value indicating whether a feature layer can be queried using the select by attribute tool.
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() Creates a copy of this feature layer.
AimsFeatureLayer	createHighlightLayer(AimsFilter fltr) Creates a clone of this layer with selected features highlighted.
AimsFeatureLayer	createHighlightLayer(AimsShapeObject shape) Creates a clone of this layer with selected features highlighted.
AimsFeatureLayer	createHighlightLayer(java.lang.String query) Creates a clone of this layer with selected features highlighted.
boolean	extract() Performs an extract using the layer settings.
boolean	extract(AimsFilter filter) Performs an extract using the layer settings.
AimsEnvelope	findByAttribute(java.lang.String fieldName, java.lang.String value) Returns an extent envelope of the features matching the specified query.
java.lang.String	getAlias() get the alias of the layer
boolean	getCanDrillIdentify() Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.
boolean	getCanIdentify() Gets a boolean value indicating whether a feature layer can be identified.
boolean	getCanSelect() Gets a boolean value indicating whether a feature layer can be selected.
boolean	getCanSetVisibility() Gets a boolean value indicating whether the layer can be turned on and off by the user.
boolean	getCanSetVisibilityBeyondScale() Gets a boolean value indicating whether the layer can be turned on and off by the user when the layer is beyond scale.
boolean	getCanSymbolize() Gets an indicator of whether the layer can be symbolized.
boolean	getCanZoomToLayer() Returns a boolean indicator of whether the zoom to layer extent function should be enabled for this layer.
java.lang.String	getClonedFromId()
java.lang.String	getClonedFromName()
java.lang.String	getEditHandler()
java.lang.String	getEditHandlerTarget()
AimsField	getEditKeyField()
java.lang.String	getEditKeyValue()
AimsEnvelope	getExtent() Returns the extent of the layer.
boolean	getExtractClip() Returns a boolean value indicating whether the extract request should include the extent.
java.lang.String	getExtractFile() Gets the path to the extract file created by the extract() method.
java.lang.String	getExtractLayerId()
java.lang.String	getExtractUrl() Gets the url of the extract file created by the extract() method.
java.lang.String	getFeatureClass() Get the feature class (point, line, or polygon)
AimsFilter	getFilter()
java.util.Vector	getFindByAttributeFields()
AimsGeocode	getGeocode() Gets the Geocode object for this layer, if any.
java.lang.String	getGeocodeLayerId() Gets the alternate geocoding layerid for this layer.
java.lang.String	getGeocodeServer() Gets the alternate geocoding server for this layer.
java.lang.String	getGeocodeService() Gets the alternate geocoding servide name for this layer.
java.lang.String	getGeocodeServlet() Gets the alternate geocoding servlet for this layer.
java.lang.String	getId() Get the ID of the layer
java.lang.String	getIdentifyHandler() Gets the identify handler URL for the layer.
java.lang.String	getIdentifyHandlerSuffix() Gets the identify handler URL suffix for the layer.
java.util.Vector	getIdentifyKeyFields() Gets the identify key fields for the layer.
AimsIdentifyLink[]	getIdentifyLinks()
AimsReport	getIdentifyReport(java.lang.String name) Gets the identify report for this layer by name.
java.util.ArrayList	getIdentifyReports() Gets the identify reports set for this layer.
java.lang.String	getIdentifyType() Gets the identify type for the layer.
boolean	getIdentifyWindow() Gets whether a separate identify window is used for the layer.
boolean	getImmediateRefresh() Returns whether the map should immediately refresh when the map layer visibility is changed.
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.
AimsFeatureLayer	getLayerManagerCopy(AimsMap map) Creates a copy of this feature layer for use in another map.
int	getLayerType() Gets the layer type, AimsLayer.LAYER_TYPE_FEATURE
boolean	getLegendVisible() Returns whether the layer should be visible in the legend.
AimsMap	getMap() Gets the map object containing this layer.
int	getMaximumExtractExcelRecords() Returns the maximum number of records possible in an Excel extraction.
int	getMaximumExtractGmlRecords() Returns the maximum number of records possible in a GML extraction.
double	getMaxScale() Gets the maximum scale at which the feature layer will be displayed.
java.lang.String	getMetadataUrl() Returns the URL to the metadata page for this layer, or null if no metatata URL is defined.
double	getMinScale() Gets the minimum scale at which the feature layer will be displayed.
java.lang.String	getName() Get the name of the layer
int	getObjectId() Returns the IMF internal id for this layer.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <property> element.
AimsRecordset	getRecordset() Gets the recordset of the feature layer.
AimsRenderer	getRenderer() Gets the renderer used to symbolize and label the feature layer.
java.util.Vector	getSelectByAttributeFields()
java.lang.String	getSelectHandler() Gets the selection handler URL for the layer.
java.lang.String	getSelectHandlerSuffix() Gets the select handler URL suffix for the layer.
boolean	getSelectHighlight() Returns a boolean value indicating whether the features of this layer that are selected using the select tool should be highlighted.
java.util.Vector	getSelectKeyFields() Gets the selection key fields for the layer.
AimsReport	getSelectReport(java.lang.String name) Gets the select report for this layer by name.
java.util.ArrayList	getSelectReports() Gets the select reports set for this layer.
java.lang.String	getSelectShape() Gets the type of select tool that is used for this layer.
java.lang.String	getSelectType() Gets the select type for the layer.
boolean	getSelectWindow() Gets whether a separate select window is used for the layer.
int	getShapeType() Gets the feature type of this layer.
boolean	getShowSymbolizeIcon() Gets an indicator of whether the symbolize icon shows up in the layer list.
double	getSnapDistance() Gets the snapping distance when snapping to this layer.
AimsPoint	getSnapVertex(AimsPoint pt) Gets the closest vertex within the set snap distance for this layer, or null if there is no vertex within the snap distance.
AimsPoint	getSnapVertex(AimsPoint pt, double snapDistance) Gets the closest vertex within the specified snap distance for this layer, or null if there is no vertex within the snap distance.
java.lang.String	getSymbolizeScript() Gets the name of the symbolize script used for symbolization.
java.lang.Object	getTag() Gets the user defined object tag assosciated with this object.
java.lang.String	getType() Gets the layer type.
boolean	getVisible() Get if the layer is visible (ie: visible=true).
java.lang.Double	getZoomExtentBuffer()
boolean	hasLayerListLegend() Gets and indicator of whether a layer list legend exists at this scale.
boolean	isBufferLayer() Returns true if this layer is a buffer layer.
boolean	isClone() Returns a boolean value indicating whether this layer is a clone.
boolean	isDynamic() Returns a boolean value indicating whether this layer was added dynamically.
boolean	isExtractLayer() Returns a boolean value indicating whether the layer is an extract layer.
boolean	isHighlightLayer() Returns true if this layer is a highlight layer.
boolean	isLayerWithinThreshold() Returns whether this layer is within threshold tolerance.
boolean	isServiceLayer() Reports whether this layer was loaded from the map service.
boolean	isVisible() Get if the layer is visible (ie: visible=true).
boolean	labelsHidden() Returns a boolean value indicating whether labels are currently hidden.
void	removeLabels() Removes the label renderers from this layer.
void	setAlias(java.lang.String alias) Sets the alias of the layer
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setCanDrillIdentify(boolean canDrillIdentify) Sets whether a feature layer can be identified using the drill down identify tool.
void	setCanExtractExcel(boolean flag) Sets an indicator of whether this layer supports Excel extraction.
void	setCanExtractGml(boolean flag) Sets an indicator of whether this layer supports GML extraction.
void	setCanIdentify(boolean canIdentify) Sets whether a feature layer can be identified.
void	setCanSelect(boolean canSelect) Sets whether a feature layer can be selected.
void	setCanSetVisibility(boolean canSetVisibility) Sets whether the layer can be turned on and off by the user.
void	setCanSetVisibilityBeyondScale(boolean canSetVisibility) Sets whether the layer can be turned on and off by the user.
void	setCanSymbolize(boolean canSymbolize) Sets whether the layer can be symbolized.
void	setCanZoomToLayer(boolean canZoom) Sets whether the zoom to layer extent function should be enabled for this layer.
void	setDataset(AimsDataset ds) Sets the dataset, for use with dynamic layers.
void	setExtent(AimsEnvelope envelope) Sets the envelope (extent) of the layer.
protected void	setFeatureClass(java.lang.String featureClass) Set the feature class (point, line, or polygon)
void	setFilter(AimsFilter filter)
void	setGeocode(AimsGeocode geocode) Sets the layer's geocode object.
void	setHighlightColor(AimsColor color) Sets the highlighted color for selected features.
void	setHighlightTransparency(double transparency) Sets the highlighted transparency for selected features.
void	setId(java.lang.String id) Sets the id of the layer
void	setIsBufferLayer(boolean isBuffer) Sets whether this layer is a buffer layer.
void	setLegendVisible(boolean isVisible) Sets the visibility of the layer in the legend.
void	setMap(AimsMap map) Sets the map that this layer belongs to if it isn't null,
void	setMaximumExtractExcelRecords(int count) Sets the maximum number of records possible in an Excel extraction.
void	setMaximumExtractGmlRecords(int count) Sets the maximum number of records possible in a GML extraction.
void	setMaxScale(double scale) Gets the minimum scale at which the feature layer will be displayed.
void	setMinScale(double scale) Sets the minimum scale at which the feature layer will be displayed.
void	setModified(boolean isModified)
void	setName(java.lang.String name) Sets the name of the layer
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
protected void	setRecordset(AimsRecordset rs) Sets the recordset of the feature layer.
void	setRenderer(AimsRenderer renderer) Sets the renderer used to symbolize and label the feature layer.
void	setShowSymbolizeIcon(boolean showSymbolizeIcon) Sets whether the symbolize icon is displayed in the layer list.
void	setSnapDistance(double distance) Sets the snapping distance when snapping to this layer.
void	setSymbolizeScript(java.lang.String jspScript) Sets the name of the symbolize script used for symbolization.
void	setTag(java.lang.Object tag) Sets the user defined object associated to this object.
void	setVisible(boolean visible) turn on/off the layer
void	showLabels(boolean showLabels) Toggles the visibility of the label renderers in this layer.
java.lang.String	toAxlString(java.lang.String requestType) Returns the AXL string to refresh this object.
java.lang.String	toString() Returns a text representation of of this class.

Methods inherited from class java.lang.Object

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

Field Detail

SHAPE_TYPE_POINT

public static final int SHAPE_TYPE_POINT

See Also:

Constant Field Values

SHAPE_TYPE_LINE

public static final int SHAPE_TYPE_LINE

See Also:

Constant Field Values

SHAPE_TYPE_POLYGON

public static final int SHAPE_TYPE_POLYGON

See Also:

Constant Field Values

Constructor Detail

AimsFeatureLayer

public AimsFeatureLayer()

Do not use. For serialization only.

AimsFeatureLayer

protected AimsFeatureLayer(AimsMap map)

Creates a new AimsFeatureLayer

Parameters:

map - The map containing the layer.

Method Detail

setDataset

public void setDataset(AimsDataset ds)

Sets the dataset, for use with dynamic layers. 2param ds The dataset object.

addLayerListLegend

public void addLayerListLegend(AimsLayerListLegend legend)

Adds a layer list legend.

Specified by:

addLayerListLegend in interface AimsLayer

Parameters:

legend - The legend to add.

hasLayerListLegend

public boolean hasLayerListLegend()

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

Specified by:

hasLayerListLegend in interface AimsLayer

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.

Specified by:

getLayerListLegend in interface AimsLayer

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.

Specified by:

getLayerListLegends in interface AimsLayer

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.

Specified by:

canHideLayerListLegend in interface AimsLayer

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.

Specified by:

canShowLayerListLegend in interface AimsLayer

Returns:

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

getTag

public java.lang.Object getTag()

Gets the user defined object tag assosciated with this object.

Specified by:

getTag in interface AimsLayer

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.

Specified by:

setTag in interface AimsLayer

Parameters:

tag - Any Object.

canExtractExcel

public boolean canExtractExcel()

Returns an indicator of whether this layer supports Excel extraction.

Returns:

True if Excel can be extracted, otherwise false.

setCanExtractExcel

public void setCanExtractExcel(boolean flag)

Sets an indicator of whether this layer supports Excel extraction.

Parameters:

flag - True if Excel can be extracted, otherwise false.

getMaximumExtractExcelRecords

public int getMaximumExtractExcelRecords()

Returns the maximum number of records possible in an Excel extraction.

Returns:

The number of records that can be extracted.

setMaximumExtractExcelRecords

public void setMaximumExtractExcelRecords(int count)

Sets the maximum number of records possible in an Excel extraction.

Parameters:

count - The number of records that can be extracted.

canExtractGml

public boolean canExtractGml()

Returns an indicator of whether this layer supports GML extraction.

Returns:

True if GML can be extracted, otherwise false.

setCanExtractGml

public void setCanExtractGml(boolean flag)

Sets an indicator of whether this layer supports GML extraction.

Parameters:

flag - True if GML can be extracted, otherwise false.

getMaximumExtractGmlRecords

public int getMaximumExtractGmlRecords()

Returns the maximum number of records possible in a GML extraction.

Returns:

The number of records that can be extracted.

setMaximumExtractGmlRecords

public void setMaximumExtractGmlRecords(int count)

Sets the maximum number of records possible in a GML extraction.

Parameters:

count - The number of records that can be extracted.

getLayerManagerCopy

public AimsFeatureLayer getLayerManagerCopy(AimsMap map)

Creates a copy of this feature layer for use in another map. Intended for the layer manager process.

Parameters:

map - The map where this layer will be copied to.

Returns:

A copy of this feature layer.

clone

public java.lang.Object clone()

Creates a copy of this feature layer.

Specified by:

clone in interface AimsLayer

Returns:

An object that is a copy of this feature layer.

addIdentifyReport

public void addIdentifyReport(AimsReport report)

Adds an identify report for this layer.

Parameters:

report - An identify report.

getIdentifyReport

public AimsReport getIdentifyReport(java.lang.String name)

Gets the identify report for this layer by name.

Returns:

The identify report with the specified name, or null.

getIdentifyReports

public java.util.ArrayList getIdentifyReports()

Gets the identify reports set for this layer.

Returns:

An array list of identify reports.

addSelectReport

public void addSelectReport(AimsReport report)

Adds a select report for this layer.

Parameters:

report - An select report.

getSelectReport

public AimsReport getSelectReport(java.lang.String name)

Gets the select report for this layer by name.

Returns:

The select report with the specified name, or null.

getSelectReports

public java.util.ArrayList getSelectReports()

Gets the select reports set for this layer.

Returns:

An array list of select reports.

getObjectId

public int getObjectId()

Returns the IMF internal id for this layer. Note that this is not the same as the layer id assigned by the user or ArcIMS.

Specified by:

getObjectId in interface AimsLayer

Returns:

The internal id for the layer.

getLayerType

public int getLayerType()

Gets the layer type, AimsLayer.LAYER_TYPE_FEATURE

Specified by:

getLayerType in interface AimsLayer

Returns:

Always returns AimsLayer.LAYER_TYPE_FEATURE

getShapeType

public int getShapeType()

Gets the feature type of this layer.

Returns:

The feature type, either AimsFeatureLayer.SHAPE_TYPE_LINE, AimsFeatureLayer.SHAPE_TYPE_POINT, or AimsFeatureLayer.SHAPE_TYPE_POLYGON.

canEdit

public boolean canEdit()

Specified by:

canEdit in interface AimsLayer

getEditKeyField

public AimsField getEditKeyField()

getEditKeyValue

public java.lang.String getEditKeyValue()

getEditHandler

public java.lang.String getEditHandler()

getEditHandlerTarget

public java.lang.String getEditHandlerTarget()

getImmediateRefresh

public boolean getImmediateRefresh()

Returns whether the map should immediately refresh when the map layer visibility is changed.

Specified by:

getImmediateRefresh in interface AimsLayer

Returns:

True if the map should immediately refresh, otherwise false.

canExtract

public boolean canExtract()

getExtractLayerId

public java.lang.String getExtractLayerId()

getExtractUrl

public java.lang.String getExtractUrl()

Gets the url of the extract file created by the extract() method.

Returns:

The url to the last zip file created by the extract() method

getExtractFile

public java.lang.String getExtractFile()

Gets the path to the extract file created by the extract() method.

Returns:

The path to the last image file created by the extract() method

isExtractLayer

public boolean isExtractLayer()

Returns a boolean value indicating whether the layer is an extract layer.

Returns:

True if the layer is an extract layer, otherwise false.

getExtractClip

public boolean getExtractClip()

Returns a boolean value indicating whether the extract request should include the extent.

Returns:

True if the layer should be clipped, otherwise false.

extract

public boolean extract()

Performs an extract using the layer settings.

Returns:

True if the operation was successful, otherwise false.

extract

public boolean extract(AimsFilter filter)

Performs an extract using the layer settings.

Parameters:

filter - A filter to limit the extracted set.

Returns:

True if the operation was successful, otherwise false.

canSelectByAttribute

public boolean canSelectByAttribute()

Gets a boolean value indicating whether a feature layer can be queried using the select by attribute tool.

Specified by:

canSelectByAttribute in interface AimsLayer

Returns:

True if the layer can be queried, otherwise false.

getSelectByAttributeFields

public java.util.Vector getSelectByAttributeFields()

canFindByAttribute

public boolean canFindByAttribute()

Gets a boolean value indicating whether a feature layer can be queried using the find location by attribute tool.

Specified by:

canFindByAttribute in interface AimsLayer

Returns:

True if the layer can be queried, otherwise false.

getFindByAttributeFields

public java.util.Vector getFindByAttributeFields()

findByAttribute

public AimsEnvelope findByAttribute(java.lang.String fieldName,
                                    java.lang.String value)

Returns an extent envelope of the features matching the specified query.

Parameters:

fieldName - The name of the field

value - The field value

Returns:

The extent, or null if no records are found.

getLegendVisible

public boolean getLegendVisible()

Returns whether the layer should be visible in the legend.

Specified by:

getLegendVisible in interface AimsLayer

Returns:

True if the layer is visible, otherwise false.

setLegendVisible

public void setLegendVisible(boolean isVisible)

Sets the visibility of the layer in the legend.

Specified by:

setLegendVisible in interface AimsLayer

Parameters:

isVisible - A boolean value indicating whether the layer should be visible in the legend.

getMap

public AimsMap getMap()

Gets the map object containing this layer.

Specified by:

getMap in interface AimsLayer

Returns:

The map object containing this layer.

getGeocode

public AimsGeocode getGeocode()

Gets the Geocode object for this layer, if any.

Returns:

The geocode object for this layer, or null if the layer is not geocoded.

setGeocode

public void setGeocode(AimsGeocode geocode)

Sets the layer's geocode object.

Parameters:

geocode - The geocode object.

getSelectHighlight

public boolean getSelectHighlight()

Returns a boolean value indicating whether the features of this layer that are selected using the select tool should be highlighted. This value is only set from the layers XML.

Returns:

True if the layer should be highlighted, otherwise false.

setHighlightColor

public void setHighlightColor(AimsColor color)

Sets the highlighted color for selected features.

Parameters:

color - The highlight color.

setHighlightTransparency

public void setHighlightTransparency(double transparency)

Sets the highlighted transparency for selected features.

Parameters:

transparency - The highlight transparency.

getSelectShape

public java.lang.String getSelectShape()

Gets the type of select tool that is used for this layer. The options are: "point", "box", or "polygon".

Returns:

A string containing the select shape.

getSnapDistance

public double getSnapDistance()

Gets the snapping distance when snapping to this layer.

Returns:

The snap distance, in metres.

setSnapDistance

public void setSnapDistance(double distance)

Sets the snapping distance when snapping to this layer.

Parameters:

distance - The snap distance, in metres.

getSnapVertex

public AimsPoint getSnapVertex(AimsPoint pt)

Gets the closest vertex within the set snap distance for this layer, or null if there is no vertex within the snap distance.

Parameters:

pt - The point to find the snap vertex for.

Returns:

The closest vertex within the set snap distance for this layer, or null if there is no vertex within the snap distance.

getSnapVertex

public AimsPoint getSnapVertex(AimsPoint pt,
                               double snapDistance)

Gets the closest vertex within the specified snap distance for this layer, or null if there is no vertex within the snap distance.

Parameters:

pt - The point to find the snap vertex for.

Returns:

The closest vertex within the specified snap distance for this layer, or null if there is no vertex within the snap distance.

isServiceLayer

public boolean isServiceLayer()

Reports whether this layer was loaded from the map service.

Specified by:

isServiceLayer in interface AimsLayer

Returns:

True if the layer was initialized from the map service, otherwise false.

createHighlightLayer

public AimsFeatureLayer createHighlightLayer(java.lang.String query)

Creates a clone of this layer with selected features highlighted.

Parameters:

query - A where clause used to select features.

Returns:

A clone of this layer with highlighted features.

createHighlightLayer

public AimsFeatureLayer createHighlightLayer(AimsShapeObject shape)

Creates a clone of this layer with selected features highlighted.

Parameters:

shape - A shape used to select features.

Returns:

A clone of this layer with highlighted features.

createHighlightLayer

public AimsFeatureLayer createHighlightLayer(AimsFilter fltr)

Creates a clone of this layer with selected features highlighted.

Returns:

A clone of this layer with highlighted features.

isHighlightLayer

public boolean isHighlightLayer()

Returns true if this layer is a highlight layer.

Specified by:

isHighlightLayer in interface AimsLayer

Returns:

True if this layer is a highlight layer, otherwise false.

isBufferLayer

public boolean isBufferLayer()

Returns true if this layer is a buffer layer.

Specified by:

isBufferLayer in interface AimsLayer

Returns:

True if this layer is a buffer layer, otherwise false.

setIsBufferLayer

public void setIsBufferLayer(boolean isBuffer)

Sets whether this layer is a buffer layer.

Parameters:

isBuffer - True if this layer is a buffer layer, otherwise false.

getClonedFromName

public java.lang.String getClonedFromName()

getClonedFromId

public java.lang.String getClonedFromId()

isClone

public boolean isClone()

Returns a boolean value indicating whether this layer is a clone.

Specified by:

isClone in interface AimsLayer

Returns:

True if the layer is a clone, otherwise false.

isDynamic

public boolean isDynamic()

Returns a boolean value indicating whether this layer was added dynamically.

Specified by:

isDynamic in interface AimsLayer

Returns:

True if the layer is a dynamic one, otherwise false.

removeLabels

public void removeLabels()

Removes the label renderers from this layer.

getFilter

public AimsFilter getFilter()

setFilter

public void setFilter(AimsFilter filter)

getIdentifyKeyFields

public java.util.Vector getIdentifyKeyFields()

Gets the identify key fields for the layer. The identify key fields are contained in a Vector. This value should be present for some custom identify routines.

Returns:

The identify key fields for the layer.

getSelectKeyFields

public java.util.Vector getSelectKeyFields()

Gets the selection key fields for the layer. The select key fields are contained in a Vector. This value should be present for some custom select routines.

Returns:

The select key fields for the layer.

getIdentifyHandler

public java.lang.String getIdentifyHandler()

Gets the identify handler URL for the layer.

Returns:

The identify handler URL for the layer.

getIdentifyHandlerSuffix

public java.lang.String getIdentifyHandlerSuffix()

Gets the identify handler URL suffix for the layer.

Returns:

The identify handler URL suffix for the layer.

getSelectHandler

public java.lang.String getSelectHandler()

Gets the selection handler URL for the layer.

Returns:

The selection handler URL for the layer.

getSelectHandlerSuffix

public java.lang.String getSelectHandlerSuffix()

Gets the select handler URL suffix for the layer.

Returns:

The select handler URL suffix for the layer.

getIdentifyType

public java.lang.String getIdentifyType()

Gets the identify type for the layer.

Returns:

The identify type for the layer.

getSelectType

public java.lang.String getSelectType()

Gets the select type for the layer.

Returns:

The select type for the layer.

getIdentifyWindow

public boolean getIdentifyWindow()

Gets whether a separate identify window is used for the layer.

Returns:

True if a separate identify window is used for the layer.

getSelectWindow

public boolean getSelectWindow()

Gets whether a separate select window is used for the layer.

Returns:

True if a separate select window is used for the layer.

getCanSetVisibility

public boolean getCanSetVisibility()

Gets a boolean value indicating whether the layer can be turned on and off by the user.

Specified by:

getCanSetVisibility in interface AimsLayer

Returns:

True if the layer can be controlled, otherwise false.

setCanSetVisibility

public void setCanSetVisibility(boolean canSetVisibility)

Sets whether the layer can be turned on and off by the user.

getCanSetVisibilityBeyondScale

public boolean getCanSetVisibilityBeyondScale()

Gets a boolean value indicating whether the layer can be turned on and off by the user when the layer is beyond scale.

Specified by:

getCanSetVisibilityBeyondScale in interface AimsLayer

Returns:

True if the layer can be controlled, otherwise false.

setCanSetVisibilityBeyondScale

public void setCanSetVisibilityBeyondScale(boolean canSetVisibility)

Sets whether the layer can be turned on and off by the user.

getCanDrillIdentify

public boolean getCanDrillIdentify()

Gets a boolean value indicating whether the layer can be identified using the drill down identify tool.

Specified by:

getCanDrillIdentify in interface AimsLayer

Returns:

True if the layer can be identified using the drill down identify tool, otherwise false.

getCanIdentify

public boolean getCanIdentify()

Gets a boolean value indicating whether a feature layer can be identified.

Specified by:

getCanIdentify in interface AimsLayer

Returns:

True if the layer can be identified, otherwise false.

getCanSelect

public boolean getCanSelect()

Gets a boolean value indicating whether a feature layer can be selected.

Specified by:

getCanSelect in interface AimsLayer

Returns:

True if the layer can be selected, otherwise false.

setCanDrillIdentify

public void setCanDrillIdentify(boolean canDrillIdentify)

Sets whether a feature layer can be identified using the drill down identify tool.

setCanIdentify

public void setCanIdentify(boolean canIdentify)

Sets whether a feature layer can be identified.

setCanSelect

public void setCanSelect(boolean canSelect)

Sets whether a feature layer can be selected.

getType

public java.lang.String getType()

Gets the layer type.

Specified by:

getType in interface AimsLayer

Returns:

For feature layers, this method always returns "featureclass".

setMinScale

public void setMinScale(double scale)

Sets the minimum scale at which the feature layer will be displayed.

Specified by:

setMinScale in interface AimsLayer

Parameters:

scale - The minimum scale at which the feature layer will be displayed.

setMaxScale

public void setMaxScale(double scale)

Gets the minimum scale at which the feature layer will be displayed.

Specified by:

setMaxScale in interface AimsLayer

Returns:

The minimum scale at which the feature layer will be displayed.

setModified

public void setModified(boolean isModified)

Specified by:

setModified in interface AimsLayer

setRenderer

public void setRenderer(AimsRenderer renderer)

Sets the renderer used to symbolize and label the feature layer.

Parameters:

renderer - The renderer used to symbolize and label the feature layer.

getRenderer

public AimsRenderer getRenderer()

Gets the renderer used to symbolize and label the feature layer.

Specified by:

getRenderer in interface AimsLayer

Returns:

The renderer used to symbolize and label the feature layer.

getRecordset

public AimsRecordset getRecordset()

Gets the recordset of the feature layer.

Specified by:

getRecordset in interface AimsLayer

Returns:

The recordset of the feature layer.

setRecordset

protected void setRecordset(AimsRecordset rs)

Sets the recordset of the feature layer. This cannot be changed by application code.

Parameters:

rs - The recordset of the feature layer.

setFeatureClass

protected void setFeatureClass(java.lang.String featureClass)

Set the feature class (point, line, or polygon)

Parameters:

featureClass - The feature class (point, line, or polygon)

getMaxScale

public double getMaxScale()

Gets the maximum scale at which the feature layer will be displayed.

Specified by:

getMaxScale in interface AimsLayer

Returns:

The maximum scale at which the feature layer will be displayed.

getMinScale

public double getMinScale()

Gets the minimum scale at which the feature layer will be displayed.

Specified by:

getMinScale in interface AimsLayer

Returns:

The minimum scale at which the feature layer will be displayed.

getFeatureClass

public java.lang.String getFeatureClass()

Get the feature class (point, line, or polygon)

Returns:

The feature class (point, line, or polygon)

getId

public java.lang.String getId()

Get the ID of the layer

Specified by:

getId in interface AimsLayer

Returns:

ID of the layer

setId

public void setId(java.lang.String id)

Sets the id of the layer

Parameters:

id - The id of the layer.

getName

public java.lang.String getName()

Get the name of the layer

Specified by:

getName in interface AimsLayer

Returns:

The name of the layer

setName

public void setName(java.lang.String name)

Sets the name of the layer

Parameters:

name - The name of the layer.

getAlias

public java.lang.String getAlias()

get the alias of the layer

Specified by:

getAlias in interface AimsLayer

Returns:

Alias of the layer, or the name if there is no alias

setAlias

public void setAlias(java.lang.String alias)

Sets the alias of the layer

Parameters:

alias - The alias of the layer.

getVisible

public boolean getVisible()

Get if the layer is visible (ie: visible=true). Note that the layer may be set to visible, but still not be shown due to the threshold settings. Use the isDisplayed() method instead to determine if a theme is within tolerance and visible.

Specified by:

getVisible in interface AimsLayer

Returns:

true if visible

isVisible

public boolean isVisible()

Get if the layer is visible (ie: visible=true). Note that the layer may be set to visible, but still not be shown due to the threshold settings. Use the isDisplayed() method instead to determine if a theme is within tolerance and visible.

Returns:

true if visible

setVisible

public void setVisible(boolean visible)

turn on/off the layer

Specified by:

setVisible in interface AimsLayer

Parameters:

visible - true if turn on

isLayerWithinThreshold

public boolean isLayerWithinThreshold()

Returns whether this layer is within threshold tolerance.

Specified by:

isLayerWithinThreshold in interface AimsLayer

Returns:

True if the layer is shown at the present scale, otherwise false.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute (not used).

name - The AXL attribute name.

value - The AXL attribute value.

toString

public java.lang.String toString()

Returns a text representation of of this class.

Specified by:

toString in interface AimsLayer

Returns:

A string describing the class

toAxlString

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

Returns the AXL string to refresh this object.

Specified by:

toAxlString in interface AimsLayer

Parameters:

requestType - The parent tag of the response, "LAYERDEF" or "LAYER".

Returns:

The AXL string to refresh this object.

getMetadataUrl

public java.lang.String getMetadataUrl()

Returns the URL to the metadata page for this layer, or null if no metatata URL is defined.

Specified by:

getMetadataUrl in interface AimsLayer

Returns:

The URL to the metadata page for this layer, or null if no metatata URL is defined.

setMap

public void setMap(AimsMap map)

Sets the map that this layer belongs to if it isn't null,

Specified by:

setMap in interface AimsLayer

Parameters:

map - The map that this layer is part of.

getIdentifyLinks

public AimsIdentifyLink[] getIdentifyLinks()

addIdentifyLink

public void addIdentifyLink(AimsIdentifyLink link)

showLabels

public void showLabels(boolean showLabels)

Toggles the visibility of the label renderers in this layer.

Specified by:

showLabels in interface AimsLayer

Parameters:

showLabels - The visibility property.

canHideLabels

public boolean canHideLabels()

Returns a boolean value indicating whether labels can be hidden.

Specified by:

canHideLabels in interface AimsLayer

Returns:

True if the labels can be hidden, otherwise false.

labelsHidden

public boolean labelsHidden()

Returns a boolean value indicating whether labels are currently hidden.

Specified by:

labelsHidden in interface AimsLayer

Returns:

True if the labels are hidden, otherwise false.

getExtent

public AimsEnvelope getExtent()

Returns the extent of the layer.

Specified by:

getExtent in interface AimsLayer

Returns:

The extent of the layer.

setExtent

public void setExtent(AimsEnvelope envelope)

Sets the envelope (extent) of the layer.

Specified by:

setExtent in interface AimsLayer

Parameters:

envelope - The envelope (extent) of the layer.

getZoomExtentBuffer

public java.lang.Double getZoomExtentBuffer()

getProperty

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

Gets the value of a property set in the configuration XML using a <property> element.

Specified by:

getProperty in interface AimsLayer

Parameters:

name - The property name

Returns:

The property value, or null.

setProperty

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

Sets the value of a property (programmer defined).

Specified by:

setProperty in interface AimsLayer

Parameters:

name - The property name

value - The property value.

getCanZoomToLayer

public boolean getCanZoomToLayer()

Returns a boolean indicator of whether the zoom to layer extent function should be enabled for this layer.

Specified by:

getCanZoomToLayer in interface AimsLayer

Returns:

True if the user can zoom to this layer, otherwise false.

setCanZoomToLayer

public void setCanZoomToLayer(boolean canZoom)

Sets whether the zoom to layer extent function should be enabled for this layer.

Returns:

True if the user can zoom to this layer, otherwise false.

getGeocodeServer

public java.lang.String getGeocodeServer()

Gets the alternate geocoding server for this layer. For use when using ArcMap services that don't support geocoding.

Returns:

the geocode server.

getGeocodeServlet

public java.lang.String getGeocodeServlet()

Gets the alternate geocoding servlet for this layer. For use when using ArcMap services that don't support geocoding.

Returns:

the geocode servlet.

getGeocodeService

public java.lang.String getGeocodeService()

Gets the alternate geocoding servide name for this layer. For use when using ArcMap services that don't support geocoding.

Returns:

the geocode service name.

getGeocodeLayerId

public java.lang.String getGeocodeLayerId()

Gets the alternate geocoding layerid for this layer. For use when using ArcMap services that don't support geocoding.

Returns:

the geocode layer id in the other service.

getCanSymbolize

public boolean getCanSymbolize()

Gets an indicator of whether the layer can be symbolized.

Specified by:

getCanSymbolize in interface AimsLayer

Returns:

True if the layer can be symbolized, otherwise false;

setCanSymbolize

public void setCanSymbolize(boolean canSymbolize)

Sets whether the layer can be symbolized.

Parameters:

canSymbolize - 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.

Specified by:

getShowSymbolizeIcon in interface AimsLayer

Returns:

True if the icon is displayed, otherwise false;

setShowSymbolizeIcon

public void setShowSymbolizeIcon(boolean showSymbolizeIcon)

Sets whether the symbolize icon is displayed in the layer list.

getSymbolizeScript

public java.lang.String getSymbolizeScript()

Gets the name of the symbolize script used for symbolization.

Returns:

The filename of the script, relative to the IMF directory.

setSymbolizeScript

public void setSymbolizeScript(java.lang.String jspScript)

Sets the name of the symbolize script used for symbolization.

Parameters:

jspScript - The filename of the script, relative to the IMF directory.

adjustScaleFactors

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

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

Specified by:

adjustScaleFactors in interface AimsLayer

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 and its renderers. Used when changing the units of a map.

Specified by:

adjustScaleFactors in interface AimsLayer

Parameters:

multiplier - The multiplication factor for adjusting scale factors.