com.esri.arcgis.schematic
Class NgAttributeConstant

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

public class NgAttributeConstant
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgAttributeConstant, INgAttribute

Attribute constant object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgAttributeConstant(Object obj)
          Construct a NgAttributeConstant 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 getConstantValue()
          Value for the attribute constant.
 String getName()
          Name of the attribute constant.
 INgObjectType getObjectType()
          Object type the attribute is related to.
 int getType()
          Type of the attribute.
 int hashCode()
          the hashcode for this object
 void setConstantValue(String pVal)
          Value for the attribute constant.
 void setName(String pVal)
          Name of the attribute constant.
 
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

NgAttributeConstant

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

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

Throws:
IOException - if there are interop problems NgAttributeConstant theNgAttributeConstant = (NgAttributeConstant) 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 constant.

Description

This name is defined when the constant 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 INgAttributeConstant
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 constant.

Product Availability

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

Specified by:
setName in interface INgAttribute
Specified by:
setName in interface INgAttributeConstant
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConstantValue

public String getConstantValue()
                        throws IOException,
                               AutomationException
Value for the attribute constant.

Product Availability

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

Specified by:
getConstantValue in interface INgAttributeConstant
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstantValue

public void setConstantValue(String pVal)
                      throws IOException,
                             AutomationException
Value for the attribute constant.

Product Availability

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

Specified by:
setConstantValue in interface INgAttributeConstant
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.