com.esri.arcgis.carto
Class ACFeatureLayer

java.lang.Object
  com.esri.arcgis.carto.ACFeatureLayer

All Implemented Interfaces:

IACFeatureLayer, IACFeatureLayerAdmin, IACLayer, IACLayerAdmin, IPersist, IPersistStream, java.io.Serializable

public class ACFeatureLayer

extends java.lang.Object

implements IACLayer, IACLayerAdmin, IACFeatureLayer, IACFeatureLayerAdmin, IPersist, IPersistStream

ArcIMS layer for displaying features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACFeatureLayer()
Constructs a ACFeatureLayer using ArcGIS Engine.

ACFeatureLayer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	connect(java.lang.String layerInfo, IIMSAxlRequest request, ISpatialReference spatialRef, int mapUnits, IFeatureClass featureClass) Connects to the feature layer.
boolean	equals(java.lang.Object o) Compare this object with another
IACFeatureLayer	getAsIACFeatureLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACFeatureLayerAdmin	getAsIACFeatureLayerAdmin() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACLayer	getAsIACLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACLayerAdmin	getAsIACLayerAdmin() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.String	getDisplayField() The primary display field.
IEnvelope	getExtent() The extent of the layer.
IFeatureClass	getFeatureClass() The layer's feature class.
int	getGeometryType() The type of the Shape for the features in the layer.
java.lang.String	getID() The layer id.
java.lang.Object	getLayerDefAxl() The layer def axl.
double	getMaxScale() Maximum scale at which the layer will display.
double	getMinScale() Minimum scale at which the layer will display.
java.lang.String	getName() The layer name.
ISpatialReference	getNativeSpatialReference() The native spatial reference of the data.
java.lang.String	getOriginalName() The name of the layer that the ArcIMS Server hands out.
IACRenderer	getRenderer() Renderer used to draw the layer.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
java.lang.String	getXMLLayerInfo() The XML LayerInfo.
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isDisplayAnnotation() Indicates if the layer displays annotation.
boolean	isHasLabels() Indicates if the layer has labels.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setDisplayAnnotation(boolean flag) Indicates if the layer displays annotation.
void	setDisplayField(java.lang.String fieldName) The primary display field.
void	setID(java.lang.String iD) The layer id.
void	setMaxScale(double scale) Maximum scale at which the layer will display.
void	setMinScale(double scale) Minimum scale at which the layer will display.
void	setName(java.lang.String name) The layer name.
void	setOriginalName(java.lang.String name) The name of the layer that the ArcIMS Server hands out.
void	setRendererByRef(IACRenderer renderer) Renderer used to draw the layer.
void	setVisible(boolean visible) Indicates if the layer is currently visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACFeatureLayer

public ACFeatureLayer()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a ACFeatureLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACFeatureLayer

public ACFeatureLayer(java.lang.Object obj)
               throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ACFeatureLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACFeatureLayer.
ACFeatureLayer theACFeatureLayer = (ACFeatureLayer) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIACLayer

public IACLayer getAsIACLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACLayerAdmin

public IACLayerAdmin getAsIACLayerAdmin()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACFeatureLayer

public IACFeatureLayer getAsIACFeatureLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACFeatureLayerAdmin

public IACFeatureLayerAdmin getAsIACFeatureLayerAdmin()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IACLayer

The layer name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IACLayer

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACLayer

The layer name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IACLayer

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginalName

public java.lang.String getOriginalName()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IACLayer

The name of the layer that the ArcIMS Server hands out.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOriginalName in interface IACLayer

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setOriginalName

public void setOriginalName(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACLayer

The name of the layer that the ArcIMS Server hands out.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOriginalName in interface IACLayer

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getID

public java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACLayer

The layer id.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getID in interface IACLayer

Returns:

The iD

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(java.lang.String iD)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IACLayer

The layer id.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setID in interface IACLayer

Parameters:

iD - The iD (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACLayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface IACLayer

Returns:

The visible

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACLayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface IACLayer

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinScale

public double getMinScale()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IACLayer

Minimum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinScale in interface IACLayer

Returns:

The scale

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMinScale

public void setMinScale(double scale)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACLayer

Minimum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinScale in interface IACLayer

Parameters:

scale - The scale (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getMaxScale

public double getMaxScale()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IACLayer

Maximum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxScale in interface IACLayer

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxScale

public void setMaxScale(double scale)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACLayer

Maximum scale at which the layer will display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxScale in interface IACLayer

Parameters:

scale - The scale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDefAxl

public java.lang.Object getLayerDefAxl()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IACLayer

The layer def axl.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerDefAxl in interface IACLayer

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACLayer

The extent of the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IACLayer

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Description copied from interface: IACLayer

The native spatial reference of the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeSpatialReference in interface IACLayer

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMLLayerInfo

public java.lang.String getXMLLayerInfo()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IACLayerAdmin

The XML LayerInfo.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXMLLayerInfo in interface IACLayerAdmin

Returns:

The xmlString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public IACRenderer getRenderer()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IACFeatureLayer

Renderer used to draw the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRenderer in interface IACFeatureLayer

Returns:

A reference to a com.esri.arcgis.carto.IACRenderer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IACRenderer renderer)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IACFeatureLayer

Renderer used to draw the layer.

Specified by:

setRendererByRef in interface IACFeatureLayer

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IACRenderer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACFeatureLayer

The type of the Shape for the features in the layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometryType in interface IACFeatureLayer

Returns:

A com.esri.arcgis.carto.acGeometryType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IACFeatureLayer

The layer's feature class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureClass in interface IACFeatureLayer

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayField

public java.lang.String getDisplayField()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IACFeatureLayer

The primary display field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayField in interface IACFeatureLayer

Returns:

The fieldName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDisplayField

public void setDisplayField(java.lang.String fieldName)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACFeatureLayer

The primary display field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayField in interface IACFeatureLayer

Parameters:

fieldName - The fieldName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isHasLabels

public boolean isHasLabels()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACFeatureLayer

Indicates if the layer has labels.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasLabels in interface IACFeatureLayer

Returns:

The hasLabels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACFeatureLayer

Indicates if the layer displays annotation.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDisplayAnnotation in interface IACFeatureLayer

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean flag)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACFeatureLayer

Indicates if the layer displays annotation.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayAnnotation in interface IACFeatureLayer

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

connect

public void connect(java.lang.String layerInfo,
                    IIMSAxlRequest request,
                    ISpatialReference spatialRef,
                    int mapUnits,
                    IFeatureClass featureClass)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACFeatureLayerAdmin

Connects to the feature layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

connect in interface IACFeatureLayerAdmin

Parameters:

layerInfo - The layerInfo (in)

request - A reference to a com.esri.arcgis.gisclient.IIMSAxlRequest (in)

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

mapUnits - A com.esri.arcgis.gisclient.acMapUnits constant (in)

featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.