com.esri.arcgis.schematic
Class NgAttribute

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

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

Attribute object.

Product Availability

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

See Also:
Serialized Form

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

NgAttribute

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

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

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

Description

This name 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.

A number of predefined attribute names are available. They are very specific for each type of schematic object; that is you have specific predefined names for diagram type, others for node types... When an attibute is created with a predefined name, this attribute impacts directly your diagrams or your elements display.

Here under are the predefined names list for each type of schematic object:


Predefined names for attributes related to a diagram type:

Predefined names for attributes related to a node or drawing element type:

Predefined names for attributes related to a link element type:

Predefined names for attributes related to a node-on-link element type:

Predefined names for attributes related to a sub-link element type:

Product Availability

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

Specified by:
getName in interface INgAttribute
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.

Product Availability

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

Specified by:
setName in interface INgAttribute
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.