com.esri.arcgis.carto
Class ACFeatureLayer

java.lang.Object
  extended by com.esri.arcgis.carto.ACFeatureLayer
All Implemented Interfaces:
IACFeatureLayer, IACFeatureLayerAdmin, IACLayer, IACLayer2, IACLayerAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class ACFeatureLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IACLayer, IACLayerAdmin, IACFeatureLayer, IACFeatureLayerAdmin, IPersist, IPersistStream, IACLayer2, Externalizable

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(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACFeatureLayer theACFeatureLayer = (ACFeatureLayer) obj;
 
Method Summary
 void connect(String layerInfo, IIMSAxlRequest request, ISpatialReference spatialRef, int mapUnits, IFeatureClass featureClass)
          Connects to the feature layer.
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 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.
 String getID()
          The layer id.
 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.
 String getName()
          The layer name.
 ISpatialReference getNativeSpatialReference()
          The native spatial reference of the data.
 String getOriginalName()
          The name of the layer that the ArcIMS Server hands out.
 String getParentLayerID()
          The parent layer id.
 IACRenderer getRenderer()
          Renderer used to draw the layer.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getXMLLayerInfo()
          The XML LayerInfo.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 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)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setDisplayAnnotation(boolean flag)
          Indicates if the layer displays annotation.
 void setDisplayField(String fieldName)
          The primary display field.
 void setID(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(String name)
          The layer name.
 void setOriginalName(String name)
          The name of the layer that the ArcIMS Server hands out.
 void setParentLayerID(String iD)
          The parent layer id.
 void setRendererByRef(IACRenderer renderer)
          Renderer used to draw the layer.
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ACFeatureLayer

public ACFeatureLayer()
               throws IOException,
                      UnknownHostException
Constructs a ACFeatureLayer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ACFeatureLayer

public ACFeatureLayer(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACFeatureLayer theACFeatureLayer = (ACFeatureLayer) obj;

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.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException
The layer name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IACLayer
Specified by:
getName in interface IACLayer2
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The layer name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IACLayer
Specified by:
setName in interface IACLayer2
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginalName

public String getOriginalName()
                       throws IOException,
                              AutomationException
The name of the layer that the ArcIMS Server hands out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOriginalName in interface IACLayer
Specified by:
getOriginalName in interface IACLayer2
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginalName

public void setOriginalName(String name)
                     throws IOException,
                            AutomationException
The name of the layer that the ArcIMS Server hands out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOriginalName in interface IACLayer
Specified by:
setOriginalName in interface IACLayer2
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public String getID()
             throws IOException,
                    AutomationException
The layer id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getID in interface IACLayer
Specified by:
getID in interface IACLayer2
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setID

public void setID(String iD)
           throws IOException,
                  AutomationException
The layer id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setID in interface IACLayer
Specified by:
setID in interface IACLayer2
Parameters:
iD - The iD (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVisible in interface IACLayer
Specified by:
isVisible in interface IACLayer2
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVisible in interface IACLayer
Specified by:
setVisible in interface IACLayer2
Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinScale

public double getMinScale()
                   throws IOException,
                          AutomationException
Minimum scale at which the layer will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinScale in interface IACLayer
Specified by:
getMinScale in interface IACLayer2
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinScale

public void setMinScale(double scale)
                 throws IOException,
                        AutomationException
Minimum scale at which the layer will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinScale in interface IACLayer
Specified by:
setMinScale in interface IACLayer2
Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxScale

public double getMaxScale()
                   throws IOException,
                          AutomationException
Maximum scale at which the layer will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaxScale in interface IACLayer
Specified by:
getMaxScale in interface IACLayer2
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxScale

public void setMaxScale(double scale)
                 throws IOException,
                        AutomationException
Maximum scale at which the layer will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaxScale in interface IACLayer
Specified by:
setMaxScale in interface IACLayer2
Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerDefAxl

public Object getLayerDefAxl()
                      throws IOException,
                             AutomationException
The layer def axl.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayerDefAxl in interface IACLayer
Specified by:
getLayerDefAxl in interface IACLayer2
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IACLayer
Specified by:
getExtent in interface IACLayer2
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeSpatialReference

public ISpatialReference getNativeSpatialReference()
                                            throws IOException,
                                                   AutomationException
The native spatial reference of the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNativeSpatialReference in interface IACLayer
Specified by:
getNativeSpatialReference in interface IACLayer2
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXMLLayerInfo

public String getXMLLayerInfo()
                       throws IOException,
                              AutomationException
The XML LayerInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getXMLLayerInfo in interface IACLayerAdmin
Returns:
The xmlString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderer

public IACRenderer getRenderer()
                        throws IOException,
                               AutomationException
Renderer used to draw the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRenderer in interface IACFeatureLayer
Returns:
A reference to a com.esri.arcgis.carto.IACRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IACRenderer renderer)
                      throws IOException,
                             AutomationException
Renderer used to draw the layer.

Product Availability

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

Specified by:
setRendererByRef in interface IACFeatureLayer
Parameters:
renderer - A reference to a com.esri.arcgis.carto.IACRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws IOException,
                           AutomationException
The type of the Shape for the features in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGeometryType in interface IACFeatureLayer
Returns:
A com.esri.arcgis.carto.acGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException
The layer's feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFeatureClass in interface IACFeatureLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException
The primary display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayField in interface IACFeatureLayer
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayField

public void setDisplayField(String fieldName)
                     throws IOException,
                            AutomationException
The primary display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayField in interface IACFeatureLayer
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasLabels

public boolean isHasLabels()
                    throws IOException,
                           AutomationException
Indicates if the layer has labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHasLabels in interface IACFeatureLayer
Returns:
The hasLabels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws IOException,
                                   AutomationException
Indicates if the layer displays annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDisplayAnnotation in interface IACFeatureLayer
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean flag)
                          throws IOException,
                                 AutomationException
Indicates if the layer displays annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayAnnotation in interface IACFeatureLayer
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public void connect(String layerInfo,
                    IIMSAxlRequest request,
                    ISpatialReference spatialRef,
                    int mapUnits,
                    IFeatureClass featureClass)
             throws IOException,
                    AutomationException
Connects to the feature layer.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParentLayerID

public String getParentLayerID()
                        throws IOException,
                               AutomationException
The parent layer id.

Product Availability

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

Specified by:
getParentLayerID in interface IACLayer2
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParentLayerID

public void setParentLayerID(String iD)
                      throws IOException,
                             AutomationException
The parent layer id.

Product Availability

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

Specified by:
setParentLayerID in interface IACLayer2
Parameters:
iD - The iD (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException