com.esri.arcgis.schematic
Interface ISchematicExpandLinksByAttributeRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicExpandLinksByAttributeRule

public interface ISchematicExpandLinksByAttributeRule
extends Serializable

Provides access to members that manage the Expand link by attribute rule.

Description

The Expand Links By Attribute rule allows you to generate schematic diagrams after all links or some particular links implemented by a given schematic element class have been expanded into several links according to specific values. These values may be brought by the original links themselves or by any other attributes brought by other schematic elements contained in the diagram.

Product Availability

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

Method Summary

String	getExtendedCriteriaName() Name of the extended criteria which gives the number of expected links.
String	getField() Field name of the associated feature giving the number of expected expanded links.
int	getFieldFormat() Format of the field giving the number of expected expanded links.
String	getLinkElementClassName() Name of the schematic link class to expand.
String	getRangeValuesSeparator() Range values separator character.
String	getSetOfCharactersSeparator() List of Characters Separator character.
String	getStorageName() Name of the field used to store the decoded value of the expanded link (optional).
String	getWhereClause() Where clause used on associated feature to filter the schematic links expand.
boolean	isExtendedCriteria() Indicates if an extended criteria is used to get the number of expected links.
boolean	isKeepLinksWithNoValue() Indicates if the rule keeps Links which field has no value.
boolean	isUseCodeName() Indicates if the code name (or domain name) should be used to get the number of expected expanded links.
void	setDescription(String rhs1) Description of the Schematic Expand link by attribute rule.
void	setExtendedCriteria(boolean extendedCriteria) Indicates if an extended criteria is used to get the number of expected links.
void	setExtendedCriteriaName(String extendedCriteriaName) Name of the extended criteria which gives the number of expected links.
void	setField(String field) Field name of the associated feature giving the number of expected expanded links.
void	setFieldFormat(int fieldFormat) Format of the field giving the number of expected expanded links.
void	setKeepLinksWithNoValue(boolean keepLinksWithNoValue) Indicates if the rule keeps Links which field has no value.
void	setLinkElementClassName(String linkElementClassName) Name of the schematic link class to expand.
void	setRangeValuesSeparator(String separator) Range values separator character.
void	setSetOfCharactersSeparator(String separator) List of Characters Separator character.
void	setStorageName(String storageName) Name of the field used to store the decoded value of the expanded link (optional).
void	setUseCodeName(boolean useCodeName) Indicates if the code name (or domain name) should be used to get the number of expected expanded links.
void	setWhereClause(String whereClause) Where clause used on associated feature to filter the schematic links expand.

Method Detail

setDescription

void setDescription(String rhs1)
                    throws IOException,
                           AutomationException

Description of the Schematic Expand link by attribute rule.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

String getField()
                throws IOException,
                       AutomationException

Field name of the associated feature giving the number of expected expanded links.

Product Availability

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

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

void setField(String field)
              throws IOException,
                     AutomationException

Field name of the associated feature giving the number of expected expanded links.

Product Availability

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

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldFormat

int getFieldFormat()
                   throws IOException,
                          AutomationException

Format of the field giving the number of expected expanded links.

Product Availability

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

Returns:

The fieldFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldFormat

void setFieldFormat(int fieldFormat)
                    throws IOException,
                           AutomationException

Format of the field giving the number of expected expanded links.

Product Availability

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

Parameters:

fieldFormat - The fieldFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSetOfCharactersSeparator

String getSetOfCharactersSeparator()
                                   throws IOException,
                                          AutomationException

List of Characters Separator character.

Product Availability

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

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSetOfCharactersSeparator

void setSetOfCharactersSeparator(String separator)
                                 throws IOException,
                                        AutomationException

List of Characters Separator character.

Product Availability

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

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRangeValuesSeparator

String getRangeValuesSeparator()
                               throws IOException,
                                      AutomationException

Range values separator character.

Product Availability

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

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRangeValuesSeparator

void setRangeValuesSeparator(String separator)
                             throws IOException,
                                    AutomationException

Range values separator character.

Product Availability

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

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageName

String getStorageName()
                      throws IOException,
                             AutomationException

Name of the field used to store the decoded value of the expanded link (optional).

Product Availability

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

Returns:

The storageName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageName

void setStorageName(String storageName)
                    throws IOException,
                           AutomationException

Name of the field used to store the decoded value of the expanded link (optional).

Product Availability

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

Parameters:

storageName - The storageName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteria

boolean isExtendedCriteria()
                           throws IOException,
                                  AutomationException

Indicates if an extended criteria is used to get the number of expected links. In this case, the property 'Field' is not used.

Product Availability

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

Returns:

The extendedCriteria

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteria

void setExtendedCriteria(boolean extendedCriteria)
                         throws IOException,
                                AutomationException

Indicates if an extended criteria is used to get the number of expected links. In this case, the property 'Field' is not used.

Product Availability

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

Parameters:

extendedCriteria - The extendedCriteria (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

String getExtendedCriteriaName()
                               throws IOException,
                                      AutomationException

Name of the extended criteria which gives the number of expected links.

Product Availability

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

Returns:

The extendedCriteriaName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

void setExtendedCriteriaName(String extendedCriteriaName)
                             throws IOException,
                                    AutomationException

Name of the extended criteria which gives the number of expected links.

Remarks

An extended criteria for the Expand Links By Attribute rule is a component that implements the ISchematicExpandLinksByAttributeExtended interface.

Product Availability

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

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkElementClassName

String getLinkElementClassName()
                               throws IOException,
                                      AutomationException

Name of the schematic link class to expand.

Product Availability

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

Returns:

The linkElementClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinkElementClassName

void setLinkElementClassName(String linkElementClassName)
                             throws IOException,
                                    AutomationException

Name of the schematic link class to expand.

Product Availability

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

Parameters:

linkElementClassName - The linkElementClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException

Where clause used on associated feature to filter the schematic links expand.

Product Availability

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

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

Where clause used on associated feature to filter the schematic links expand.

Product Availability

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

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepLinksWithNoValue

boolean isKeepLinksWithNoValue()
                               throws IOException,
                                      AutomationException

Indicates if the rule keeps Links which field has no value.

Product Availability

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

Returns:

The keepLinksWithNoValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepLinksWithNoValue

void setKeepLinksWithNoValue(boolean keepLinksWithNoValue)
                             throws IOException,
                                    AutomationException

Indicates if the rule keeps Links which field has no value.

Product Availability

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

Parameters:

keepLinksWithNoValue - The keepLinksWithNoValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCodeName

boolean isUseCodeName()
                      throws IOException,
                             AutomationException

Indicates if the code name (or domain name) should be used to get the number of expected expanded links.

Product Availability

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

Returns:

The useCodeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCodeName

void setUseCodeName(boolean useCodeName)
                    throws IOException,
                           AutomationException

Indicates if the code name (or domain name) should be used to get the number of expected expanded links.

Product Availability

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

Parameters:

useCodeName - The useCodeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.