com.esri.arcgis.geoprocessing
Class GPFieldMap

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

All Implemented Interfaces:

IGPFieldMap, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPFieldMap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPFieldMap, IClone, IXMLSerialize, IPersistStream, Externalizable

Geoprocessing Field Map object describing an entry within the Field Map.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPFieldMap()
Constructs a GPFieldMap using ArcGIS Engine.

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

Method Summary

void	addInputField(IDETable table, IField field, int startPos, int endPos) Add an internal mapped field.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	findInputField(IDETable table, String fieldName) Find an internal mapped field.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getCount() Get the count of mapped fields.
IField	getField(int index) Get an internal mapped field.
IFields	getFields() Get the mapped fields.
String	getJoinDelimiter() Get the join delimiter.
int	getMergeRule() Get the merge rule.
IField	getOutputField() Get the main field.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IDETable	getTable(int index) Get an internal mapped field table.
void	getTextPos(int index, int[] start, int[] end) Get the start and end text positions.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeAll() Remove all of the mapped fields.
void	removeField(int index) Remove an internal mapped field.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setJoinDelimiter(String delimiter) Get the join delimiter.
void	setMergeRule(int rule) Get the merge rule.
void	setOutputFieldByRef(IField field) Get the main field.
void	setTextPos(int index, int start, int end) Set the start and end text positions.
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

GPFieldMap

public GPFieldMap()
           throws IOException,
                  UnknownHostException

Constructs a GPFieldMap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPFieldMap

public GPFieldMap(Object obj)
           throws IOException

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

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

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

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Remove all of the mapped fields.

Product Availability

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

Specified by:

removeAll in interface IGPFieldMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

Get the count of mapped fields.

Product Availability

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

Specified by:

getCount in interface IGPFieldMap

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

Get the mapped fields.

Product Availability

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

Specified by:

getFields in interface IGPFieldMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputField

public IField getOutputField()
                      throws IOException,
                             AutomationException

Get the main field.

Product Availability

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

Specified by:

getOutputField in interface IGPFieldMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputFieldByRef

public void setOutputFieldByRef(IField field)
                         throws IOException,
                                AutomationException

Get the main field.

Product Availability

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

Specified by:

setOutputFieldByRef in interface IGPFieldMap

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMergeRule

public int getMergeRule()
                 throws IOException,
                        AutomationException

Get the merge rule.

Product Availability

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

Specified by:

getMergeRule in interface IGPFieldMap

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMergeRule

public void setMergeRule(int rule)
                  throws IOException,
                         AutomationException

Get the merge rule.

Product Availability

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

Specified by:

setMergeRule in interface IGPFieldMap

Parameters:

rule - A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

public String getJoinDelimiter()
                        throws IOException,
                               AutomationException

Get the join delimiter.

Product Availability

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

Specified by:

getJoinDelimiter in interface IGPFieldMap

Returns:

The delimiter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

public void setJoinDelimiter(String delimiter)
                      throws IOException,
                             AutomationException

Get the join delimiter.

Product Availability

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

Specified by:

setJoinDelimiter in interface IGPFieldMap

Parameters:

delimiter - The delimiter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInputField

public void addInputField(IDETable table,
                          IField field,
                          int startPos,
                          int endPos)
                   throws IOException,
                          AutomationException

Add an internal mapped field.

Product Availability

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

Specified by:

addInputField in interface IGPFieldMap

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

startPos - The startPos (in)

endPos - The endPos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findInputField

public int findInputField(IDETable table,
                          String fieldName)
                   throws IOException,
                          AutomationException

Find an internal mapped field.

Product Availability

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

Specified by:

findInputField in interface IGPFieldMap

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

fieldName - The fieldName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeField

public void removeField(int index)
                 throws IOException,
                        AutomationException

Remove an internal mapped field.

Product Availability

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

Specified by:

removeField in interface IGPFieldMap

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws IOException,
                       AutomationException

Get an internal mapped field.

Product Availability

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

Specified by:

getField in interface IGPFieldMap

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public IDETable getTable(int index)
                  throws IOException,
                         AutomationException

Get an internal mapped field table.

Product Availability

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

Specified by:

getTable in interface IGPFieldMap

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPos

public void getTextPos(int index,
                       int[] start,
                       int[] end)
                throws IOException,
                       AutomationException

Get the start and end text positions.

Product Availability

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

Specified by:

getTextPos in interface IGPFieldMap

Parameters:

index - The index (in)

start - The start (out: use single element array)

end - The end (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPos

public void setTextPos(int index,
                       int start,
                       int end)
                throws IOException,
                       AutomationException

Set the start and end text positions.

Product Availability

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

Specified by:

setTextPos in interface IGPFieldMap

Parameters:

index - The index (in)

start - The start (in)

end - The end (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.

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.

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.

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