com.esri.arcgis.schematic
Class NgDiagramType

java.lang.Object
  extended by com.esri.arcgis.schematic.NgDiagramType
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgDiagramType, INgObjectType, INgObjectTypeDatas, Serializable

public class NgDiagramType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgDiagramType, INgObjectType, INgObjectTypeDatas

Graphic diagram type object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgDiagramType(Object obj)
          Construct a NgDiagramType using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void associateElementType(INgElementType elementType)
          Associates the 'ElementType' element type with the diagram type.
 INgAttribute createAttribute(String attributeName, int attributeType)
          Creates a new attribute named 'attributeName' whose type is 'attributeType' for the object type.
 void delete(boolean deleteDescendants)
          Deletes the diagram type.
 void deleteUserData(INgUserData userData)
          Delete the specified userdata defined for the object type.
 void dissociateElementType(INgElementType elementType)
          Dissociates the 'ElementType' element type with the diagram type.
 boolean equals(Object o)
          Compare this object with another
 INgDiagramTypes getAncestors()
          List of the ancestor diagram types for the diagram type.
 INgElementTypes getAssociatedElementTypes()
          List of the element types associated with the diagram type.
 INgAttribute getAttribute(String attributeName)
          Returns the attibute named 'attributeName' defined for the object type.
 INgAttributes getAttributes()
          List of the attributes defined for the object type.
 INgDiagramTypes getChildren()
          List of the child diagram types for the diagram type.
 INgDataSource getDataSource()
          Data source related to the object type.
 INgDiagramTypes getDescendants()
          List of the descendant diagram types for the diagram type.
 INgDiagram getDiagram(String diagramName)
          Returns the diagram named 'diagramName' implemented by the diagram type.
 INgNames getDiagramNames()
          List of the names of the diagrams implemented by the diagram type.
 INgDiagrams getDiagrams()
          List of diagrams implemented by the diagram type.
 INgNames getFieldNames()
          List of the query field names used to build up each object identifier implemented by the object type.
 String getName()
          Name of the diagram type.
 INgParameters getParameters()
          List of the query parameters.
 INgDiagramType getParent()
          Parent diagram type of the diagram type.
 INgProject getProject()
          Project of the object type.
 String getQueryString()
          Query, name of the query, or name of the table that returns all objects of the object type.
 Object getUserDataValue(INgUserData userData)
          Returns the value of the specified userdata defined for the object type.
 int hashCode()
          the hashcode for this object
 boolean isElementTypeAssociated(INgElementType elementType)
          Indicates if the 'ElementType' element type is associated with the diagram type.
 INgDiagram openDiagram(String diagramName, boolean restore)
          Opens the diagram named 'diagramName' implemented by the diagram type.
 void setDataSource(INgDataSource pVal)
          Data source related to the object type.
 void setFieldNames(INgNames pVal)
          List of the query field names used to build up each object identifier implemented by the object type.
 void setName(String pVal)
          Name of the diagram type.
 void setParameters(INgParameters pVal)
          List of the query parameters.
 void setParent(INgDiagramType pVal)
          Parent diagram type of the diagram type.
 void setQueryString(String pVal)
          Query, name of the query, or name of the table that returns all objects of the object type.
 void setUserDataValue(INgUserData userData, Object userDataValue)
          Modifies the value of the 'specified userdata defined for the object type.
 
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

NgDiagramType

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

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

Throws:
IOException - if there are interop problems NgDiagramType theNgDiagramType = (NgDiagramType) 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 diagram type.

Description

This name is defined when the diagram type is created:

- either by calling the INgProjectBuilder CreateDiagramType method in the code,

- or when the diagram type is created through ArcGIS Schematics Designer.

Product Availability

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

Specified by:
getName in interface INgDiagramType
Specified by:
getName in interface INgObjectType
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getName(), INgElementType.getName()

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the diagram type.

Product Availability

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

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

getAssociatedElementTypes

public INgElementTypes getAssociatedElementTypes()
                                          throws IOException,
                                                 AutomationException
List of the element types associated with the diagram type.

Product Availability

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

Specified by:
getAssociatedElementTypes in interface INgDiagramType
Returns:
A reference to a com.esri.arcgis.schematic.INgElementTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.associateElementType(com.esri.arcgis.schematic.INgElementType)

getDiagrams

public INgDiagrams getDiagrams()
                        throws IOException,
                               AutomationException
List of diagrams implemented by the diagram type.

Product Availability

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

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

getDiagram

public INgDiagram getDiagram(String diagramName)
                      throws IOException,
                             AutomationException
Returns the diagram named 'diagramName' implemented by the diagram type.

Product Availability

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

Specified by:
getDiagram in interface INgDiagramType
Parameters:
diagramName - The diagramName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDiagram

