com.esri.arcgis.schematic
Class NgAttributeFunction

java.lang.Object
  extended by com.esri.arcgis.schematic.NgAttributeFunction
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgAttribute, INgAttributeFunction, Serializable

public class NgAttributeFunction
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgAttributeFunction, INgAttribute

Attribute function object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgAttributeFunction(Object obj)
          Construct a NgAttributeFunction using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void delete()
          Deletes the attribute.
 boolean equals(Object o)
          Compare this object with another
 String getName()
          Name of the attribute function.
 INgObjectType getObjectType()
          Object type the attribute is related to.
 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.
 int getType()
          Type of the attribute.
 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.
 int hashCode()
          the hashcode for this object
 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.
 
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

NgAttributeFunction

public NgAttributeFunction(Object obj)
                    throws IOException
Construct a NgAttributeFunction using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgAttributeFunction.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgAttributeFunction o = (NgAttributeFunction)obj; // will not work

NgAttributeFunction o = new NgAttributeFunction(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems NgAttributeFunction theNgAttributeFunction = (NgAttributeFunction) obj;
Method Detail

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

getType

public int getType()
            throws IOException,
                   AutomationException
Type of the attribute.

Description

The attribute type is defined when the 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.

Seven types of attributes are available:

Remarks

Attributes of a given type have their own characteristics. You can specify these characteristics through their specific interface INgAttributeConstant, INgAttributeField, INgAttributeFormatted, INgAttributeFunction, INgAttributeGeometry, or INgAttributeQuery.

Product Availability

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

Specified by:
getType in interface INgAttribute
Returns:
A com.esri.arcgis.schematic.esriNgAttributeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectType

public INgObjectType getObjectType()
                            throws IOException,
                                   AutomationException
Object type the attribute is related to.

Product Availability

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

Specified by:
getObjectType in interface INgAttribute
Returns:
A reference to a com.esri.arcgis.schematic.INgObjectType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes the attribute.

Product Availability

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

Specified by:
delete in interface INgAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.