com.esri.arcgis.geodatabase
Interface IGPDataType

All Superinterfaces:
Serializable
All Known Implementing Classes:
DEAddressLocatorType, DEArcInfoTableType, DECadastralFabricType, DECadDrawingDatasetType, DECatalogRootType, DECoverageFeatureClassType, DECoverageType, DEDatasetType, DEDbaseTableType, DEDiskConnectionType, DEFeatureClassType, DEFeatureDatasetType, DEFileType, DEFolderType, DEGeoDataServerType, DEGeoDatasetType, DEGeometricNetworkType, DEGlobeServerType, DEGPServerType, DEImageServerType, DELayerType, DEMapDocumentType, DEMapServerType, DENetworkDatasetType, DEPrjFileType, DERasterBandType, DERasterCatalogType, DERasterDatasetType, DERelationshipClassType, DERemoteDatabaseFolderType, DEShapeFileType, DESpatialReferencesFolderType, DETableType, DETerrainType, DETextFileType, DETinType, DEToolboxType, DEToolType, DETopologyType, DEType, DEVPFCoverageType, DEVPFTableType, DEWCSCoverageType, DEWorkspaceType, FieldType, GPAddressLocatorStyleType, GPAnalysisCellSizeType, GPArcInfoItemType, GPArealUnitType, GPBooleanType, GPCompositeDataType, GPCompositeLayerType, GPCoordinateSystemType, GPDataFileType, GPDateType, GPDoubleType, GPEnvelopeType, GPEvaluationScaleType, GPExtentType, GPFeatureLayerType, GPFeatureRecordSetLayerType, GPFieldInfoType, GPFieldMappingType, GPGALayerType, GPGroupLayerType, GPINFOExpressionType, GPLayerType, GPLinearUnitType, GPLineType, GPLongType, GPMDomainType, GPMultiValueType, GPNAHierarchySettingsType, GPNALayerType, GPNetworkDatasetLayerType, GPPointType, GPPolygonType, GPRandomNumberGeneratorType, GPRasterCatalogLayerType, GPRasterDataLayerType, GPRasterDataType, GPRasterFormulatedType, GPRasterGDBEnvCompressionType, GPRasterGDBEnvPyramidType, GPRasterGDBEnvStatisticsType, GPRasterGDBEnvTileSizeType, GPRasterLayerType, GPRecordSetType, GPRouteMeasureEventPropertiesType, GPSACellSizeType, GPSAGeoDataType, GPSAHorizontalFactorType, GPSAMapAlgebraExpType, GPSANeighborhoodType, GPSANumberRemapType, GPSARadiusType, GPSASemiVariogramType, GPSAStringRemapType, GPSATimeConfigurationType, GPSATopoFeaturesType, GPSAVerticalFactorType, GPSAWeightedOverlayTableType, GPSAWeightedSumType, GPSpatialReferenceType, GPSQLExpressionType, GPStringType, GPTableViewType, GPTerrainLayerType, GPTinLayerType, GPTopologyLayerType, GPType, GPValueTableType, GPVariantType, GPXYDomainType, GPZDomainType, IndexType, NAClassFieldMapType

public interface IGPDataType
extends Serializable

Provides access to members of a GP Data Type.

When To Use

The IGPDataType interface is used to define the data type for each parameter to a geoprocessing tool. Some examples of data types include FeatureClass, Table, and Raster.

The data type is an object used to specify and manage the values passed in as input to a geoprocessing function. For example, in ModelBuilder datatypes are used to determine if a given model variable is valid input to a geoprocessing tool.

Data types are used to provide a way to generate and validate the parameter values. For every data type there is a IGPValue object. IGPValue objects are the actual inputs to a geoprocessing tool.

A complete example of defining the parameter data types is available in the article, IGPValue.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IGPParameter.getName(), IGPParameter, IGPDataType

Method Summary
 IGPValue createValue(String text)
          Creates a geoprocessing value object from the given string.
 IUID getControlCLSID()
          The COM class id of the data type.
 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.
 String getHelpFile()
          The name of the (CHM) file containing help information.
 String getMetadataFile()
          The name of the (XML) file containing the default metadata for this data type.
 String getName()
          The name of the 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.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the data type.

Remarks

The Name property returns the unique name assigned to the DataType object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException
The descriptive, user-friendly name.

Remarks

The DisplayName property returns the descriptive, user-friendly name of the DataType object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getControlCLSID

IUID getControlCLSID()
                     throws IOException,
                            AutomationException
The COM class id of the data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

IName getFullName()
                  throws IOException,
                         AutomationException
The associated Name object.

Remarks

The FullName property returns the full name of the DataType object, which is an IName object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IGPDataType.getFullName()

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException
The name of the (CHM) file containing help information.

Remarks

The HelpFile property returns the string of the help file, which contains the help for the DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The file
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpContext

int getHelpContext()
                   throws IOException,
                          AutomationException
The context identifier of the topic within the help file.

Remarks

The HelpContext property returns the context identifier to the topic inside the HelpFile for this DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The context
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadataFile

String getMetadataFile()
                       throws IOException,
                              AutomationException
The name of the (XML) file containing the default metadata for this data type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The file
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createValue

IGPValue createValue(String text)
                     throws IOException,
                            AutomationException
Creates a geoprocessing value object from the given string.

Remarks

The CreateValue method creates the default Value object, which can subsequently be used in the parameter array that is passed to the Validate and the Execute methods of IGPFunction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
text - The text (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.

validateDataType

IGPMessage validateDataType(IGPDataType type)
                            throws IOException,
                                   AutomationException
Validates if a given geoprocessing data type object is valid.

Remarks

The ValidateDataType method determines if a given DataType object is compatible. The method is used by ModelBuilder to evaluate if a variable can be associated with this DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
type - A reference to a com.esri.arcgis.geodatabase.IGPDataType (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.

validateValue

IGPMessage validateValue(IGPValue value,
                         IGPDomain domain)
                         throws IOException,
                                AutomationException
Validates if a given geoprocessing value object is the correct data type.

Remarks

The ValidateValue method is used to determine if a Value object is compatible with a DataType.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.