com.esri.arcgis.geoprocessing
Class GPFieldInfoProperty

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

All Implemented Interfaces:

IGPFieldInfoProperty, IGPFieldInfoProperty2, IGPFieldInfoProperty3, com.esri.arcgis.interop.RemoteObjRef, IXMLSerialize, Serializable

public class GPFieldInfoProperty
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPFieldInfoProperty, IGPFieldInfoProperty2, IGPFieldInfoProperty3, IXMLSerialize

Geoprocessing value object describing a field.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GPFieldInfoProperty()
Constructs a GPFieldInfoProperty using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
String	getAlias() FieldInfo Property Alias.
static String	getClsid() getClsid.
int	getIndex() FieldInfo Property Index.
String	getJoinDelimiter() FieldInfo Property Join Delimiter.
int	getMergeRule() FieldInfo Property Merge Rule.
String	getName() FieldInfo Property Name.
String	getRealAlias() FieldInfo Property Real Alias.
int	getSplitRule() FieldInfo Property Split Rule.
void	getTextPos(int[] start, int[] end) Returns the start and end text positions.
int	hashCode() the hashcode for this object
boolean	isHasError() Indicates whether or not the field info property has an error.
boolean	isVisible() Indicates whether or not the field is visible.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAlias(String alias) FieldInfo Property Alias.
void	setHasError(boolean error) Indicates whether or not the field info property has an error.
void	setIndex(int index) FieldInfo Property Index.
void	setJoinDelimiter(String delimiter) FieldInfo Property Join Delimiter.
void	setMergeRule(int rule) FieldInfo Property Merge Rule.
void	setName(String name) FieldInfo Property Name.
void	setRealAlias(String alias) FieldInfo Property Real Alias.
void	setSplitRule(int rule) FieldInfo Property Split Rule.
void	setTextPos(int start, int end) Sets the start and end text positions.
void	setVisible(boolean visible) Indicates whether or not the field is visible.

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

GPFieldInfoProperty

public GPFieldInfoProperty()
                    throws IOException,
                           UnknownHostException

Constructs a GPFieldInfoProperty using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPFieldInfoProperty

public GPFieldInfoProperty(Object obj)
                    throws IOException

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

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

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

getIndex

public int getIndex()
             throws IOException,
                    AutomationException

FieldInfo Property Index.

Product Availability

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

Supported Platforms

Windows

Specified by:

getIndex in interface IGPFieldInfoProperty

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndex

public void setIndex(int index)
              throws IOException,
                     AutomationException

FieldInfo Property Index.

Product Availability

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

Supported Platforms

Windows

Specified by:

setIndex in interface IGPFieldInfoProperty

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

FieldInfo Property Name.

Product Availability

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

Supported Platforms

Windows

Specified by:

getName in interface IGPFieldInfoProperty

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

FieldInfo Property Name.

Product Availability

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

Supported Platforms

Windows

Specified by:

setName in interface IGPFieldInfoProperty

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException

FieldInfo Property Alias.

Product Availability

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

Supported Platforms

Windows

Specified by:

getAlias in interface IGPFieldInfoProperty

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlias

public void setAlias(String alias)
              throws IOException,
                     AutomationException

FieldInfo Property Alias.

Product Availability

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

Supported Platforms

Windows

Specified by:

setAlias in interface IGPFieldInfoProperty

Parameters:

alias - The alias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplitRule

public int getSplitRule()
                 throws IOException,
                        AutomationException

FieldInfo Property Split Rule.

Product Availability

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

Supported Platforms

Windows

Specified by:

getSplitRule in interface IGPFieldInfoProperty

Returns:

A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSplitRule

public void setSplitRule(int rule)
                  throws IOException,
                         AutomationException

FieldInfo Property Split Rule.

Product Availability

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

Supported Platforms

Windows

Specified by:

setSplitRule in interface IGPFieldInfoProperty

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates whether or not the field is visible.

Product Availability

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

Supported Platforms

Windows

Specified by:

isVisible in interface IGPFieldInfoProperty

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 whether or not the field is visible.

Product Availability

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

Supported Platforms

Windows

Specified by:

setVisible in interface IGPFieldInfoProperty

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasError

public boolean isHasError()
                   throws IOException,
                          AutomationException

Indicates whether or not the field info property has an error.

Product Availability

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

Supported Platforms

Windows

Specified by:

isHasError in interface IGPFieldInfoProperty

Returns:

The error

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasError

public void setHasError(boolean error)
                 throws IOException,
                        AutomationException

Indicates whether or not the field info property has an error.

Product Availability

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

Supported Platforms

Windows

Specified by:

setHasError in interface IGPFieldInfoProperty

Parameters:

error - The error (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMergeRule

public int getMergeRule()
                 throws IOException,
                        AutomationException

FieldInfo Property Merge Rule.

Product Availability

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

Specified by:

getMergeRule in interface IGPFieldInfoProperty2

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

FieldInfo Property Merge Rule.

Product Availability

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

Specified by:

setMergeRule in interface IGPFieldInfoProperty2

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

FieldInfo Property Join Delimiter.

Product Availability

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

Specified by:

getJoinDelimiter in interface IGPFieldInfoProperty2

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

FieldInfo Property Join Delimiter.

Product Availability

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

Specified by:

setJoinDelimiter in interface IGPFieldInfoProperty2

Parameters:

delimiter - The delimiter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPos

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

Returns the start and end text positions.

Product Availability

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

Specified by:

getTextPos in interface IGPFieldInfoProperty2

Parameters:

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 start,
                       int end)
                throws IOException,
                       AutomationException

Sets the start and end text positions.

Product Availability

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

Specified by:

setTextPos in interface IGPFieldInfoProperty2

Parameters:

start - The start (in)

end - The end (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRealAlias

public String getRealAlias()
                    throws IOException,
                           AutomationException

FieldInfo Property Real Alias.

Product Availability

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

Specified by:

getRealAlias in interface IGPFieldInfoProperty3

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRealAlias

public void setRealAlias(String alias)
                  throws IOException,
                         AutomationException

FieldInfo Property Real Alias.

Product Availability

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

Specified by:

setRealAlias in interface IGPFieldInfoProperty3

Parameters:

alias - The alias (in)

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.