com.esri.arcgis.schematic
Interface ISchematicAttributeManagement

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAttributeManagementProxy

public interface ISchematicAttributeManagement
extends Serializable

Provides access to members that manage the schematic attribute management.

Product Availability

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

Method Summary

int	getEvaluationMode() Evaluation mode of the schematic attribute.
IField	getStorageField() Storage field of the schematic attribute.
int	getStorageMode() Storage mode of the schematic attribute.
String	getStoragePropertyName() Storage property name of the schematic attribute.
boolean	isPredefined() Indicates whether or not the schematic attribute is predefined.
void	setEvaluationMode(int evaluationMode) Evaluation mode of the schematic attribute.
void	setStorageField(IField field) Storage field of the schematic attribute.
void	setStorageMode(int storageMode) Storage mode of the schematic attribute.
void	setStoragePropertyName(String propertyName) Storage property name of the schematic attribute.

Method Detail

isPredefined

boolean isPredefined()
                     throws IOException,
                            AutomationException

Indicates whether or not the schematic attribute is predefined.

Product Availability

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

Returns:

The isPredefined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageMode

void setStorageMode(int storageMode)
                    throws IOException,
                           AutomationException

Storage mode of the schematic attribute.

Description

The StorageMode defines whether the schematic attribute values must be stored in a field or a property set in the schematic dataset, or not stored.

Remarks

For a schematic attribute whose name corresponds to a predefined attribute name, storage cannot be configured. Storage of those specific attributes is entirely managed by Schematics without any configuration. In most cases, it is based on a system field in the related schematic feature class or diagram class.

Product Availability

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

Parameters:

storageMode - A com.esri.arcgis.schematic.esriSchematicAttributeStorageMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageMode

int getStorageMode()
                   throws IOException,
                          AutomationException

Storage mode of the schematic attribute.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicAttributeStorageMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEvaluationMode

void setEvaluationMode(int evaluationMode)
                       throws IOException,
                              AutomationException

Evaluation mode of the schematic attribute.

Description

The EvaluationMode determines when the schematic attribute values have to be reevaluated.

Product Availability

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

Parameters:

evaluationMode - A com.esri.arcgis.schematic.esriSchematicAttributeEvaluationMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEvaluationMode

int getEvaluationMode()
                      throws IOException,
                             AutomationException

Evaluation mode of the schematic attribute.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicAttributeEvaluationMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageField

IField getStorageField()
                       throws IOException,
                              AutomationException

Storage field of the schematic attribute.

Description

An attribute Property is an attribute whose values are managed by a custom schematic rule, a custom schematic algorithm, or any applicative component. For example, the predefined Expand Links schematic rule may be configured to work with such a type of attribute.

The attribute values are stored in a property set property in the schematic feature class or diagram class on which the schematic attribute applies.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageField

void setStorageField(IField field)
                     throws IOException,
                            AutomationException

Storage field of the schematic attribute.

Product Availability

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

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStoragePropertyName

String getStoragePropertyName()
                              throws IOException,
                                     AutomationException

Storage property name of the schematic attribute.

Product Availability

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

Returns:

The propertyName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStoragePropertyName

void setStoragePropertyName(String propertyName)
                            throws IOException,
                                   AutomationException

Storage property name of the schematic attribute.

Product Availability

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

Parameters:

propertyName - The propertyName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.