Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Interface IDomain

All Superinterfaces:
Serializable
All Known Implementing Classes:
CodedValueDomain, RangeDomain
public interface IDomain
extends Serializable

Provides access to members that return and modify domains and their merge and split policies.

Description

The IDomain interface is used to maintain and access information about a single domain in a single geodatabase workspace. It provides functionality for determining whether a value is a member of this domain and properties for setting attributes about this domain. When creating and assigning a Domain to a particular field, the client is required to set the Name and FieldType properties.

Product Availability

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

Method Summary
 String getDescription()
          The description of the domain.
 int getDomainID()
          The ID of the domain.
 int getFieldType()
          The field type of the field.
 int getMergePolicy()
          The merge policy.
 String getName()
          The name of the domain.
 String getOwner()
          The owner of the domain.
 int getSplitPolicy()
          The split policy.
 int getType()
          The domain type.
 boolean memberOf(Object value)
          Indicates whether the value is a valid member of the domain.
 void setDescription(String description)
          The description of the domain.
 void setDomainID(int iD)
          The ID of the domain.
 void setFieldType(int fieldType)
          The field type of the field.
 void setMergePolicy(int policy)
          The merge policy.
 void setName(String name)
          The name of the domain.
 void setOwner(String owner)
          The owner of the domain.
 void setSplitPolicy(int policy)
          The split policy.
 

Method Detail

getDomainID

int getDomainID()
                throws IOException,
                       AutomationException
The ID of the domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDomainID

void setDomainID(int iD)
                 throws IOException,
                        AutomationException
The ID of the domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
iD - The iD (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException
The description of the domain.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
description - The description (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldType

int getFieldType()
                 throws IOException,
                        AutomationException
The field type of the field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriFieldType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldType

void setFieldType(int fieldType)
                  throws IOException,
                         AutomationException
The field type of the field.

Example:

//Create a new range domain

IRangeDomain pCode = new RangeDomain();

pCode.setMinValue ( "9#");

pCode.setMaxValue ("600000#");

IDomain pDomain = pCode;

pDomain.setName("Area constraint");

pDomain.setFieldType(esriFieldType.esriFieldTypeDouble);

pDomain.setDescription ( "Constrains the area of buildings");

pDomain.setMergePolicy (esriMergePolicyType.esriMPTAreaWeighted);

pDomain.setSplitPolicy (esriSplitPolicyType.esriSPTGeometryRatio);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fieldType - A com.esri.arcgis.geodatabase.esriFieldType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMergePolicy

int getMergePolicy()
                   throws IOException,
                          AutomationException
The merge policy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriMergePolicyType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMergePolicy

void setMergePolicy(int policy)
                    throws IOException,
                           AutomationException
The merge policy.

Example:

//Create a new range domain
IRangeDomain pCode = new RangeDomain();
pCode.setMinValue ( "9#");
pCode.setMaxValue ("600000#");



IDomain pDomain = pCode;
pDomain.setName("Area constraint");
pDomain.setFieldType(esriFieldType.esriFieldTypeDouble);
pDomain.setDescription ( "Constrains the area of buildings");
pDomain.setMergePolicy (esriMergePolicyType.esriMPTAreaWeighted);
pDomain.setSplitPolicy (esriSplitPolicyType.esriSPTGeometryRatio);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
policy - A com.esri.arcgis.geodatabase.esriMergePolicyType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSplitPolicy

int getSplitPolicy()
                   throws IOException,
                          AutomationException
The split policy.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriSplitPolicyType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitPolicy

void setSplitPolicy(int policy)
                    throws IOException,
                           AutomationException
The split policy.

Example:

//Create a new range domain
IRangeDomain pCode = new RangeDomain();
pCode.setMinValue ( "9#");
pCode.setMaxValue ("600000#");



IDomain pDomain = pCode;
pDomain.setName("Area constraint");
pDomain.setFieldType(esriFieldType.esriFieldTypeDouble);
pDomain.setDescription ( "Constrains the area of buildings");
pDomain.setMergePolicy (esriMergePolicyType.esriMPTAreaWeighted);
pDomain.setSplitPolicy (esriSplitPolicyType.esriSPTGeometryRatio);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
policy - A com.esri.arcgis.geodatabase.esriSplitPolicyType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

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

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.

setName

void setName(String name)
             throws IOException,
                    AutomationException
The name of the domain.

Example:

//Create a new range domain
IRangeDomain pCode = new RangeDomain();
pCode.setMinValue ( "9#");
pCode.setMaxValue ("600000#");



IDomain pDomain = pCode;
pDomain.setName("Area constraint");
pDomain.setFieldType(esriFieldType.esriFieldTypeDouble);
pDomain.setDescription ( "Constrains the area of buildings");
pDomain.setMergePolicy (esriMergePolicyType.esriMPTAreaWeighted);
pDomain.setSplitPolicy (esriSplitPolicyType.esriSPTGeometryRatio);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOwner

String getOwner()
                throws IOException,
                       AutomationException
The owner of the domain.

Remarks

This property only applies to domains in ArcSDE geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setOwner

void setOwner(String owner)
              throws IOException,
                     AutomationException
The owner of the domain.

Remarks

This property only applies to domains in ArcSDE geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
owner - The owner (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException
The domain type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriDomainType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

memberOf

boolean memberOf(Object value)
                 throws IOException,
                        AutomationException
Indicates whether the value is a valid member of the domain.

Description

The MemberOf method returns true if the specified value is a member of the domain and false otherwise.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
value - A Variant (in)
Returns:
The isMember
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD