com.esri.arcgis.schematic
Class SchematicAttributeField

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicAttributeField
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicAttribute, ISchematicAttributeField, Serializable

public class SchematicAttributeField
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAttributeField, ISchematicAttribute

Schematic attribute field object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAttributeField(Object obj)
          Construct a SchematicAttributeField using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void delete()
          Deletes the schematic attribute.
 boolean equals(Object o)
          Compare this object with another
 IUID getCLSID()
          CLSID of the schematic attribute.
 String getDescription()
          Description of the schematic attribute.
 Object getFieldNames()
          Fields names of the schematic attribute field.
 String getName()
          Name of the schematic attribute.
 ISchematicObjectClass getSchematicObjectClass()
          Schematic object class the schematic attribute belongs to.
 Object getValue(ISchematicObject schematicObject)
          The schematic attribute value for the specified schematic object.
 int hashCode()
          the hashcode for this object
 void setFieldNames(Object fieldNames)
          Fields names of the schematic attribute field.
 void setName(String name)
          Name of the schematic 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

SchematicAttributeField

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

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

Throws:
IOException - if there are interop problems SchematicAttributeField theSchematicAttributeField = (SchematicAttributeField) 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

getFieldNames

public Object getFieldNames()
                     throws IOException,
                            AutomationException
Fields names of the schematic attribute field.

Product Availability

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

Specified by:
getFieldNames in interface ISchematicAttributeField
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldNames

public void setFieldNames(Object fieldNames)
                   throws IOException,
                          AutomationException
Fields names of the schematic attribute field.

Product Availability

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

Specified by:
setFieldNames in interface ISchematicAttributeField
Parameters:
fieldNames - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the schematic attribute.

Product Availability

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

Specified by:
getName in interface ISchematicAttribute
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Name of the schematic attribute.

Product Availability

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

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

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Description of the schematic attribute.

Product Availability

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

Specified by:
getDescription in interface ISchematicAttribute
Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException
CLSID of the schematic attribute.

Product Availability

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

Specified by:
getCLSID in interface ISchematicAttribute
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicObjectClass

public ISchematicObjectClass getSchematicObjectClass()
                                              throws IOException,
                                                     AutomationException
Schematic object class the schematic attribute belongs to.

Product Availability

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

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

delete

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

Product Availability

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

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

getValue

public Object getValue(ISchematicObject schematicObject)
                throws IOException,
                       AutomationException
The schematic attribute value for the specified schematic object.

Product Availability

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

Specified by:
getValue in interface ISchematicAttribute
Parameters:
schematicObject - A reference to a com.esri.arcgis.schematic.ISchematicObject (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.