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, java.io.Serializable

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

COM Class 'SchematicExpandLinksByAttributeRule'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description 'Schematic Expand Links By Attribute rule object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.schematic.ISchematicRule

IID, IID0f611689_2c12_4e4d_80b9_cca2b3d5c7f4, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicRuleDesign

IID, IIDf11386df_d11d_4b5b_8d80_05cd6fb7d2e5, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicRuleFilter

IID, IID3baea23d_9486_4680_810d_c54ea50ea610, xxDummy

Fields inherited from interface com.esri.arcgis.schematic.ISchematicExpandLinksByAttributeRule

IID, IID460616a4_1363_4737_98b7_c476e4f8acca, xxDummy

Constructor Summary

SchematicExpandLinksByAttributeRule()
Constructs a SchematicExpandLinksByAttributeRule using ArcGIS Engine.

SchematicExpandLinksByAttributeRule(java.lang.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(java.lang.Object o) Compare this object with another
IUID	getClassID() ClassID of the schematic rule.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() Description of the schematic rule.
java.lang.String	getExtendedCriteriaName() Name of the extended criteria which gives the number of expected links.
java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLinkElementClassName() Name of the schematic link class to expand.
java.lang.String	getName() Name of the schematic rule.
IPropertySet	getPropertySet() PropertySet related to the schematic rule.
java.lang.String	getRangeValuesSeparator() Range values separator character.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic rule.
java.lang.String	getSetOfCharactersSeparator() List of Characters Separator character.
java.lang.String	getStorageName() Name of the field used to store the decoded value of the expanded link (optional).
java.lang.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	release() Release a SchematicExpandLinksByAttributeRule.
void	setDescription(java.lang.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(java.lang.String extendedCriteriaName) Name of the extended criteria which gives the number of expected links.
void	setField(java.lang.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(java.lang.String linkElementClassName) Name of the schematic link class to expand.
void	setPropertySet(IPropertySet rhs1) PropertySet related to the schematic rule.
void	setRangeValuesSeparator(java.lang.String separator) Range values separator character.
void	setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass) Schematic diagram class related to the schematic builder.
void	setSetOfCharactersSeparator(java.lang.String separator) List of Characters Separator character.
void	setStorageName(java.lang.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(java.lang.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

Constructor Detail

SchematicExpandLinksByAttributeRule

public SchematicExpandLinksByAttributeRule()
                                    throws java.io.IOException,
                                           java.net.UnknownHostException

Constructs a SchematicExpandLinksByAttributeRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SchematicExpandLinksByAttributeRule

public SchematicExpandLinksByAttributeRule(java.lang.Object obj)
                                    throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SchematicExpandLinksByAttributeRule.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the schematic rule.

Specified by:

getName in interface ISchematicRule

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the schematic rule.

Specified by:

getDescription in interface ISchematicRule

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

ClassID of the schematic rule.

Specified by:

getClassID in interface ISchematicRule

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

PropertySet related to the schematic rule.

Specified by:

getPropertySet in interface ISchematicRule

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws java.io.IOException,
                                                       AutomationException

Schematic diagram class related to the schematic rule.

Specified by:

getSchematicDiagramClass in interface ISchematicRule

Specified by:

getSchematicDiagramClass in interface ISchematicRuleDesign

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alter

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet rhs1)
                    throws java.io.IOException,
                           AutomationException

PropertySet related to the schematic rule.

Specified by:

setPropertySet in interface ISchematicRuleDesign

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassByRef

public void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
                                   throws java.io.IOException,
                                          AutomationException

Schematic diagram class related to the schematic builder.

Specified by:

setSchematicDiagramClassByRef in interface ISchematicRuleDesign

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException

Detach rule from dataset.

Specified by:

detach in interface ISchematicRuleDesign

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(ISchematicBuilder schematicBuiler)
                 throws java.io.IOException,
                        AutomationException

Indicates if the rule can apply to the given builder.

Specified by:

canApply in interface ISchematicRuleFilter

Parameters:

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

Returns:

The apply

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

Description of the Schematic Expand link by attribute rule.

Specified by:

setDescription in interface ISchematicExpandLinksByAttributeRule

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public java.lang.String getField()
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:

getField in interface ISchematicExpandLinksByAttributeRule

Returns:

The field

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(java.lang.String field)
              throws java.io.IOException,
                     AutomationException

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

Specified by:

setField in interface ISchematicExpandLinksByAttributeRule

Parameters:

field - The field (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldFormat

public int getFieldFormat()
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

getFieldFormat in interface ISchematicExpandLinksByAttributeRule

Returns:

The fieldFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldFormat

public void setFieldFormat(int fieldFormat)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setFieldFormat in interface ISchematicExpandLinksByAttributeRule

Parameters:

fieldFormat - The fieldFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSetOfCharactersSeparator

public java.lang.String getSetOfCharactersSeparator()
                                             throws java.io.IOException,
                                                    AutomationException

List of Characters Separator character.

Specified by:

getSetOfCharactersSeparator in interface ISchematicExpandLinksByAttributeRule

Returns:

The separator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSetOfCharactersSeparator

public void setSetOfCharactersSeparator(java.lang.String separator)
                                 throws java.io.IOException,
                                        AutomationException

List of Characters Separator character.

Specified by:

setSetOfCharactersSeparator in interface ISchematicExpandLinksByAttributeRule

Parameters:

separator - The separator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRangeValuesSeparator

public java.lang.String getRangeValuesSeparator()
                                         throws java.io.IOException,
                                                AutomationException

Range values separator character.

Specified by:

getRangeValuesSeparator in interface ISchematicExpandLinksByAttributeRule

Returns:

The separator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRangeValuesSeparator

public void setRangeValuesSeparator(java.lang.String separator)
                             throws java.io.IOException,
                                    AutomationException

Range values separator character.

Specified by:

setRangeValuesSeparator in interface ISchematicExpandLinksByAttributeRule

Parameters:

separator - The separator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStorageName

public java.lang.String getStorageName()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getStorageName in interface ISchematicExpandLinksByAttributeRule

Returns:

The storageName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStorageName

public void setStorageName(java.lang.String storageName)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setStorageName in interface ISchematicExpandLinksByAttributeRule

Parameters:

storageName - The storageName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteria

public boolean isExtendedCriteria()
                           throws java.io.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.

Specified by:

isExtendedCriteria in interface ISchematicExpandLinksByAttributeRule

Returns:

The extendedCriteria

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteria

public void setExtendedCriteria(boolean extendedCriteria)
                         throws java.io.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.

Specified by:

setExtendedCriteria in interface ISchematicExpandLinksByAttributeRule

Parameters:

extendedCriteria - The extendedCriteria (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

public java.lang.String getExtendedCriteriaName()
                                         throws java.io.IOException,
                                                AutomationException

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

Specified by:

getExtendedCriteriaName in interface ISchematicExpandLinksByAttributeRule

Returns:

The extendedCriteriaName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

public void setExtendedCriteriaName(java.lang.String extendedCriteriaName)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setExtendedCriteriaName in interface ISchematicExpandLinksByAttributeRule

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinkElementClassName

public java.lang.String getLinkElementClassName()
                                         throws java.io.IOException,
                                                AutomationException

Name of the schematic link class to expand.

Specified by:

getLinkElementClassName in interface ISchematicExpandLinksByAttributeRule

Returns:

The linkElementClassName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinkElementClassName

public void setLinkElementClassName(java.lang.String linkElementClassName)
                             throws java.io.IOException,
                                    AutomationException

Name of the schematic link class to expand.

Specified by:

setLinkElementClassName in interface ISchematicExpandLinksByAttributeRule

Parameters:

linkElementClassName - The linkElementClassName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getWhereClause in interface ISchematicExpandLinksByAttributeRule

Returns:

The whereClause

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setWhereClause in interface ISchematicExpandLinksByAttributeRule

Parameters:

whereClause - The whereClause (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepLinksWithNoValue

public boolean isKeepLinksWithNoValue()
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

isKeepLinksWithNoValue in interface ISchematicExpandLinksByAttributeRule

Returns:

The keepLinksWithNoValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepLinksWithNoValue

public void setKeepLinksWithNoValue(boolean keepLinksWithNoValue)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setKeepLinksWithNoValue in interface ISchematicExpandLinksByAttributeRule

Parameters:

keepLinksWithNoValue - The keepLinksWithNoValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCodeName

public boolean isUseCodeName()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

isUseCodeName in interface ISchematicExpandLinksByAttributeRule

Returns:

The useCodeName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCodeName

public void setUseCodeName(boolean useCodeName)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

setUseCodeName in interface ISchematicExpandLinksByAttributeRule

Parameters:

useCodeName - The useCodeName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.