com.esri.arcgis.geoprocessing
Class GPFeatureRecordSetLayer

java.lang.Object
  com.esri.arcgis.geoprocessing.GPFeatureRecordSetLayer

All Implemented Interfaces:

IGPValue, IGPFeatureRecordSet, IGPFeatureRecordSetLayer, IGPLayerDescription, IGPRecordSet, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPFeatureRecordSetLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPFeatureRecordSetLayer, IGPLayerDescription, IGPFeatureRecordSet, IGPRecordSet, IClone, IPersistStream, IXMLSerialize, Externalizable

GPFeatureRecordSetLayer Class

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPFeatureRecordSetLayer()
Constructs a GPFeatureRecordSetLayer using ArcGIS Engine.

GPFeatureRecordSetLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPFeatureRecordSetLayer theGPFeatureRecordSetLayer = (GPFeatureRecordSetLayer) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ILayerDrawingDescription	getLayerDrawingDescription() The layer drawing description.
String	getOIDFieldName() The OID field name.
IRecordSet	getRecordSet() The recordset data.
Object	getRenderer() Get the layer renderer.
String	getShapeFieldName() The shape field name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isExceededTransferLimit() The has transfer limit been reached flag.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(String text) Provides the value of the value object with the given string value.
void	setExceededTransferLimit(boolean flag) The has transfer limit been reached flag.
void	setLayerDrawingDescriptionByRef(ILayerDrawingDescription ppDesc) The layer drawing description.
void	setOIDFieldName(String name) The OID field name.
void	setRecordSetByRef(IRecordSet ppRs) The recordset data.
void	setShapeFieldName(String name) The shape field name.
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

GPFeatureRecordSetLayer

public GPFeatureRecordSetLayer()
                        throws IOException,
                               UnknownHostException

Constructs a GPFeatureRecordSetLayer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPFeatureRecordSetLayer

public GPFeatureRecordSetLayer(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPFeatureRecordSetLayer theGPFeatureRecordSetLayer = (GPFeatureRecordSetLayer) obj;

Construct a GPFeatureRecordSetLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GPFeatureRecordSetLayer.

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

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDrawingDescription

public ILayerDrawingDescription getLayerDrawingDescription()
                                                    throws IOException,
                                                           AutomationException

The layer drawing description.

Product Availability

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

Specified by:

getLayerDrawingDescription in interface IGPLayerDescription

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDrawingDescriptionByRef

public void setLayerDrawingDescriptionByRef(ILayerDrawingDescription ppDesc)
                                     throws IOException,
                                            AutomationException

The layer drawing description.

Product Availability

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

Specified by:

setLayerDrawingDescriptionByRef in interface IGPLayerDescription

Parameters:

ppDesc - A reference to a com.esri.arcgis.carto.ILayerDrawingDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

public Object getRenderer()
                   throws IOException,
                          AutomationException

Get the layer renderer.

Product Availability

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

Specified by:

getRenderer in interface IGPLayerDescription

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

public String getShapeFieldName()
                         throws IOException,
                                AutomationException

The shape field name.

Product Availability

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

Specified by:

getShapeFieldName in interface IGPFeatureRecordSet

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeFieldName

public void setShapeFieldName(String name)
                       throws IOException,
                              AutomationException

The shape field name.

Product Availability

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

Specified by:

setShapeFieldName in interface IGPFeatureRecordSet

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecordSet

public IRecordSet getRecordSet()
                        throws IOException,
                               AutomationException

The recordset data.

Product Availability

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

Specified by:

getRecordSet in interface IGPRecordSet

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecordSetByRef

public void setRecordSetByRef(IRecordSet ppRs)
                       throws IOException,
                              AutomationException

The recordset data.

Product Availability

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

Specified by:

setRecordSetByRef in interface IGPRecordSet

Parameters:

ppRs - A reference to a com.esri.arcgis.geodatabase.IRecordSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The OID field name.

Product Availability

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

Specified by:

getOIDFieldName in interface IGPRecordSet

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

public void setOIDFieldName(String name)
                     throws IOException,
                            AutomationException

The OID field name.

Product Availability

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

Specified by:

setOIDFieldName in interface IGPRecordSet

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExceededTransferLimit

public boolean isExceededTransferLimit()
                                throws IOException,
                                       AutomationException

The has transfer limit been reached flag.

Product Availability

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

Specified by:

isExceededTransferLimit in interface IGPRecordSet

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExceededTransferLimit

public void setExceededTransferLimit(boolean flag)
                              throws IOException,
                                     AutomationException

The has transfer limit been reached flag.

Product Availability

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

Specified by:

setExceededTransferLimit in interface IGPRecordSet

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (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