public INgDiagram openDiagram(String diagramName,
                              boolean restore)
                       throws IOException,
                              AutomationException
Opens the diagram named 'diagramName' implemented by the diagram type.

Description

Note that the diagramName parameter must be consistent with the diagram name identifier definition for its associated diagram type.

Remarks

Several Schematic event procedures are automatically chained during a diagram opening. For more details on these events' chaining, please see the Remarks section available from the INgDiagram Open method help-page.

Product Availability

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

Specified by:
openDiagram in interface INgDiagramType
Parameters:
diagramName - The diagramName (in)
restore - The restore (in, optional, pass true if not required)
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectEvents.beforeOpenDiagram(com.esri.arcgis.schematic.INgProjectEventsBeforeOpenDiagramEvent), INgProject.openDiagram(com.esri.arcgis.schematic.INgDiagramType, String, boolean), INgDiagram.open()

getParent

public INgDiagramType getParent()
                         throws IOException,
                                AutomationException
Parent diagram type of the diagram type.

Product Availability

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

Specified by:
getParent in interface INgDiagramType
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getChildren(), INgDiagramType.getAncestors()

setParent

public void setParent(INgDiagramType pVal)
               throws IOException,
                      AutomationException
Parent diagram type of the diagram type.

Product Availability

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

Specified by:
setParent in interface INgDiagramType
Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgDiagramType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAncestors

public INgDiagramTypes getAncestors()
                             throws IOException,
                                    AutomationException
List of the ancestor diagram types for the diagram type.

Description

Note that the diagram type ancestors list is returned in ascending hierarchy order; that is from the parent to the most distant ancestor.

Product Availability

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

Specified by:
getAncestors in interface INgDiagramType
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getParent(), INgDiagramType.getChildren()

getChildren

public INgDiagramTypes getChildren()
                            throws IOException,
                                   AutomationException
List of the child diagram types for the diagram type.

Product Availability

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

Specified by:
getChildren in interface INgDiagramType
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getDescendants(), INgDiagramType.getParent(), INgDiagramType.getAncestors()

getDescendants

public INgDiagramTypes getDescendants()
                               throws IOException,
                                      AutomationException
List of the descendant diagram types for the diagram type.

Product Availability

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

Specified by:
getDescendants in interface INgDiagramType
Returns:
A reference to a com.esri.arcgis.schematic.INgDiagramTypes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getParent(), INgDiagramType.getChildren(), INgDiagramType.getAncestors()

delete

public void delete(boolean deleteDescendants)
            throws IOException,
                   AutomationException
Deletes the diagram type. When setting the 'deleteDescendants' parameter to TRUE, all the diagram types that inherit from this diagram type are also deleted.

Description

Note that the TRUE value is the default value for the deleteDescendants parameter.

Product Availability

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

