com.esri.arcgis.geoprocessing
Class MdVariable

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.MdVariable
All Implemented Interfaces:
IGPValue, IGPVariable, IGPValueExpression, IMdElement, IMdList, IMdVariable, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class MdVariable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IMdElement, IMdVariable, IGPVariable, IGPValue, IPersistStream, IXMLSerialize, IMdList, IGPValueExpression, Externalizable

Model variable object that contains a value object.

Product Availability

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

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
MdVariable()
          Constructs a MdVariable using ArcGIS Engine.
MdVariable(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdVariable theMdVariable = (MdVariable) obj;
 
Method Summary
 void addValue(IGPValue pValue)
          Adds a value.
 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(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getAlteredFlag(int index)
          Indicates whether the value has been explicitly set (by the user).
 String getAsText()
          Provides the value of the value object.
 String getAsText(IGPVariableManager pVariableManager)
          Gets the text value of the variable value.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          The list count.
 int getCurrentIndex()
          The current index.
 IGPDataType getDataType()
          The data type of the variable.
 IEnumMdElement getDependents(int direction, int connectionType)
          Returns an enumeration of model elements that are dependent on the model element in the given direction and of the given connection type.
 IMdVariable getFeedbackVariable()
          Feedback variable.
 int getID()
          Unique identifier of the model element.
 int getListType()
          Indicates the list type.
 IGPMessages getMessages()
          Returns the messages returned from the last call to Validate().
 IMdModel getModel()
          The model the model element is contained within.
 String getName()
          Name of the model element.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getState()
          The state of the model element.
 int getValence()
          Get valence.
 IGPValue getValue()
          The value object associated with the variable.
 IGPValue getValue(int index)
          The value at the specifed index.
 void getValues(boolean bClone, IArray[] ppValues, ILongArray[] ppFlags)
          The values.
 IStringArray getVariableNames()
          Returns a string array of the variable names.
 IArray getVariables()
          Returns an array of variables.
 int hashCode()
          the hashcode for this object
 void insertValue(int index, IGPValue pValue)
          Inserts a value.
 boolean isAddToDisplay()
          Indicates if the variable should be added to the application display.
 boolean isAltered()
          Indicates if the model element has been altered by the user.
 boolean isAlteredFlag()
          Indicates whether the value has been explicitly set (by the user).
 boolean isCurrent()
          Indicates if the model element is current (i.e., has been created).
 boolean isDependentOn(IMdElement pMdElement, int direction, int connectionType)
          Returns whether or not the model element is dependent on the given model element in the given direction of the given connection type.
 boolean isDerived()
          Indicates if the variable is type derived.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isIntermediate()
          Indicates if the data specified by the variable is considered intermediate data.
 boolean isMarked()
          Indicates if the model element has been marked for validation/execution.
 boolean isResolved()
          Gets the resolved state.
 boolean isValid()
          Indicates if the model element is valid.
 void load(IStream pstm)
          load
 void moveValue(int index, int direction)
          Moves the specified value.
 void readExternal(ObjectInput in)
           
 void removeAll()
          Removes all values.
 void removeValue(int index)
          Removes the specified value.
 IGPValue resolveValue(IGPVariableManager pVariableManager)
          Resolves a given variable value.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAddToDisplay(boolean addToDisplay)
          Indicates if the variable should be added to the application display.
 void setAltered(boolean altered)
          Indicates if the model element has been altered by the user.
 void setAlteredFlag(boolean altered)
          Indicates whether the value has been explicitly set (by the user).
 void setAlteredFlag2(int index, int flag)
          Indicates whether the value has been explicitly set (by the user).
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 void setCurrent(boolean current)
          Indicates if the model element is current (i.e., has been created).
 void setCurrentIndex(int index)
          The current index.
 void setDataTypeByRef(IGPDataType dataType)
          The data type of the variable.
 void setDerived(boolean derived)
          Indicates if the variable is type derived.
 void setFeedbackVariableByRef(IMdVariable ppVariable)
          Feedback variable.
 void setID(int identifier)
          Unique identifier of the model element.
 void setIntermediate(boolean intermediate)
          Indicates if the data specified by the variable is considered intermediate data.
 void setListType(int type)
          Indicates the list type.
 void setMarked(boolean marked)
          Indicates if the model element has been marked for validation/execution.
 void setModelByRef(IMdModel model)
          The model the model element is contained within.
 void setName(String name)
          Name of the model element.
 void setResolved(boolean pResolved)
          Gets the resolved state.
 void setValence(int valence)
          Set valence.
 void setValid(boolean valid)
          Indicates if the model element is valid.
 void setValueByRef(IGPValue value)
          The value object associated with the variable.
 void setValueByRef(int index, IGPValue ppValue)
          The value at the specifed index.
 void setValues(IArray pValues, ILongArray pFlags)
          The values.
 void setVariablesByRef(IArray ppVariables)
          Returns an array of variables.
 IGPMessages validate(boolean updateValues, IGPEnvironmentManager pEnvMgr)
          Validates the model element.
 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

MdVariable

public MdVariable()
           throws IOException,
                  UnknownHostException
Constructs a MdVariable using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MdVariable

public MdVariable(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MdVariable theMdVariable = (MdVariable) obj;

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

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

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
Returns TRUE when 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
Returns TRUE when 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.

getID

public int getID()
          throws IOException,
                 AutomationException
Unique identifier of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
getID in interface IMdElement
Returns:
The identifier
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setID

public void setID(int identifier)
           throws IOException,
                  AutomationException
Unique identifier of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
setID in interface IMdElement
Parameters:
identifier - The identifier (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
getName in interface IGPVariable
Specified by:
getName in interface IMdElement
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
Name of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
setName in interface IGPVariable
Specified by:
setName in interface IMdElement
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMarked

public boolean isMarked()
                 throws IOException,
                        AutomationException
Indicates if the model element has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

Specified by:
isMarked in interface IMdElement
Returns:
The marked
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarked

public void setMarked(boolean marked)
               throws IOException,
                      AutomationException
Indicates if the model element has been marked for validation/execution.

Product Availability

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

Supported Platforms

Windows

Specified by:
setMarked in interface IMdElement
Parameters:
marked - The marked (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCurrent

public boolean isCurrent()
                  throws IOException,
                         AutomationException
Indicates if the model element is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

Specified by:
isCurrent in interface IMdElement
Returns:
The current
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrent

public void setCurrent(boolean current)
                throws IOException,
                       AutomationException
Indicates if the model element is current (i.e., has been created).

Product Availability

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

Supported Platforms

Windows

Specified by:
setCurrent in interface IMdElement
Parameters:
current - The current (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the model element is valid.

Product Availability

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

Supported Platforms

Windows

Specified by:
isValid in interface IMdElement
Returns:
The valid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValid

public void setValid(boolean valid)
              throws IOException,
                     AutomationException
Indicates if the model element is valid.

Product Availability

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

Supported Platforms

Windows

Specified by:
setValid in interface IMdElement
Parameters:
valid - The valid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getModel

public IMdModel getModel()
                  throws IOException,
                         AutomationException
The model the model element is contained within.

Product Availability

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

Supported Platforms

Windows

Specified by:
getModel in interface IMdElement
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setModelByRef

public void setModelByRef(IMdModel model)
                   throws IOException,
                          AutomationException
The model the model element is contained within.

Product Availability

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

Specified by:
setModelByRef in interface IMdElement
Parameters:
model - A reference to a com.esri.arcgis.geoprocessing.IMdModel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws IOException,
                    AutomationException
The state of the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
getState in interface IMdElement
Returns:
A com.esri.arcgis.geoprocessing.esriMdElementState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDependents

public IEnumMdElement getDependents(int direction,
                                    int connectionType)
                             throws IOException,
                                    AutomationException
Returns an enumeration of model elements that are dependent on the model element in the given direction and of the given connection type.

Product Availability

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

Supported Platforms

Windows

Specified by:
getDependents in interface IMdElement
Parameters:
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDependentOn

public boolean isDependentOn(IMdElement pMdElement,
                             int direction,
                             int connectionType)
                      throws IOException,
                             AutomationException
Returns whether or not the model element is dependent on the given model element in the given direction of the given connection type.

Product Availability

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

Supported Platforms

Windows

Specified by:
isDependentOn in interface IMdElement
Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Returns:
The pDependentOn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validate

public IGPMessages validate(boolean updateValues,
                            IGPEnvironmentManager pEnvMgr)
                     throws IOException,
                            AutomationException
Validates the model element.

Product Availability

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

Supported Platforms

Windows

Specified by:
validate in interface IMdElement
Parameters:
updateValues - The updateValues (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessages

public IGPMessages getMessages()
                        throws IOException,
                               AutomationException
Returns the messages returned from the last call to Validate().

Product Availability

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

Supported Platforms

Windows

Specified by:
getMessages in interface IMdElement
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAltered

public boolean isAltered()
                  throws IOException,
                         AutomationException
Indicates if the model element has been altered by the user.

Product Availability

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

Supported Platforms

Windows

Specified by:
isAltered in interface IMdElement
Returns:
The altered
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAltered

public void setAltered(boolean altered)
                throws IOException,
                       AutomationException
Indicates if the model element has been altered by the user.

Product Availability

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

Supported Platforms

Windows

Specified by:
setAltered in interface IMdElement
Parameters:
altered - The altered (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddToDisplay

public boolean isAddToDisplay()
                       throws IOException,
                              AutomationException
Indicates if the variable should be added to the application display.

Product Availability

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

Supported Platforms

Windows

Specified by:
isAddToDisplay in interface IMdVariable
Returns:
The addToDisplay
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddToDisplay

public void setAddToDisplay(boolean addToDisplay)
                     throws IOException,
                            AutomationException
Indicates if the variable should be added to the application display.

Product Availability

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

Supported Platforms

Windows

Specified by:
setAddToDisplay in interface IMdVariable
Parameters:
addToDisplay - The addToDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIntermediate

public boolean isIntermediate()
                       throws IOException,
                              AutomationException
Indicates if the data specified by the variable is considered intermediate data.

Product Availability

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

Supported Platforms

Windows

Specified by:
isIntermediate in interface IMdVariable
Returns:
The intermediate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIntermediate

public void setIntermediate(boolean intermediate)
                     throws IOException,
                            AutomationException
Indicates if the data specified by the variable is considered intermediate data.

Product Availability

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

Supported Platforms

Windows

Specified by:
setIntermediate in interface IMdVariable
Parameters:
intermediate - The intermediate (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue()
                  throws IOException,
                         AutomationException
The value object associated with the variable.

Product Availability

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

Specified by:
getValue in interface IGPVariable
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueByRef

public void setValueByRef(IGPValue value)
                   throws IOException,
                          AutomationException
The value object associated with the variable.

Product Availability

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

Specified by:
setValueByRef in interface IGPVariable
Parameters:
value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataType

public IGPDataType getDataType()
                        throws IOException,
                               AutomationException
The data type of the variable.

Product Availability

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

Specified by:
getDataType in interface IGPValue
Specified by:
getDataType in interface IGPVariable
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataTypeByRef

public void setDataTypeByRef(IGPDataType dataType)
                      throws IOException,
                             AutomationException
The data type of the variable.

Product Availability

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

Specified by:
setDataTypeByRef in interface IGPVariable
Parameters:
dataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDerived

public boolean isDerived()
                  throws IOException,
                         AutomationException
Indicates if the variable is type derived.

Product Availability

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

Specified by:
isDerived in interface IGPVariable
Returns:
The derived
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDerived

public void setDerived(boolean derived)
                throws IOException,
                       AutomationException
Indicates if the variable is type derived.

Product Availability

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

Specified by:
setDerived in interface IGPVariable
Parameters:
derived - The derived (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:
isEmpty in interface IGPValue
Returns:
The isEmpty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException
Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:
empty in interface IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException
Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:
getAsText in interface IGPValue
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
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.

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.

getListType

public int getListType()
                throws IOException,
                       AutomationException
Indicates the list type.

Product Availability

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

Specified by:
getListType in interface IMdList
Returns:
A com.esri.arcgis.geoprocessing.esriMdListType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setListType

public void setListType(int type)
                 throws IOException,
                        AutomationException
Indicates the list type.

Product Availability

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

Specified by:
setListType in interface IMdList
Parameters:
type - A com.esri.arcgis.geoprocessing.esriMdListType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentIndex

public int getCurrentIndex()
                    throws IOException,
                           AutomationException
The current index.

Product Availability

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

Specified by:
getCurrentIndex in interface IMdList
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentIndex

public void setCurrentIndex(int index)
                     throws IOException,
                            AutomationException
The current index.

Product Availability

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

Specified by:
setCurrentIndex in interface IMdList
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The list count.

Product Availability

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

Specified by:
getCount in interface IMdList
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue(int index)
                  throws IOException,
                         AutomationException
The value at the specifed index.

Product Availability

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

Specified by:
getValue in interface IMdList
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValueByRef

public void setValueByRef(int index,
                          IGPValue ppValue)
                   throws IOException,
                          AutomationException
The value at the specifed index.

Product Availability

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

Specified by:
setValueByRef in interface IMdList
Parameters:
index - The index (in)
ppValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addValue

public void addValue(IGPValue pValue)
              throws IOException,
                     AutomationException
Adds a value.

Product Availability

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

Specified by:
addValue in interface IMdList
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertValue

public void insertValue(int index,
                        IGPValue pValue)
                 throws IOException,
                        AutomationException
Inserts a value.

Product Availability

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

Specified by:
insertValue in interface IMdList
Parameters:
index - The index (in)
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveValue

public void moveValue(int index,
                      int direction)
               throws IOException,
                      AutomationException
Moves the specified value.

Product Availability

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

Specified by:
moveValue in interface IMdList
Parameters:
index - The index (in)
direction - The direction (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeValue

public void removeValue(int index)
                 throws IOException,
                        AutomationException
Removes the specified value.

Product Availability

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

Specified by:
removeValue in interface IMdList
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all values.

Product Availability

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

Specified by:
removeAll in interface IMdList
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValues

public void getValues(boolean bClone,
                      IArray[] ppValues,
                      ILongArray[] ppFlags)
               throws IOException,
                      AutomationException
The values.

Product Availability

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

Specified by:
getValues in interface IMdList
Parameters:
bClone - The bClone (in)
ppValues - A reference to a com.esri.arcgis.system.IArray (out: use single element array)
ppFlags - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValues

public void setValues(IArray pValues,
                      ILongArray pFlags)
               throws IOException,
                      AutomationException
The values.

Product Availability

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

Specified by:
setValues in interface IMdList
Parameters:
pValues - A reference to a com.esri.arcgis.system.IArray (in)
pFlags - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeedbackVariable

public IMdVariable getFeedbackVariable()
                                throws IOException,
                                       AutomationException
Feedback variable.

Product Availability

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

Specified by:
getFeedbackVariable in interface IMdList
Returns:
A reference to a com.esri.arcgis.geoprocessing.IMdVariable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeedbackVariableByRef

public void setFeedbackVariableByRef(IMdVariable ppVariable)
                              throws IOException,
                                     AutomationException
Feedback variable.

Product Availability

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

Specified by:
setFeedbackVariableByRef in interface IMdList
Parameters:
ppVariable - A reference to a com.esri.arcgis.geoprocessing.IMdVariable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValence

public int getValence()
               throws IOException,
                      AutomationException
Get valence.

Product Availability

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

Specified by:
getValence in interface IMdList
Returns:
The valence
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValence

public void setValence(int valence)
                throws IOException,
                       AutomationException
Set valence.

Product Availability

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

Specified by:
setValence in interface IMdList
Parameters:
valence - The valence (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAlteredFlag

public boolean isAlteredFlag()
                      throws IOException,
                             AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

Specified by:
isAlteredFlag in interface IMdList
Returns:
The altered
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlteredFlag

public void setAlteredFlag(boolean altered)
                    throws IOException,
                           AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

Specified by:
setAlteredFlag in interface IMdList
Parameters:
altered - The altered (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlteredFlag

public int getAlteredFlag(int index)
                   throws IOException,
                          AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

Specified by:
getAlteredFlag in interface IMdList
Parameters:
index - The index (in)
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAlteredFlag2

public void setAlteredFlag2(int index,
                            int flag)
                     throws IOException,
                            AutomationException
Indicates whether the value has been explicitly set (by the user).

Product Availability

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

Specified by:
setAlteredFlag2 in interface IMdList
Parameters:
index - The index (in)
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isResolved

public boolean isResolved()
                   throws IOException,
                          AutomationException
Gets the resolved state.

Product Availability

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

Specified by:
isResolved in interface IGPValueExpression
Returns:
The pResolved
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResolved

public void setResolved(boolean pResolved)
                 throws IOException,
                        AutomationException
Gets the resolved state.

Product Availability

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

Specified by:
setResolved in interface IGPValueExpression
Parameters:
pResolved - The pResolved (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resolveValue

public IGPValue resolveValue(IGPVariableManager pVariableManager)
                      throws IOException,
                             AutomationException
Resolves a given variable value.

Product Availability

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

Specified by:
resolveValue in interface IGPValueExpression
Parameters:
pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVariableNames

public IStringArray getVariableNames()
                              throws IOException,
                                     AutomationException
Returns a string array of the variable names.

Product Availability

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

Specified by:
getVariableNames in interface IGPValueExpression
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVariables

public IArray getVariables()
                    throws IOException,
                           AutomationException
Returns an array of variables.

Product Availability

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

Specified by:
getVariables in interface IGPValueExpression
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVariablesByRef

public void setVariablesByRef(IArray ppVariables)
                       throws IOException,
                              AutomationException
Returns an array of variables.

Product Availability

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

Specified by:
setVariablesByRef in interface IGPValueExpression
Parameters:
ppVariables - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText(IGPVariableManager pVariableManager)
                 throws IOException,
                        AutomationException
Gets the text value of the variable value.

Product Availability

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

Specified by:
getAsText in interface IGPValueExpression
Parameters:
pVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)
Returns:
The pText
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