com.esri.arcgis.schematic
Class SchematicExpandLinksByAttributeRule

java.lang.Object
  com.esri.arcgis.schematic.SchematicExpandLinksByAttributeRule

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicExpandLinksByAttributeRule, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, Serializable

public class SchematicExpandLinksByAttributeRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, ISchematicExpandLinksByAttributeRule

Schematic Expand Links By Attribute rule object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicExpandLinksByAttributeRule()
Constructs a SchematicExpandLinksByAttributeRule using ArcGIS Engine.

SchematicExpandLinksByAttributeRule(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicExpandLinksByAttributeRule theSchematicExpandLinksByAttributeRule = (SchematicExpandLinksByAttributeRule) obj;

Method Summary

void	alter(ISchematicDiagramClass schematicDiagramClass, IPropertySet propertySet) Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.
void	apply(ISchematicInMemoryDiagram inMemoryDiagram, ITrackCancel cancelTracker) Applies the schematic rule on the specified schematic in memory diagram.
boolean	canApply(ISchematicBuilder schematicBuiler) Indicates if the rule can apply to the given builder.
void	detach() Detach rule from dataset.
boolean	equals(Object o) Compare this object with another
IUID	getClassID() ClassID of the schematic rule.
static String	getClsid() getClsid.
String	getDescription() Description of the schematic rule.
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	getName() Name of the schematic rule.
IPropertySet	getPropertySet() PropertySet related to the schematic rule.
String	getRangeValuesSeparator() Range values separator character.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic rule.
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.
int	hashCode() the hashcode for this object
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	setPropertySet(IPropertySet rhs1) PropertySet related to the schematic rule.
void	setRangeValuesSeparator(String separator) Range values separator character.
void	setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass) Schematic diagram class related to the schematic builder.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicExpandLinksByAttributeRule

public SchematicExpandLinksByAttributeRule()
                                    throws IOException,
                                           UnknownHostException

Constructs a SchematicExpandLinksByAttributeRule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicExpandLinksByAttributeRule

public SchematicExpandLinksByAttributeRule(Object obj)
                                    throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic rule.

Product Availability

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

Specified by:

getName in interface ISchematicRule

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the schematic rule.

Product Availability

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

Specified by:

getDescription in interface ISchematicRule

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

ClassID of the schematic rule.

Product Availability

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

Specified by:

getClassID in interface ISchematicRule

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.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet related to the schematic rule.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicRule

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException

Schematic diagram class related to the schematic rule.

Product Availability

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

Specified by:

getSchematicDiagramClass in interface ISchematicRule

Specified by:

getSchematicDiagramClass in interface ISchematicRuleDesign

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alter

public void alter(ISchematicDiagramClass schematicDiagramClass,
                  IPropertySet propertySet)
           throws IOException,
                  AutomationException

Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.

Product Availability

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

Specified by:

alter in interface ISchematicRule

Parameters:

schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public void apply(ISchematicInMemoryDiagram inMemoryDiagram,
                  ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException

Applies the schematic rule on the specified schematic in memory diagram.

Product Availability

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

Specified by:

apply in interface ISchematicRule

Parameters:

inMemoryDiagram - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet rhs1)
                    throws IOException,
                           AutomationException

PropertySet related to the schematic rule.

Product Availability

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

Specified by:

setPropertySet in interface ISchematicRuleDesign

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassByRef

public void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
                                   throws IOException,
                                          AutomationException

Schematic diagram class related to the schematic builder.

Product Availability

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

Specified by:

setSchematicDiagramClassByRef in interface ISchematicRuleDesign

Parameters:

schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Detach rule from dataset.

Product Availability

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

Specified by:

detach in interface ISchematicRuleDesign

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(ISchematicBuilder schematicBuiler)
                 throws IOException,
                        AutomationException

Indicates if the rule can apply to the given builder.

Product Availability

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

Specified by:

canApply in interface ISchematicRuleFilter

Parameters:

schematicBuiler - A reference to a com.esri.arcgis.schematic.ISchematicBuilder (in)

Returns:

The apply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

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

Specified by:

setDescription in interface ISchematicExpandLinksByAttributeRule

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

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

Specified by:

getField in interface ISchematicExpandLinksByAttributeRule

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

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

Specified by:

setField in interface ISchematicExpandLinksByAttributeRule

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldFormat

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

Specified by:

getFieldFormat in interface ISchematicExpandLinksByAttributeRule

Returns:

The fieldFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldFormat

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

Specified by:

setFieldFormat in interface ISchematicExpandLinksByAttributeRule

Parameters:

fieldFormat - The fieldFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSetOfCharactersSeparator

public String getSetOfCharactersSeparator()
                                   throws IOException,
                                          AutomationException

List of Characters Separator character.

Product Availability

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

Specified by:

getSetOfCharactersSeparator in interface ISchematicExpandLinksByAttributeRule

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSetOfCharactersSeparator

public void setSetOfCharactersSeparator(String separator)
                                 throws IOException,
                                        AutomationException

List of Characters Separator character.

Product Availability

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

Specified by:

setSetOfCharactersSeparator in interface ISchematicExpandLinksByAttributeRule

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRangeValuesSeparator

public String getRangeValuesSeparator()
                               throws IOException,
                                      AutomationException

Range values separator character.

Product Availability

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

Specified by:

getRangeValuesSeparator in interface ISchematicExpandLinksByAttributeRule

Returns:

The separator

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRangeValuesSeparator

public void setRangeValuesSeparator(String separator)
                             throws IOException,
                                    AutomationException

Range values separator character.

Product Availability

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

Specified by:

setRangeValuesSeparator in interface ISchematicExpandLinksByAttributeRule

Parameters:

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageName

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

Specified by:

getStorageName in interface ISchematicExpandLinksByAttributeRule

Returns:

The storageName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageName

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

Specified by:

setStorageName in interface ISchematicExpandLinksByAttributeRule

Parameters:

storageName - The storageName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteria

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

Specified by:

isExtendedCriteria in interface ISchematicExpandLinksByAttributeRule

Returns:

The extendedCriteria

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteria

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

Specified by:

setExtendedCriteria in interface ISchematicExpandLinksByAttributeRule

Parameters:

extendedCriteria - The extendedCriteria (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

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

Specified by:

getExtendedCriteriaName in interface ISchematicExpandLinksByAttributeRule

Returns:

The extendedCriteriaName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

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

Specified by:

setExtendedCriteriaName in interface ISchematicExpandLinksByAttributeRule

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkElementClassName

public String getLinkElementClassName()
                               throws IOException,
                                      AutomationException

Name of the schematic link class to expand.

Product Availability

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

Specified by:

getLinkElementClassName in interface ISchematicExpandLinksByAttributeRule

Returns:

The linkElementClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinkElementClassName

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

Specified by:

setLinkElementClassName in interface ISchematicExpandLinksByAttributeRule

Parameters:

linkElementClassName - The linkElementClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

Specified by:

getWhereClause in interface ISchematicExpandLinksByAttributeRule

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

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

Specified by:

setWhereClause in interface ISchematicExpandLinksByAttributeRule

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepLinksWithNoValue

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

Specified by:

isKeepLinksWithNoValue in interface ISchematicExpandLinksByAttributeRule

Returns:

The keepLinksWithNoValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepLinksWithNoValue

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

Specified by:

setKeepLinksWithNoValue in interface ISchematicExpandLinksByAttributeRule

Parameters:

keepLinksWithNoValue - The keepLinksWithNoValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCodeName

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

Specified by:

isUseCodeName in interface ISchematicExpandLinksByAttributeRule

Returns:

The useCodeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCodeName

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

Specified by:

setUseCodeName in interface ISchematicExpandLinksByAttributeRule

Parameters:

useCodeName - The useCodeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.