Specified by:
delete in interface INgDiagramType
Specified by:
delete in interface INgObjectType
Parameters:
deleteDescendants - The deleteDescendants (in, optional, pass true if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDiagramNames

public INgNames getDiagramNames()
                         throws IOException,
                                AutomationException
List of the names of the diagrams implemented by the diagram type.

Product Availability

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

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

associateElementType

public void associateElementType(INgElementType elementType)
                          throws IOException,
                                 AutomationException
Associates the 'ElementType' element type with the diagram type.

Product Availability

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

Specified by:
associateElementType in interface INgDiagramType
Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.getAssociatedElementTypes()

dissociateElementType

public void dissociateElementType(INgElementType elementType)
                           throws IOException,
                                  AutomationException
Dissociates the 'ElementType' element type with the diagram type.

Product Availability

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

Specified by:
dissociateElementType in interface INgDiagramType
Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgDiagramType.associateElementType(com.esri.arcgis.schematic.INgElementType)

isElementTypeAssociated

public boolean isElementTypeAssociated(INgElementType elementType)
                                throws IOException,
                                       AutomationException
Indicates if the 'ElementType' element type is associated with the diagram type.

Product Availability

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

Specified by:
isElementTypeAssociated in interface INgDiagramType
Parameters:
elementType - A reference to a com.esri.arcgis.schematic.INgElementType (in)
Returns:
The isAssociated
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 defined for the object type.

Description

These attributes could have been defined:

- either by calling the INgObjectType CreateAttribute method in the code

- or when its associated element type or diagram type has been created through ArcGIS Schematics Designer.

The Attributes property can returnNULL when no attribute is defined for the associated element type or diagram type.

Product Availability

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

Specified by:
getAttributes in interface INgObjectType
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.
See Also:
INgObjectType.getAttribute(String)

getAttribute

public INgAttribute getAttribute(String attributeName)
                          throws IOException,
                                 AutomationException
Returns the attibute named 'attributeName' defined for the object type.

Product Availability

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

Specified by:
getAttribute in interface INgObjectType
Parameters:
attributeName - The attributeName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createAttribute

public INgAttribute createAttribute(String attributeName,
                                    int attributeType)
                             throws IOException,
                                    AutomationException
Creates a new attribute named 'attributeName' whose type is 'attributeType' for the object type.

Product Availability

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

Specified by:
createAttribute in interface INgObjectType
Parameters:
attributeName - The attributeName (in)
attributeType - A com.esri.arcgis.schematic.esriNgAttributeType constant (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgAttribute
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgObjectType.getAttributes(), INgObjectType.getAttribute(String)

getFieldNames

public INgNames getFieldNames()
                       throws IOException,
                              AutomationException
List of the query field names used to build up each object identifier implemented by the object type.

Description

When several field names are specified, the object type identifier is obtained by concatenating all the fields in their entry sequence order (the concatenated fields are hyphenated). If one or several field names do(es) not correspond to a field returned by the query, Schematics considers the corresponding name as a character string to be concatenated with the other fields to identify the objects of this type.

If there is only one obejct of the given type, the obejct type identifier can be set to NULL

This list can be defined:
- when defining the related element type or diagram type through ArcGIS Schematics Designer,
- or by code

Product Availability

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

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

setFieldNames

public void setFieldNames(INgNames pVal)
                   throws IOException,
                          AutomationException
List of the query field names used to build up each object identifier implemented by the object type.

Product Availability

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

Specified by:
setFieldNames in interface INgObjectType
Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgNames (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSource

public INgDataSource getDataSource()
                            throws IOException,
                                   AutomationException
Data source related to the object type.

Description

This property identifies the name of the data source used to connect the database where schematic objects are stored; that is, it specifies the database related to the the query that will return all objects of this type.

This data source can have been specified:
- when defining the related element type or diagram type through ArcGIS Schematics Designer,
- or by code.

The Datasource property can also be set to NULL if no query is associated to this object type.

Product Availability

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

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

setDataSource

public void setDataSource(INgDataSource pVal)
                   throws IOException,
                          AutomationException
Data source related to the object type.

Product Availability

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

Specified by:
setDataSource in interface INgObjectType
Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgDataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryString

public String getQueryString()
                      throws IOException,
                             AutomationException
Query, name of the query, or name of the table that returns all objects of the object type.

Description

The Datasource property identifies the datasource used to connect the database the query is related to. The query can be parameterized or not. In the case of a parameterized query, the Parameters property specifies the list of the parameters.

Note: In the case of an ADO connection without parameters, Schematics considers the attributes passed to the query as being text type attributes, by default. Any non textual attribute passed as a parameter must be followed by the ':' character sign.

Product Availability

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

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

setQueryString

public void setQueryString(String pVal)
                    throws IOException,
                           AutomationException
Query, name of the query, or name of the table that returns all objects of the object type.

Product Availability

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

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

getParameters

public INgParameters getParameters()
                            throws IOException,
                                   AutomationException
List of the query parameters.

Product Availability

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

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

setParameters

public void setParameters(INgParameters pVal)
                   throws IOException,
                          AutomationException
List of the query parameters.

Product Availability

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

Specified by:
setParameters in interface INgObjectType
Parameters:
pVal - A reference to a com.esri.arcgis.schematic.INgParameters (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProject

public INgProject getProject()
                      throws IOException,
                             AutomationException
Project of the object type.

Product Availability

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

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

getUserDataValue

public Object getUserDataValue(INgUserData userData)
                        throws IOException,
                               AutomationException
Returns the value of the specified userdata defined for the object type.

Product Availability

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

Specified by:
getUserDataValue in interface INgObjectTypeDatas
Parameters:
userData - A reference to a com.esri.arcgis.schematic.INgUserData (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgObjectTypeDatas.deleteUserData(com.esri.arcgis.schematic.INgUserData), INgObjectTypeDatas.setUserDataValue(com.esri.arcgis.schematic.INgUserData, java.lang.Object)

setUserDataValue

public void setUserDataValue(INgUserData userData,
                             Object userDataValue)
                      throws IOException,
                             AutomationException
Modifies the value of the 'specified userdata defined for the object type.

Product Availability

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

Specified by:
setUserDataValue in interface INgObjectTypeDatas
Parameters:
userData - A reference to a com.esri.arcgis.schematic.INgUserData (in)
userDataValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgObjectTypeDatas.deleteUserData(com.esri.arcgis.schematic.INgUserData), INgObjectTypeDatas.getUserDataValue(com.esri.arcgis.schematic.INgUserData)

deleteUserData

public void deleteUserData(INgUserData userData)
                    throws IOException,
                           AutomationException
Delete the specified userdata defined for the object type.

Product Availability

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

Specified by:
deleteUserData in interface INgObjectTypeDatas
Parameters:
userData - A reference to a com.esri.arcgis.schematic.INgUserData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.