com.esri.arcgis.geoprocessing
Class GPEnvironment

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

All Implemented Interfaces:

IGPEnvironment, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

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

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

Description 'Geoprocessing Environment 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.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

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

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

GPEnvironment()
Constructs a GPEnvironment using ArcGIS Engine.

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

Method Summary

void	addDependency(java.lang.String name) Adds the name of an environment that the geoprocessing environment is dependent on.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getCategory() Category of the geoprocessing environment.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IUID	getControlCLSID() Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.
IGPDataType	getDataType() Data type of acceptable values of the geoprocessing environment.
IEnumBSTR	getDependencies() Enumeration of environment names the geoprocessing environment is dependent on.
java.lang.String	getDisplayName() Display name of the geoprocessing environment.
int	getDisplayOrder() Display order of the geoprocessing environment.
IGPDomain	getDomain() Domain of the geoprocessing environment.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMetadataFile() Name of the (XML) file containing the default metadata for this environment object.
java.lang.String	getName() Name of the geoprocessing environment.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IGPValue	getValue() Value of the geoprocessing environment.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPEnvironment.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCategory(java.lang.String category) Category of the geoprocessing environment.
void	setControlCLSID(IUID cLSID) Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.
void	setDataTypeByRef(IGPDataType dataType) Data type of acceptable values of the geoprocessing environment.
void	setDependencies(IEnumBSTR dependencies) Enumeration of environment names the geoprocessing environment is dependent on.
void	setDisplayName(java.lang.String name) Display name of the geoprocessing environment.
void	setDisplayOrder(int displayOrder) Display order of the geoprocessing environment.
void	setDomainByRef(IGPDomain domain) Domain of the geoprocessing environment.
void	setMetadataFile(java.lang.String file) Name of the (XML) file containing the default metadata for this environment object.
void	setName(java.lang.String name) Name of the geoprocessing environment.
void	setValueByRef(IGPValue value) Value of the geoprocessing environment.
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

GPEnvironment

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

Constructs a GPEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPEnvironment

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

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

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

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

Specified by:

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

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.

getName

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

Name of the geoprocessing environment.

Specified by:

getName in interface IGPEnvironment

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

Name of the geoprocessing environment.

Specified by:

setName in interface IGPEnvironment

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

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

Display name of the geoprocessing environment.

Specified by:

getDisplayName in interface IGPEnvironment

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

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

Display name of the geoprocessing environment.

Specified by:

setDisplayName in interface IGPEnvironment

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

Category of the geoprocessing environment.

Specified by:

getCategory in interface IGPEnvironment

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

Category of the geoprocessing environment.

Specified by:

setCategory in interface IGPEnvironment

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public IGPValue getValue()
                  throws java.io.IOException,
                         AutomationException

Value of the geoprocessing environment.

Specified by:

getValue in interface IGPEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValueByRef

public void setValueByRef(IGPValue value)
                   throws java.io.IOException,
                          AutomationException

Value of the geoprocessing environment.

Specified by:

setValueByRef in interface IGPEnvironment

Parameters:

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

public IGPDomain getDomain()
                    throws java.io.IOException,
                           AutomationException

Domain of the geoprocessing environment.

Specified by:

getDomain in interface IGPEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(IGPDomain domain)
                    throws java.io.IOException,
                           AutomationException

Domain of the geoprocessing environment.

Specified by:

setDomainByRef in interface IGPEnvironment

Parameters:

domain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataType

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

Data type of acceptable values of the geoprocessing environment.

Specified by:

getDataType in interface IGPEnvironment

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.

setDataTypeByRef

public void setDataTypeByRef(IGPDataType dataType)
                      throws java.io.IOException,
                             AutomationException

Data type of acceptable values of the geoprocessing environment.

Specified by:

setDataTypeByRef in interface IGPEnvironment

Parameters:

dataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayOrder

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

Display order of the geoprocessing environment.

Specified by:

getDisplayOrder in interface IGPEnvironment

Returns:

The displayOrder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayOrder

public void setDisplayOrder(int displayOrder)
                     throws java.io.IOException,
                            AutomationException

Display order of the geoprocessing environment.

Specified by:

setDisplayOrder in interface IGPEnvironment

Parameters:

displayOrder - The displayOrder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControlCLSID

public IUID getControlCLSID()
                     throws java.io.IOException,
                            AutomationException

Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.

Specified by:

getControlCLSID in interface IGPEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setControlCLSID

public void setControlCLSID(IUID cLSID)
                     throws java.io.IOException,
                            AutomationException

Class identifier (CLSID) of the ActiveX control to use to edit the geoprocessing environment.

Specified by:

setControlCLSID in interface IGPEnvironment

Parameters:

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDependencies

public IEnumBSTR getDependencies()
                          throws java.io.IOException,
                                 AutomationException

Enumeration of environment names the geoprocessing environment is dependent on.

Specified by:

getDependencies in interface IGPEnvironment

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDependencies

public void setDependencies(IEnumBSTR dependencies)
                     throws java.io.IOException,
                            AutomationException

Enumeration of environment names the geoprocessing environment is dependent on.

Specified by:

setDependencies in interface IGPEnvironment

Parameters:

dependencies - A reference to a com.esri.arcgis.system.IEnumBSTR (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDependency

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

Adds the name of an environment that the geoprocessing environment is dependent on.

Specified by:

addDependency in interface IGPEnvironment

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadataFile

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

Name of the (XML) file containing the default metadata for this environment object.

Specified by:

getMetadataFile in interface IGPEnvironment

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadataFile

public void setMetadataFile(java.lang.String file)
                     throws java.io.IOException,
                            AutomationException

Name of the (XML) file containing the default metadata for this environment object.

Specified by:

setMetadataFile in interface IGPEnvironment

Parameters:

file - The file (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

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