com.esri.arcgis.geoprocessing
Class GPFeatureSchema

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

All Implemented Interfaces:

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

public class GPFeatureSchema
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPSchema, IGPFeatureSchema, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable

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

Description 'Geoprocessing Feature Schema 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.geoprocessing.IGPSchema

IID, IID5e78ce61_0b9f_43e8_84e3_c3f0c9dce34f, xxDummy

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

IID, IIDc05030d4_b950_4c2e_b30e_e25fb4b9ac12, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

GPFeatureSchema()
Constructs a GPFeatureSchema using ArcGIS Engine.

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

Method Summary

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.
IFields	getAdditionalFields() Inidicates additional fields for the fields property.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IEnvelope	getExtent() The extent property.
int	getExtentRule() Inidicates how the extent property is to be managed.
int	getFeatureType() The FeatureType.
int	getFeatureTypeRule() Inidicates how the FeatureType property is to be managed.
int	getFieldsRule() Inidicates how the fields property is to be managed.
int	getGeometryType() The GeometryType.
int	getGeometryTypeRule() Inidicates how the GeometryType property is to be managed.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isCloneDependency() Inidicates if the output value is to be cloned from the input.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isGenerateOutputCatalogPath() Inidicates if the output catalog path is to be generated from the input.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	populateOutputValue(java.lang.String baseName, IGPParameter3 param, IArray params, IGPEnvironmentManager envMgr) Populate the value of the output parameter for validate.
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPFeatureSchema.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAdditionalFieldsByRef(IFields fields) Inidicates additional fields for the fields property.
void	setCloneDependency(boolean cloneDependency) Inidicates if the output value is to be cloned from the input.
void	setExtentByRef(IEnvelope extent) The extent property.
void	setExtentRule(int type) Inidicates how the extent property is to be managed.
void	setFeatureType(int type) The FeatureType.
void	setFeatureTypeRule(int type) Inidicates how the FeatureType property is to be managed.
void	setFieldsRule(int type) Inidicates how the fields property is to be managed.
void	setGenerateOutputCatalogPath(boolean generatePath) Inidicates if the output catalog path is to be generated from the input.
void	setGeometryType(int type) The GeometryType.
void	setGeometryTypeRule(int type) Inidicates how the GeometryType property is to be managed.
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

GPFeatureSchema

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

Constructs a GPFeatureSchema using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPFeatureSchema

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

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

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

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

Specified by:

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

isCloneDependency

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

Inidicates if the output value is to be cloned from the input.

Specified by:

isCloneDependency in interface IGPSchema

Returns:

The cloneDependency

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCloneDependency

public void setCloneDependency(boolean cloneDependency)
                        throws java.io.IOException,
                               AutomationException

Inidicates if the output value is to be cloned from the input.

Specified by:

setCloneDependency in interface IGPSchema

Parameters:

cloneDependency - The cloneDependency (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGenerateOutputCatalogPath

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

Inidicates if the output catalog path is to be generated from the input.

Specified by:

isGenerateOutputCatalogPath in interface IGPSchema

Returns:

The generatePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGenerateOutputCatalogPath

public void setGenerateOutputCatalogPath(boolean generatePath)
                                  throws java.io.IOException,
                                         AutomationException

Inidicates if the output catalog path is to be generated from the input.

Specified by:

setGenerateOutputCatalogPath in interface IGPSchema

Parameters:

generatePath - The generatePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

populateOutputValue

public void populateOutputValue(java.lang.String baseName,
                                IGPParameter3 param,
                                IArray params,
                                IGPEnvironmentManager envMgr)
                         throws java.io.IOException,
                                AutomationException

Populate the value of the output parameter for validate.

Specified by:

populateOutputValue in interface IGPSchema

Parameters:

baseName - The baseName (in)

param - A reference to a com.esri.arcgis.geoprocessing.IGPParameter3 (in)

params - A reference to a com.esri.arcgis.system.IArray (in)

envMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureTypeRule

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

Inidicates how the FeatureType property is to be managed.

Specified by:

getFeatureTypeRule in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geoprocessing.esriGPSchemaFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureTypeRule

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

Inidicates how the FeatureType property is to be managed.

Specified by:

setFeatureTypeRule in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPSchemaFeatureType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureType

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

The FeatureType.

Specified by:

getFeatureType in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureType

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

The FeatureType.

Specified by:

setFeatureType in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryTypeRule

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

Inidicates how the GeometryType property is to be managed.

Specified by:

getGeometryTypeRule in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geoprocessing.esriGPSchemaGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryTypeRule

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

Inidicates how the GeometryType property is to be managed.

Specified by:

setGeometryTypeRule in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPSchemaGeometryType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometryType

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

The GeometryType.

Specified by:

getGeometryType in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryType

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

The GeometryType.

Specified by:

setGeometryType in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldsRule

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

Inidicates how the fields property is to be managed.

Specified by:

getFieldsRule in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geoprocessing.esriGPSchemaFieldsType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldsRule

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

Inidicates how the fields property is to be managed.

Specified by:

setFieldsRule in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPSchemaFieldsType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdditionalFields

public IFields getAdditionalFields()
                            throws java.io.IOException,
                                   AutomationException

Inidicates additional fields for the fields property.

Specified by:

getAdditionalFields in interface IGPFeatureSchema

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAdditionalFieldsByRef

public void setAdditionalFieldsByRef(IFields fields)
                              throws java.io.IOException,
                                     AutomationException

Inidicates additional fields for the fields property.

Specified by:

setAdditionalFieldsByRef in interface IGPFeatureSchema

Parameters:

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtentRule

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

Inidicates how the extent property is to be managed.

Specified by:

getExtentRule in interface IGPFeatureSchema

Returns:

A com.esri.arcgis.geoprocessing.esriGPSchemaExtentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtentRule

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

Inidicates how the extent property is to be managed.

Specified by:

setExtentRule in interface IGPFeatureSchema

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPSchemaExtentType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent property.

Specified by:

getExtent in interface IGPFeatureSchema

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws java.io.IOException,
                           AutomationException

The extent property.

Specified by:

setExtentByRef in interface IGPFeatureSchema

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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