com.esri.arcgis.schematic
Class INgAttributeFunctionProxy

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

All Implemented Interfaces:

INgAttributeFunction, Externalizable, Serializable

public class INgAttributeFunctionProxy
extends com.esri.arcgis.interop.Dispatch
implements INgAttributeFunction, Serializable

Provides access to members that control the attribute function.

Description

An attribute function is an attribute whose values are computed by a function.

Product Availability

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

See Also:

INgAttribute, Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getName() Name of the attribute function.
INgNames	getParameterNames() List of the parameter names required by the function that computes the attribute values.
String	getProcedureName() Name of the function that computes the attribute values.
INgUserAttributeSet	getUserAttributeSet() User attribute functions set where the function used to compute the attribute values is stored.
String	getUserAttributeSetName() Name of the set of user attribute functions where the function that computes the attribute values is stored.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setName(String pVal) Name of the attribute function.
void	setParameterNames(INgNames pVal) List of the parameter names required by the function that computes the attribute values.
void	setProcedureName(String pVal) Name of the function that computes the attribute values.
void	setUserAttributeSet(INgUserAttributeSet pVal) User attribute functions set where the function used to compute the attribute values is stored.
void	setUserAttributeSetName(String pVal) Name of the set of user attribute functions where the function that computes the attribute values is stored.
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

INgAttributeFunctionProxy

public INgAttributeFunctionProxy()

INgAttributeFunctionProxy

public INgAttributeFunctionProxy(Object obj)
                          throws IOException

Throws:

IOException

INgAttributeFunctionProxy

protected INgAttributeFunctionProxy(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 attribute function.

Description

This name is defined when the function attribute is created
- either by calling the INgObjectType CreateAttribute method in the program code,
- or through ArcGIS Schematics Designer, when the attribute has been created.

Product Availability

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

Specified by:

getName in interface INgAttributeFunction

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 attribute function.

Product Availability

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

Specified by:

setName in interface INgAttributeFunction

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserAttributeSet

public INgUserAttributeSet getUserAttributeSet()
                                        throws IOException,
                                               AutomationException

User attribute functions set where the function used to compute the attribute values is stored.

Product Availability

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

Specified by:

getUserAttributeSet in interface INgAttributeFunction

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserAttributeSet

public void setUserAttributeSet(INgUserAttributeSet pVal)
                         throws IOException,
                                AutomationException

User attribute functions set where the function used to compute the attribute values is stored.

Product Availability

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

Specified by:

setUserAttributeSet in interface INgAttributeFunction

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgUserAttributeSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcedureName

public String getProcedureName()
                        throws IOException,
                               AutomationException

Name of the function that computes the attribute values.

Product Availability

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

Specified by:

getProcedureName in interface INgAttributeFunction

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcedureName

public void setProcedureName(String pVal)
                      throws IOException,
                             AutomationException

Name of the function that computes the attribute values.

Product Availability

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

Specified by:

setProcedureName in interface INgAttributeFunction

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterNames

public INgNames getParameterNames()
                           throws IOException,
                                  AutomationException

List of the parameter names required by the function that computes the attribute values.

Product Availability

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

Specified by:

getParameterNames in interface INgAttributeFunction

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterNames

public void setParameterNames(INgNames pVal)
                       throws IOException,
                              AutomationException

List of the parameter names required by the function that computes the attribute values.

Product Availability

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

Specified by:

setParameterNames in interface INgAttributeFunction

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgNames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserAttributeSetName

public String getUserAttributeSetName()
                               throws IOException,
                                      AutomationException

Name of the set of user attribute functions where the function that computes the attribute values is stored.

Description

The user attribute set name must be formatted as follows "ComponentName.ClassModuleName" where ComponentName is the name of the COM component that implements the ClassModuleName class where the function that will be used to compute the attribute values is stored.

Remarks

If you set a reference to your COM component in your project references, you can only set the class module name for the UserAtttributeSetName value.

Product Availability

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

Specified by:

getUserAttributeSetName in interface INgAttributeFunction

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserAttributeSetName

public void setUserAttributeSetName(String pVal)
                             throws IOException,
                                    AutomationException

Name of the set of user attribute functions where the function that computes the attribute values is stored.

Product Availability

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

Specified by:

setUserAttributeSetName in interface INgAttributeFunction

Parameters:

pVal - The pVal (in)

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