com.esri.arcgis.schematic
Class NgAttributeScript

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgAttribute, INgAttributeScript, Serializable

public class NgAttributeScript
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgAttributeScript, INgAttribute

Script Attribute object.

Description

This object is new at ArcGIS 9.3.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgAttributeScript(Object obj)
Construct a NgAttributeScript 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
INgAttributes	getAttributes() List of the attributes input of the script.
String	getName() Name of the script attribute.
INgObjectType	getObjectType() Object type the attribute is related to.
String	getScript() Script to eval.
int	getType() Type of the attribute.
int	hashCode() the hashcode for this object
void	setAttributes(INgAttributes pVal) List of the attributes input of the script.
void	setName(String pVal) Name of the script attribute.
void	setScript(String pVal) Script to eval.

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

NgAttributeScript

public NgAttributeScript(Object obj)
                  throws IOException

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

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

Throws:

IOException - if there are interop problems NgAttributeScript theNgAttributeScript = (NgAttributeScript) 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 script attribute.

Product Availability

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

Specified by:

getName in interface INgAttribute

Specified by:

getName in interface INgAttributeScript

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

Product Availability

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

Specified by:

setName in interface INgAttribute

Specified by:

setName in interface INgAttributeScript

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScript

public String getScript()
                 throws IOException,
                        AutomationException

Script to eval.

Product Availability

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

Specified by:

getScript in interface INgAttributeScript

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScript

public void setScript(String pVal)
               throws IOException,
                      AutomationException

Script to eval.

Product Availability

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

Specified by:

setScript in interface INgAttributeScript

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributes

public INgAttributes getAttributes()
                            throws IOException,
                                   AutomationException

List of the attributes input of the script.

Product Availability

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

Specified by:

getAttributes in interface INgAttributeScript

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributes

public void setAttributes(INgAttributes pVal)
                   throws IOException,
                          AutomationException

List of the attributes input of the script.

Product Availability

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

Specified by:

setAttributes in interface INgAttributeScript

Parameters:

pVal - A reference to a com.esri.arcgis.schematic.INgAttributes (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:

• esriNgConstantAttribute, for an attribute whose value is a constant
• esriNgFieldAttribute, for an attribute whose values become from a field or a set of fields returned by the query set for its related object type
• esriNgFormattedAttribute, for an attribute whose values are built by formatting other attributes values and/or string,
• esriNgFunctionAttribute, for an attribute whose values are computed by a function
• esriNgGeometryAttribute, for an attribute whose value is a geometric information decoded from an ESRI BLOB
• esriNgQueryAttribute, for an attribute whose value is returned by a query other than the query set for its related object type
• esriNgByFunctionsAttribute,
• esriNgListPointsAttribute,
• esriNgPropertySetAttribute, for an attribute whose values is stored in a PropertySet

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.