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, java.io.Externalizable, java.io.Serializable

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

COM Class 'GPFieldMap'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Geoprocessing Field Map object describing an entry within the Field Map.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldMap

IID, IID64dc7625_bb93_4cad_bbca_c4bf5e9f6807, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

GPFieldMap()
Constructs a GPFieldMap using ArcGIS Engine.

GPFieldMap(java.lang.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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	findInputField(IDETable table, java.lang.String fieldName) Find an internal mapped field.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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(java.io.ObjectInput in)
void	release() Release a GPFieldMap.
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(java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GPFieldMap

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

Constructs a GPFieldMap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPFieldMap

public GPFieldMap(java.lang.Object obj)
           throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPFieldMap.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

removeAll

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

Remove all of the mapped fields.

Specified by:

removeAll in interface IGPFieldMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Get the count of mapped fields.

Specified by:

getCount in interface IGPFieldMap

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

Get the mapped fields.

Specified by:

getFields in interface IGPFieldMap

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputField

public IField getOutputField()
                      throws java.io.IOException,
                             AutomationException

Get the main field.

Specified by:

getOutputField in interface IGPFieldMap

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputFieldByRef

public void setOutputFieldByRef(IField field)
                         throws java.io.IOException,
                                AutomationException

Get the main field.

Specified by:

setOutputFieldByRef in interface IGPFieldMap

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMergeRule

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

Get the merge rule.

Specified by:

getMergeRule in interface IGPFieldMap

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMergeRule

public void setMergeRule(int rule)
                  throws java.io.IOException,
                         AutomationException

Get the merge rule.

Specified by:

setMergeRule in interface IGPFieldMap

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

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

Get the join delimiter.

Specified by:

getJoinDelimiter in interface IGPFieldMap

Returns:

The delimiter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

public void setJoinDelimiter(java.lang.String delimiter)
                      throws java.io.IOException,
                             AutomationException

Get the join delimiter.

Specified by:

setJoinDelimiter in interface IGPFieldMap

Parameters:

delimiter - The delimiter (in)

Throws:

java.io.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 java.io.IOException,
                          AutomationException

Add an internal mapped field.

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:

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

AutomationException - If the ArcObject component throws an exception.

findInputField

public int findInputField(IDETable table,
                          java.lang.String fieldName)
                   throws java.io.IOException,
                          AutomationException

Find an internal mapped field.

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:

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

AutomationException - If the ArcObject component throws an exception.

removeField

public void removeField(int index)
                 throws java.io.IOException,
                        AutomationException

Remove an internal mapped field.

Specified by:

removeField in interface IGPFieldMap

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws java.io.IOException,
                       AutomationException

Get an internal mapped field.

Specified by:

getField in interface IGPFieldMap

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTable

public IDETable getTable(int index)
                  throws java.io.IOException,
                         AutomationException

Get an internal mapped field table.

Specified by:

getTable in interface IGPFieldMap

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.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 java.io.IOException,
                       AutomationException

Get the start and end text positions.

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:

java.io.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 java.io.IOException,
                       AutomationException

Set the start and end text positions.

Specified by:

setTextPos in interface IGPFieldMap

Parameters:

index - The index (in)

start - The start (in)

end - The end (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException