|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.GPFieldInfo
public class GPFieldInfo
COM Class 'GPFieldInfo'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description 'Geoprocessing value object describing a set of fields.' 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 =
Field Summary | |
---|---|
static long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue |
---|
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy |
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldInfo |
---|
IID, IIDb4893c59_ece5_4b2d_ab4a_540abc813789, xxDummy |
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldInfo2 |
---|
IID, IID8c5ea59e_b50b_4898_8624_5eb777dbec66, xxDummy |
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPFieldInfo3 |
---|
IID, IIDece4a21b_087a_4586_a554_13fad0b6ccb3, 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 | |
---|---|
GPFieldInfo()
Constructs a GPFieldInfo using ArcGIS Engine. |
|
GPFieldInfo(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPFieldInfo theGPFieldInfo = (GPFieldInfo) obj; |
Method Summary | |
---|---|
void |
addField(int fieldIndex,
java.lang.String fieldName,
java.lang.String newFieldName,
boolean visible,
int split)
Add a field to the field info object. |
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(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
int |
findFieldByIndex(int fieldIndex)
Returns the index of the field in the field info object matching given the field index. |
int |
findFieldByName(java.lang.String fieldName)
Returns the index of the field in the field info object matching given the field name. |
int |
findFieldByNewName(java.lang.String fieldName)
Returns the index of the field in the field info object matching given the field new name. |
java.lang.String |
getAliasName(int index)
Returns the real alias of the specified field in the field info object. |
java.lang.String |
getAsText()
Provides the value of the value object. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
int |
getCount()
The number of fields in the field info object. |
int |
getFieldIndex(int index)
Returns the field index of the specified field in the field info object. |
java.lang.String |
getFieldName(int index)
Returns the name of the specified field in the field info object. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
java.lang.String |
getJoinDelimiter(int index)
Returns the join delimiter of the specified field in the field info object. |
int |
getMergeRule(int index)
Returns the merge rule of the specified field in the field info object. |
boolean |
getNamingError(int index)
Returns whether there is an error with the specified field in the field info object. |
java.lang.String |
getNewName(int index)
Returns the new name of the specified field in the field info object. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getSplitRule(int index)
Returns the split rule of the specified field in the field info object. |
void |
getTextPos(int index,
int[] start,
int[] end)
Returns the start and end text positions. |
boolean |
getVisible(int index)
Returns the visibility of the specified field in the field info object. |
int |
hashCode()
the hashcode for this object |
IGPDataType |
IGPValue_getDataType()
The data type of the value object. |
void |
initialize(IDETable table,
IDEWorkspace workspace)
Initializes the field info object using the field information from the given table/workspace. |
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. |
void |
load(IStream pstm)
load |
void |
merge(IDETable table)
Merges the field information from the given table data element into the field info object. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a GPFieldInfo. |
void |
removeAll()
Removes all the fields from the field info object. |
void |
removeField(int index)
Removes the given field from the field info object. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setAliasName(int index,
java.lang.String alias)
Sets the real alias of the specified field in the field info object. |
IGPMessage |
setAsText(java.lang.String text)
Provides the value of the value object with the given string value. |
void |
setFieldIndex(int index,
int fieldIndex)
Sets the name of the specified field in the field info object. |
void |
setFieldName(int index,
java.lang.String name)
Sets the name of the specified field in the field info object. |
void |
setJoinDelimiter(int index,
java.lang.String delimiter)
Sets the join delimiter of the specified field in the field info object. |
void |
setMergeRule(int index,
int merge)
Sets the merge rule of the specified field in the field info object. |
void |
setNamingError(int index,
boolean error)
Sets whether there is an error with the specified field in the field info object. |
void |
setNewName(int index,
java.lang.String name)
Sets the new name of the specified field in the field info object. |
void |
setSplitRule(int index,
int split)
Sets the split rule of the specified field in the field info object. |
void |
setTextPos(int index,
int start,
int end)
Sets the start and end text positions. |
void |
setVisible(int index,
boolean visible)
Sets the visibility of the specified field in the field info object. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public GPFieldInfo() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic GPFieldInfo(java.lang.Object obj) throws java.io.IOException
GPFieldInfo theGPFieldInfo = (GPFieldInfo) obj;
obj
to GPFieldInfo
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public IGPDataType IGPValue_getDataType() throws java.io.IOException, AutomationException
IGPValue_getDataType
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEmpty() throws java.io.IOException, AutomationException
isEmpty
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void empty() throws java.io.IOException, AutomationException
empty
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getAsText() throws java.io.IOException, AutomationException
getAsText
in interface IGPValue
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGPMessage setAsText(java.lang.String text) throws java.io.IOException, AutomationException
setAsText
in interface IGPValue
text
- The text (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void initialize(IDETable table, IDEWorkspace workspace) throws java.io.IOException, AutomationException
initialize
in interface IGPFieldInfo
table
- A reference to a com.esri.arcgis.geodatabase.IDETable (in)workspace
- A reference to a com.esri.arcgis.geodatabase.IDEWorkspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void merge(IDETable table) throws java.io.IOException, AutomationException
merge
in interface IGPFieldInfo
table
- A reference to a com.esri.arcgis.geodatabase.IDETable (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeAll() throws java.io.IOException, AutomationException
removeAll
in interface IGPFieldInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addField(int fieldIndex, java.lang.String fieldName, java.lang.String newFieldName, boolean visible, int split) throws java.io.IOException, AutomationException
addField
in interface IGPFieldInfo
fieldIndex
- The fieldIndex (in)fieldName
- The fieldName (in)newFieldName
- The newFieldName (in)visible
- The visible (in)split
- A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws java.io.IOException, AutomationException
getCount
in interface IGPFieldInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getFieldName(int index) throws java.io.IOException, AutomationException
getFieldName
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getFieldIndex(int index) throws java.io.IOException, AutomationException
getFieldIndex
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean getNamingError(int index) throws java.io.IOException, AutomationException
getNamingError
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getNewName(int index) throws java.io.IOException, AutomationException
getNewName
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSplitRule(int index) throws java.io.IOException, AutomationException
getSplitRule
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean getVisible(int index) throws java.io.IOException, AutomationException
getVisible
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFieldName(int index, java.lang.String name) throws java.io.IOException, AutomationException
setFieldName
in interface IGPFieldInfo
index
- The index (in)name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFieldIndex(int index, int fieldIndex) throws java.io.IOException, AutomationException
setFieldIndex
in interface IGPFieldInfo
index
- The index (in)fieldIndex
- The fieldIndex (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNamingError(int index, boolean error) throws java.io.IOException, AutomationException
setNamingError
in interface IGPFieldInfo
index
- The index (in)error
- The error (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setNewName(int index, java.lang.String name) throws java.io.IOException, AutomationException
setNewName
in interface IGPFieldInfo
index
- The index (in)name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSplitRule(int index, int split) throws java.io.IOException, AutomationException
setSplitRule
in interface IGPFieldInfo
index
- The index (in)split
- A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(int index, boolean visible) throws java.io.IOException, AutomationException
setVisible
in interface IGPFieldInfo
index
- The index (in)visible
- The visible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeField(int index) throws java.io.IOException, AutomationException
removeField
in interface IGPFieldInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findFieldByName(java.lang.String fieldName) throws java.io.IOException, AutomationException
findFieldByName
in interface IGPFieldInfo
fieldName
- The fieldName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findFieldByNewName(java.lang.String fieldName) throws java.io.IOException, AutomationException
findFieldByNewName
in interface IGPFieldInfo
fieldName
- The fieldName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findFieldByIndex(int fieldIndex) throws java.io.IOException, AutomationException
findFieldByIndex
in interface IGPFieldInfo
fieldIndex
- The fieldIndex (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMergeRule(int index) throws java.io.IOException, AutomationException
getMergeRule
in interface IGPFieldInfo2
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMergeRule(int index, int merge) throws java.io.IOException, AutomationException
setMergeRule
in interface IGPFieldInfo2
index
- The index (in)merge
- A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getJoinDelimiter(int index) throws java.io.IOException, AutomationException
getJoinDelimiter
in interface IGPFieldInfo2
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setJoinDelimiter(int index, java.lang.String delimiter) throws java.io.IOException, AutomationException
setJoinDelimiter
in interface IGPFieldInfo2
index
- The index (in)delimiter
- The delimiter (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getTextPos(int index, int[] start, int[] end) throws java.io.IOException, AutomationException
getTextPos
in interface IGPFieldInfo2
index
- The index (in)start
- The start (out: use single element array)end
- The end (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTextPos(int index, int start, int end) throws java.io.IOException, AutomationException
setTextPos
in interface IGPFieldInfo2
index
- The index (in)start
- The start (in)end
- The end (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getAliasName(int index) throws java.io.IOException, AutomationException
getAliasName
in interface IGPFieldInfo3
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAliasName(int index, java.lang.String alias) throws java.io.IOException, AutomationException
setAliasName
in interface IGPFieldInfo3
index
- The index (in)alias
- The alias (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone
in interface IClone
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |