com.esri.arcgis.schematic
Class INgObjectTypeProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.INgObjectTypeProxy
All Implemented Interfaces:
INgObjectType, Externalizable, Serializable

public class INgObjectTypeProxy
extends com.esri.arcgis.interop.Dispatch
implements INgObjectType, Serializable

Provides access to members that control the object type.

Description

The object type is a meta type object you have to use to create an element type or a diagram type by code, and set their primary parameters definition.

Product Availability

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

See Also:
INgDiagramType, INgElementType, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgObjectTypeProxy()
           
  INgObjectTypeProxy(Object obj)
           
protected INgObjectTypeProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 object 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.
 INgDataSource getDataSource()
          Data source related to the object 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 object type.
 INgParameters getParameters()
          List of the query parameters.
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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 object type.
 void setParameters(INgParameters pVal)
          List of the query parameters.
 void setQueryString(String pVal)
          Query, name of the query, or name of the table that returns all objects of the object type.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

INgObjectTypeProxy

public INgObjectTypeProxy()

INgObjectTypeProxy

public INgObjectTypeProxy(Object obj)
                   throws IOException
Throws:
IOException

INgObjectTypeProxy

protected INgObjectTypeProxy(Object obj,
                             String iid)
                      throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the object type.

Description

The Name property identifies the type of the associated diagram type or of the associated element type. It must be a unique name. Generally, this property is defined:

- either at the time the associated element type or diagram type is defined with ArcGIS Schematics Designer,

- or by programming when creating a new type of element or a new type of diagram using the CreateElementType or CreateDiagramType methods.

Product Availability

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

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 object type.

Product Availability

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

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.

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.

delete

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

Product Availability

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

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.

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException