com.esri.arcgis.datasourcesfile
Class GPArcInfoItem

java.lang.Object
  com.esri.arcgis.datasourcesfile.GPArcInfoItem

All Implemented Interfaces:

IGPArcInfoItem, IGPDescribe, IGPValue, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPArcInfoItem
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPArcInfoItem, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe, java.io.Externalizable

COM Class 'GPArcInfoItem'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesFile.olb'

Description 'ArcInfo Item Data Element object.' 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.datasourcesfile.IGPArcInfoItem

IID, IIDc95b22e0_a3c3_11d5_931c_0080c71a3226, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, 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.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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

GPArcInfoItem()
Constructs a GPArcInfoItem using ArcGIS Engine.

GPArcInfoItem(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPArcInfoItem theGPArcInfoItem = (GPArcInfoItem) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	describe(java.lang.String name) The description of the named object.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getAlternateName() The alternate name of the info item.
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the info item.
int	getNumberDecimals() The number of decimal places of the info item.
int	getOutputWidth() The output width of the info item.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStartPosition() The start position of the info item.
int	getType() The type of the info item.
int	getWidth() The width of the info item.
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	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isIndexed() Indicates if the info item has an index.
boolean	isPseudo() Indicates if the item a psuedo item.
boolean	isRedefined() Indicates if the info item redefined.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPArcInfoItem.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAlternateName(java.lang.String alternateName) The alternate name of the info item.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setIsIndexed(boolean isIndexed) Indicates if the info item has an index.
void	setIsPseudo(boolean isPsuedo) Indicates if the item a psuedo item.
void	setIsRedefined(boolean redefined) Indicates if the info item redefined.
void	setName(java.lang.String name) The name of the info item.
void	setNumberDecimals(int number) The number of decimal places of the info item.
void	setOutputWidth(int width) The output width of the info item.
void	setStartPosition(int position) The start position of the info item.
void	setType(int type) The type of the info item.
void	setWidth(int width) The width of the info item.
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

GPArcInfoItem

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

Constructs a GPArcInfoItem using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPArcInfoItem

public GPArcInfoItem(java.lang.Object obj)
              throws java.io.IOException

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

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

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 GPArcInfoItem.

Specified by:

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

getName

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

The name of the info item.

Specified by:

getName in interface IGPArcInfoItem

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the info item.

Specified by:

setName in interface IGPArcInfoItem

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartPosition

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

The start position of the info item.

Specified by:

getStartPosition in interface IGPArcInfoItem

Returns:

The position

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartPosition

public void setStartPosition(int position)
                      throws java.io.IOException,
                             AutomationException

The start position of the info item.

Specified by:

setStartPosition in interface IGPArcInfoItem

Parameters:

position - The position (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

The width of the info item.

Specified by:

getWidth in interface IGPArcInfoItem

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws java.io.IOException,
                     AutomationException

The width of the info item.

Specified by:

setWidth in interface IGPArcInfoItem

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputWidth

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

The output width of the info item.

Specified by:

getOutputWidth in interface IGPArcInfoItem

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputWidth

public void setOutputWidth(int width)
                    throws java.io.IOException,
                           AutomationException

The output width of the info item.

Specified by:

setOutputWidth in interface IGPArcInfoItem

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the info item.

Specified by:

getType in interface IGPArcInfoItem

Returns:

A com.esri.arcgis.datasourcesfile.esriArcInfoItemType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int type)
             throws java.io.IOException,
                    AutomationException

The type of the info item.

Specified by:

setType in interface IGPArcInfoItem

Parameters:

type - A com.esri.arcgis.datasourcesfile.esriArcInfoItemType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberDecimals

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

The number of decimal places of the info item.

Specified by:

getNumberDecimals in interface IGPArcInfoItem

Returns:

The number

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberDecimals

public void setNumberDecimals(int number)
                       throws java.io.IOException,
                              AutomationException

The number of decimal places of the info item.

Specified by:

setNumberDecimals in interface IGPArcInfoItem

Parameters:

number - The number (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlternateName

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

The alternate name of the info item.

Specified by:

getAlternateName in interface IGPArcInfoItem

Returns:

The alternateName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlternateName

public void setAlternateName(java.lang.String alternateName)
                      throws java.io.IOException,
                             AutomationException

The alternate name of the info item.

Specified by:

setAlternateName in interface IGPArcInfoItem

Parameters:

alternateName - The alternateName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRedefined

public boolean isRedefined()
                    throws java.io.IOException,
                           AutomationException

Indicates if the info item redefined.

Specified by:

isRedefined in interface IGPArcInfoItem

Returns:

The redefined

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsRedefined

public void setIsRedefined(boolean redefined)
                    throws java.io.IOException,
                           AutomationException

Indicates if the info item redefined.

Specified by:

setIsRedefined in interface IGPArcInfoItem

Parameters:

redefined - The redefined (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIndexed

public boolean isIndexed()
                  throws java.io.IOException,
                         AutomationException

Indicates if the info item has an index.

Specified by:

isIndexed in interface IGPArcInfoItem

Returns:

The isIndexed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsIndexed

public void setIsIndexed(boolean isIndexed)
                  throws java.io.IOException,
                         AutomationException

Indicates if the info item has an index.

Specified by:

setIsIndexed in interface IGPArcInfoItem

Parameters:

isIndexed - The isIndexed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPseudo

public boolean isPseudo()
                 throws java.io.IOException,
                        AutomationException

Indicates if the item a psuedo item.

Specified by:

isPseudo in interface IGPArcInfoItem

Returns:

The isPsuedo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsPseudo

public void setIsPseudo(boolean isPsuedo)
                 throws java.io.IOException,
                        AutomationException

Indicates if the item a psuedo item.

Specified by:

setIsPseudo in interface IGPArcInfoItem

Parameters:

isPsuedo - The isPsuedo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

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

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

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

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

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.

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.

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.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

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