com.esri.arcgis.geoprocessing
Class GPCompositeDataType

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

All Implemented Interfaces:

IGPDataType, IGxFilterInfo, IGPCompositeDataType, com.esri.arcgis.interop.RemoteObjRef, IClone, java.io.Serializable

public class GPCompositeDataType
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPDataType, IGPCompositeDataType, IGxFilterInfo, IClone

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

Description 'Geoprocessing Composite Data Type.' 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

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

IID, IID172a93a9_afc1_432d_8f04_54b7309ba432, xxDummy

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

IID, IID161ba20a_15b0_4af8_aa30_67653eebe69e, xxDummy

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

IID, IID691be63c_024f_4958_8f9b_d8252342e915, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

GPCompositeDataType()
Constructs a GPCompositeDataType using ArcGIS Engine.

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

Method Summary

void	addDataType(IGPDataType pType) Adds the given data type to the list of acceptable data types in the composite data type.
void	assign(IClone src) Assigns the properties of src to the receiver.
IGPValue	createValue(java.lang.String text) Creates a geoprocessing value object from the given string.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
static java.lang.String	getClsid() getClsid.
IUID	getControlCLSID() The COM class id of the data type.
int	getCount() The number of acceptable data types the composite data type will accept.
IGPDataType	getDataType(int index) The data type object at the given index.
java.lang.String	getDisplayName() The descriptive, user-friendly name.
IName	getFullName() The associated Name object.
int	getHelpContext() The context identifier of the topic within the help file.
java.lang.String	getHelpFile() The name of the (CHM) file containing help information.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMetadataFile() The name of the (XML) file containing the default metadata for this data type.
java.lang.String	getName() The name of the data type.
IArray	getOpenGxObjectFilters() The filters used to open a dataset of this type.
IArray	getSaveGxObjectFilters() The filters used to save a dataset of this type.
int	hashCode() the hashcode for this object
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	release() Release a GPCompositeDataType.
void	removeDataType(int index) Removes the given data type from the list of acceptable data types in the composite data type.
IGPMessage	validateDataType(IGPDataType type) Validates if a given geoprocessing data type object is valid.
IGPMessage	validateValue(IGPValue value, IGPDomain domain) Validates if a given geoprocessing value object is the correct data type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPCompositeDataType

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

Constructs a GPCompositeDataType using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPCompositeDataType

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

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

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

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

Specified by:

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

getName

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

The name of the data type.

Specified by:

getName in interface IGPDataType

Returns:

The name

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

The descriptive, user-friendly name.

Specified by:

getDisplayName in interface IGPDataType

Returns:

The name

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

The COM class id of the data type.

Specified by:

getControlCLSID in interface IGPDataType

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.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated Name object.

Specified by:

getFullName in interface IGPDataType

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

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

The name of the (CHM) file containing help information.

Specified by:

getHelpFile in interface IGPDataType

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContext

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

The context identifier of the topic within the help file.

Specified by:

getHelpContext in interface IGPDataType

Returns:

The context

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

The name of the (XML) file containing the default metadata for this data type.

Specified by:

getMetadataFile in interface IGPDataType

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createValue

public IGPValue createValue(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Creates a geoprocessing value object from the given string.

Specified by:

createValue in interface IGPDataType

Parameters:

text - The text (in)

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.

validateDataType

public IGPMessage validateDataType(IGPDataType type)
                            throws java.io.IOException,
                                   AutomationException

Validates if a given geoprocessing data type object is valid.

Specified by:

validateDataType in interface IGPDataType

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateValue

public IGPMessage validateValue(IGPValue value,
                                IGPDomain domain)
                         throws java.io.IOException,
                                AutomationException

Validates if a given geoprocessing value object is the correct data type.

Specified by:

validateValue in interface IGPDataType

Parameters:

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

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of acceptable data types the composite data type will accept.

Specified by:

getCount in interface IGPCompositeDataType

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataType

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

The data type object at the given index.

Specified by:

getDataType in interface IGPCompositeDataType

Parameters:

index - The index (in)

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.

addDataType

public void addDataType(IGPDataType pType)
                 throws java.io.IOException,
                        AutomationException

Adds the given data type to the list of acceptable data types in the composite data type.

Specified by:

addDataType in interface IGPCompositeDataType

Parameters:

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

removeDataType

public void removeDataType(int index)
                    throws java.io.IOException,
                           AutomationException

Removes the given data type from the list of acceptable data types in the composite data type.

Specified by:

removeDataType in interface IGPCompositeDataType

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOpenGxObjectFilters

public IArray getOpenGxObjectFilters()
                              throws java.io.IOException,
                                     AutomationException

The filters used to open a dataset of this type.

Specified by:

getOpenGxObjectFilters in interface IGxFilterInfo

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSaveGxObjectFilters

public IArray getSaveGxObjectFilters()
                              throws java.io.IOException,
                                     AutomationException

The filters used to save a dataset of this type.

Specified by:

getSaveGxObjectFilters in interface IGxFilterInfo

Returns:

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

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.