com.esri.arcgis.schematic
Class SchematicAlgoCompression

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoCompression, ISchematicAlgorithm, ISchematicJSONParameters, Serializable

public class SchematicAlgoCompression
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAlgoCompression, ISchematicAlgorithm, ISchematicJSONParameters

Compression schematic algorithm object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicAlgoCompression()
Constructs a SchematicAlgoCompression using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	execute(ISchematicLayer schematicLayer, ITrackCancel cancelTracker) Execute the schematic algorithm.
String	getAlgorithmCLSID() The CLSID of the algorithm.
static String	getClsid() getClsid.
double	getClusterThresholdDistance() Threshold distance used to cluster connected nodes together.
double	getDistanceBetweenClusters() Minimum distance to preserve between connected clusters.
IJSONArray	getJSONParametersArray() JSON parameters array.
String	getLabel() The label of the algorithm.
IPropertySet	getPropertySet() The property set of the algorithm contains a collection of its parameters and their values.
ISchematicDiagramClassName	getSchematicDiagramClassName() The diagram class object used to initialize the algorithm.
int	hashCode() the hashcode for this object
boolean	isAbsoluteParameters() Indicates if the values set for the spacings must be interpreted as absolute units.
boolean	isAvailable() Indicates if the algorithm is currently available.
boolean	isCompressTowardCenter() Indicates if the algorithm moves the nodes toward the diagram center.
boolean	isEnabled(ISchematicLayer schematicLayer) Indicates if the algorithm is currently enabled.
boolean	isHeedContainers() Indicates if containers and their contents are processed as a whole or independently.
boolean	isKeepInsideVertices() Indicates if link vertices inside containers are kept or removed.
boolean	isKeepOutsideVertices() Indicates if the first link vertex outside a container is kept or removed.
boolean	isOverridable() Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
boolean	isUseEndNode() Indicates if the algorithm use end nodes.
boolean	isUseRootNode() Indicates if the algorithm use root nodes.
void	setAbsoluteParameters(boolean pVal) Indicates if the values set for the spacings must be interpreted as absolute units.
void	setAvailable(boolean available) Indicates if the algorithm is currently available.
void	setClusterThresholdDistance(double pdThreshold) Threshold distance used to cluster connected nodes together.
void	setCompressTowardCenter(boolean pVal) Indicates if the algorithm moves the nodes toward the diagram center.
void	setDistanceBetweenClusters(double pdMinLength) Minimum distance to preserve between connected clusters.
void	setHeedContainers(boolean pVal) Indicates if containers and their contents are processed as a whole or independently.
void	setJSONParametersObject(IJSONObject rhs1) JSON parameters object.
void	setKeepInsideVertices(boolean pVal) Indicates if link vertices inside containers are kept or removed.
void	setKeepOutsideVertices(boolean pVal) Indicates if the first link vertex outside a container is kept or removed.
void	setLabel(String label) The label of the algorithm.
void	setOverridable(boolean pOverridable) Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.
void	setPropertySet(IPropertySet propertySet) The property set of the algorithm contains a collection of its parameters and their values.
void	setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName) The diagram class object used to initialize the algorithm.

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

SchematicAlgoCompression

public SchematicAlgoCompression()
                         throws IOException,
                                UnknownHostException

Constructs a SchematicAlgoCompression using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicAlgoCompression

public SchematicAlgoCompression(Object obj)
                         throws IOException

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

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

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

isHeedContainers

public boolean isHeedContainers()
                         throws IOException,
                                AutomationException

Indicates if containers and their contents are processed as a whole or independently.

Product Availability

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

Specified by:

isHeedContainers in interface ISchematicAlgoCompression

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeedContainers

public void setHeedContainers(boolean pVal)
                       throws IOException,
                              AutomationException

Indicates if containers and their contents are processed as a whole or independently.

Product Availability

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

Specified by:

setHeedContainers in interface ISchematicAlgoCompression

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepInsideVertices

public boolean isKeepInsideVertices()
                             throws IOException,
                                    AutomationException

Indicates if link vertices inside containers are kept or removed.

Product Availability

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

Specified by:

isKeepInsideVertices in interface ISchematicAlgoCompression

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepInsideVertices

public void setKeepInsideVertices(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if link vertices inside containers are kept or removed.

Product Availability

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

Specified by:

setKeepInsideVertices in interface ISchematicAlgoCompression

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepOutsideVertices

public boolean isKeepOutsideVertices()
                              throws IOException,
                                     AutomationException

Indicates if the first link vertex outside a container is kept or removed.

Product Availability

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

Specified by:

isKeepOutsideVertices in interface ISchematicAlgoCompression

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepOutsideVertices

public void setKeepOutsideVertices(boolean pVal)
                            throws IOException,
                                   AutomationException

Indicates if the first link vertex outside a container is kept or removed.

Product Availability

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

Specified by:

setKeepOutsideVertices in interface ISchematicAlgoCompression

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClusterThresholdDistance

public double getClusterThresholdDistance()
                                   throws IOException,
                                          AutomationException

Threshold distance used to cluster connected nodes together.

Product Availability

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

Specified by:

getClusterThresholdDistance in interface ISchematicAlgoCompression

Returns:

The pdThreshold

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClusterThresholdDistance

public void setClusterThresholdDistance(double pdThreshold)
                                 throws IOException,
                                        AutomationException

Threshold distance used to cluster connected nodes together.

Product Availability

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

Specified by:

setClusterThresholdDistance in interface ISchematicAlgoCompression

Parameters:

pdThreshold - The pdThreshold (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceBetweenClusters

public double getDistanceBetweenClusters()
                                  throws IOException,
                                         AutomationException

Minimum distance to preserve between connected clusters.

Product Availability

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

Specified by:

getDistanceBetweenClusters in interface ISchematicAlgoCompression

Returns:

The pdMinLength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceBetweenClusters

public void setDistanceBetweenClusters(double pdMinLength)
                                throws IOException,
                                       AutomationException

Minimum distance to preserve between connected clusters.

Product Availability

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

Specified by:

setDistanceBetweenClusters in interface ISchematicAlgoCompression

Parameters:

pdMinLength - The pdMinLength (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbsoluteParameters

public boolean isAbsoluteParameters()
                             throws IOException,
                                    AutomationException

Indicates if the values set for the spacings must be interpreted as absolute units.

Product Availability

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

Specified by:

isAbsoluteParameters in interface ISchematicAlgoCompression

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbsoluteParameters

public void setAbsoluteParameters(boolean pVal)
                           throws IOException,
                                  AutomationException

Indicates if the values set for the spacings must be interpreted as absolute units.

Product Availability

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

Specified by:

setAbsoluteParameters in interface ISchematicAlgoCompression

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCompressTowardCenter

public boolean isCompressTowardCenter()
                               throws IOException,
                                      AutomationException

Indicates if the algorithm moves the nodes toward the diagram center.

Product Availability

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

Specified by:

isCompressTowardCenter in interface ISchematicAlgoCompression

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressTowardCenter

public void setCompressTowardCenter(boolean pVal)
                             throws IOException,
                                    AutomationException

Indicates if the algorithm moves the nodes toward the diagram center.

Product Availability

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

Specified by:

setCompressTowardCenter in interface ISchematicAlgoCompression

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled(ISchematicLayer schematicLayer)
                  throws IOException,
                         AutomationException

Indicates if the algorithm is currently enabled.

Product Availability

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

Specified by:

isEnabled in interface ISchematicAlgorithm

Parameters:

schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)

Returns:

The enabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvailable

public boolean isAvailable()
                    throws IOException,
                           AutomationException

Indicates if the algorithm is currently available.

Product Availability

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

Specified by:

isAvailable in interface ISchematicAlgorithm

Returns:

The available

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvailable

public void setAvailable(boolean available)
                  throws IOException,
                         AutomationException

Indicates if the algorithm is currently available.

Product Availability

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

Specified by:

setAvailable in interface ISchematicAlgorithm

Parameters:

available - The available (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverridable

public boolean isOverridable()
                      throws IOException,
                             AutomationException

Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:

isOverridable in interface ISchematicAlgorithm

Returns:

The pOverridable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverridable

public void setOverridable(boolean pOverridable)
                    throws IOException,
                           AutomationException

Indicates if the algorithm properties page is editable from ArcMap; that is, enabling the Layout Properties button in ArcMap.

Product Availability

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

Specified by:

setOverridable in interface ISchematicAlgorithm

Parameters:

pOverridable - The pOverridable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClassName

public ISchematicDiagramClassName getSchematicDiagramClassName()
                                                        throws IOException,
                                                               AutomationException

The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:

getSchematicDiagramClassName in interface ISchematicAlgorithm

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassNameByRef

public void setSchematicDiagramClassNameByRef(ISchematicDiagramClassName schematicDiagramClassName)
                                       throws IOException,
                                              AutomationException

The diagram class object used to initialize the algorithm.

Product Availability

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

Specified by:

setSchematicDiagramClassNameByRef in interface ISchematicAlgorithm

Parameters:

schematicDiagramClassName - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel()
                throws IOException,
                       AutomationException

The label of the algorithm.

Product Availability

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

Specified by:

getLabel in interface ISchematicAlgorithm

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String label)
              throws IOException,
                     AutomationException

The label of the algorithm.

Product Availability

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

Specified by:

setLabel in interface ISchematicAlgorithm

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRootNode

public boolean isUseRootNode()
                      throws IOException,
                             AutomationException

Indicates if the algorithm use root nodes.

Product Availability

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

Specified by:

isUseRootNode in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseEndNode

public boolean isUseEndNode()
                     throws IOException,
                            AutomationException

Indicates if the algorithm use end nodes.

Product Availability

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

Specified by:

isUseEndNode in interface ISchematicAlgorithm

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicAlgorithm

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.

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException

The property set of the algorithm contains a collection of its parameters and their values.

Product Availability

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

Specified by:

setPropertySet in interface ISchematicAlgorithm

Parameters:

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.

getAlgorithmCLSID

public String getAlgorithmCLSID()
                         throws IOException,
                                AutomationException

The CLSID of the algorithm.

Product Availability

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

Specified by:

getAlgorithmCLSID in interface ISchematicAlgorithm

Returns:

The bstrCLSID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(ISchematicLayer schematicLayer,
                    ITrackCancel cancelTracker)
             throws IOException,
                    AutomationException

Execute the schematic algorithm.

Product Availability

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

Specified by:

execute in interface ISchematicAlgorithm

Parameters:

schematicLayer - A reference to a com.esri.arcgis.schematic.ISchematicLayer (in, optional, pass 0 if not required)

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.

getJSONParametersArray

public IJSONArray getJSONParametersArray()
                                  throws IOException,
                                         AutomationException

JSON parameters array.

Product Availability

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

Specified by:

getJSONParametersArray in interface ISchematicJSONParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJSONParametersObject

public void setJSONParametersObject(IJSONObject rhs1)
                             throws IOException,
                                    AutomationException

JSON parameters object.

Product Availability

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

Specified by:

setJSONParametersObject in interface ISchematicJSONParameters

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.