com.esri.arcgis.schematic
Class INgDiscretePropertyProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.INgDiscretePropertyProxy

All Implemented Interfaces:

INgDiscreteProperty, Externalizable, Serializable

public class INgDiscretePropertyProxy
extends com.esri.arcgis.interop.Dispatch
implements INgDiscreteProperty, Serializable

Provides access to members that control the discrete property.

Description

A discrete property lets you specify the graphic effects matching a final list of values for the property.

To associate graphic effects with a discrete property, the possible finite set of numbers or alphanumeric code of the property must be specified; that is, you will have to define the discrete filters of the property (AddFilter method).

Product Availability

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

See Also:

INgDirectProperty, INgTextualProperty, INgBoundedProperty, INgProperty, INgElementType.createProperty(String, int, int, int), Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	INgDiscretePropertyProxy()
	INgDiscretePropertyProxy(Object obj)
protected	INgDiscretePropertyProxy(Object obj, String iid)

Method Summary

INgDiscreteFilter	addFilter(int filterNum, String name, Object value) Creates the filter 'filterNum' named 'name' for the property value 'value'.
void	addListener(String iidStr, Object theListener, Object theSource)
void	deleteFilter(int filterNum) Deletes the discrete filter 'filterNum'.
INgElements	getElementsByFilter(INgDiagram diagram, int filterNum, int mode) Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).
INgElementType	getElementType() Element type the discrete property applies to.
INgDiscreteFilters	getFilters() Collection of the discrete filters defined for the discrete property.
String	getName() Name of the discrete property.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setName(String pVal) Name of the discrete property.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

INgDiscretePropertyProxy

public INgDiscretePropertyProxy()

INgDiscretePropertyProxy

public INgDiscretePropertyProxy(Object obj)
                         throws IOException

Throws:

IOException

INgDiscretePropertyProxy

protected INgDiscretePropertyProxy(Object obj,
                                   String iid)
                            throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the discrete property.

Description

This name is defined when the discrete property is created:

- either by calling the INgElementType CreateProperty method in the program code,

- or through ArcGIS Schematics Designer, when the discrete property has been created.

Product Availability

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

Specified by:

getName in interface INgDiscreteProperty

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the discrete property.

Product Availability

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

Specified by:

setName in interface INgDiscreteProperty

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilters

public INgDiscreteFilters getFilters()
                              throws IOException,
                                     AutomationException

Collection of the discrete filters defined for the discrete property.

Product Availability

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

Specified by:

getFilters in interface INgDiscreteProperty

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementsByFilter

public INgElements getElementsByFilter(INgDiagram diagram,
                                       int filterNum,
                                       int mode)
                                throws IOException,
                                       AutomationException

Returns all the elements contained in the diagram 'Diagram' that match the 'filternum' discrete filter (mode=esriNgFilterEqual) or that do not match the 'filterNum' discrete filter (mode = esriNgFilterDifferent) (see esriNgFilterSelectionMode).

Product Availability

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

Specified by:

getElementsByFilter in interface INgDiscreteProperty

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.INgDiagram (in)

filterNum - The filterNum (in)

mode - A com.esri.arcgis.schematic.esriNgFilterSelectionMode constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFilter

public INgDiscreteFilter addFilter(int filterNum,
                                   String name,
                                   Object value)
                            throws IOException,
                                   AutomationException

Creates the filter 'filterNum' named 'name' for the property value 'value'.

Product Availability

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

Specified by:

addFilter in interface INgDiscreteProperty

Parameters:

filterNum - The filterNum (in)

name - The name (in)

value - A Variant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.getFilters(), INgDiscreteProperty.deleteFilter(int)

deleteFilter

public void deleteFilter(int filterNum)
                  throws IOException,
                         AutomationException

Deletes the discrete filter 'filterNum'.

Product Availability

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

Specified by:

deleteFilter in interface INgDiscreteProperty

Parameters:

filterNum - The filterNum (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgDiscreteProperty.addFilter(int, String, java.lang.Object)

getElementType

public INgElementType getElementType()
                              throws IOException,
                                     AutomationException

Element type the discrete property applies to.

Product Availability

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

Specified by:

getElementType in interface INgDiscreteProperty

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException