com.esri.arcgis.schematic
Class SchematicAttributeFunction

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

public class SchematicAttributeFunction
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicAttributeFunction, ISchematicAttribute

Provides access to members that manage the schematic attribute function.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicAttributeFunction(Object obj)
          Construct a SchematicAttributeFunction 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.
 String getFunctionName()
          Function name of the schematic attribute function.
 String getName()
          Name of the schematic attribute.
 Object getParameterNames()
          Parameters names of the schematic attribute function.
 ISchematicObjectClass getSchematicObjectClass()
          Schematic object class the schematic attribute belongs to.
 String getUserProgId()
          User ProgId of the schematic attribute function.
 Object getValue(ISchematicObject schematicObject)
          The schematic attribute value for the specified schematic object.
 int hashCode()
          the hashcode for this object
 void setFunctionName(String functionName)
          Function name of the schematic attribute function.
 void setName(String name)
          Name of the schematic attribute.
 void setParameterNames(Object parameterNames)
          Parameters names of the schematic attribute function.
 void setUserProgId(String userProgId)
          User ProgId of the schematic attribute function.
 
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

SchematicAttributeFunction

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

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

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

getUserProgId

public String getUserProgId()
                     throws IOException,
                            AutomationException
User ProgId of the schematic attribute function.

Product Availability

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

Specified by:
getUserProgId in interface ISchematicAttributeFunction
Returns:
The userProgId
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserProgId

public void setUserProgId(String userProgId)
                   throws IOException,
                          AutomationException
User ProgId of the schematic attribute function.

Product Availability

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

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

getFunctionName

public String getFunctionName()
                       throws IOException,
                              AutomationException
Function name of the schematic attribute function.

Product Availability

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

Specified by:
getFunctionName in interface ISchematicAttributeFunction
Returns:
The functionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFunctionName

public void setFunctionName(String functionName)
                     throws IOException,
                            AutomationException
Function name of the schematic attribute function.

Product Availability

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

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

getParameterNames

public Object getParameterNames()
                         throws IOException,
                                AutomationException
Parameters names of the schematic attribute function.

Product Availability

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

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

setParameterNames

public void setParameterNames(Object parameterNames)
                       throws IOException,
                              AutomationException
Parameters names of the schematic attribute function.

Product Availability

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

Specified by:
setParameterNames in interface ISchematicAttributeFunction
Parameters:
parameterNames - 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.

Description

A number of schematic feature classes' predefined attributes are used by Schematics. These attributes have predefined names, allowing Schematics to automatically deal with them when they are configured.

Some predefined attributes are completely managed by Schematics by default and automatically stored in system fields in the schematic feature classes in the schematic dataset at the schematic feature creation; for example, spatial or topological attributes.

The table below lists all the predefined attributes that can be configured on schematic feature classes depending on their type:

Predefined attribute name

Schematic feature class Type

Description

AbsolutePosition

Node On Link

absolute position on the reference link

ContainerBottomMargin

Node

container margin at bottom

ContainerLeftMargin

Node

container margin at left

ContainerMargin

Node

constant container margin at right, left, top, and bottom

ContainerMarginSymbolsFlag

Node

indicates whether the margin includes the symbol size

ContainerMarginUnit

Node

container margin unit

ContainerRightMargin

Node

container margin at right

ContainerTopMargin

Node

container margin at top

EndFlag Node

indicates whether it's an end node schematic feature

ExtremityNode

Link, Sub Link

extremity node or node on link identifier

ExtremityPortNumber

Link, Sub Link

port number on the extremity node or node on link symbol

FCN

Node, Node On Link, Link, Sub Link

name of the feature class or table that contains the GIS feature/object associated with the schematic feature
FDSN

Node, Node On Link, Link, Sub Link

name of the data source to connect the geodatabase that contains the GIS feature/object associated with the schematic feature

FOID

Node, Node On Link, Link, Sub Link

OBJECTID of the GIS feature/object associated with the schematic feature

InitialListPoints

Link list of initial vertices

InitialXPosition

Node initial x-coordinate

InitialYPosition

Node initial y-coordinate

InitialRotation

Node initial rotation angle in degrees
OriginNode

Link, Sub Link

origin node or node on link identifier

OriginPortNumber

Link, Sub Link

port number on the origin node or node on link symbol

PEN

Node, Node On Link, Link, SubLink

name of the parent schematic feature that is related to the schematic feature; for example, container name

PTN

Node, Node On Link, Link, SubLink

name of the schematic feature class that implements the parent that is related to the schematic feature

ReferenceLink

Node On Link, Sub Link

reference link identifier

RelativePosition Node On Link

relative position on the reference link

RootFlag Node

indicates whether it's a root node schematic feature

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.