com.esri.arcgis.schematic
Class INgProjectBuilderProxy

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

public class INgProjectBuilderProxy
extends com.esri.arcgis.interop.Dispatch
implements INgProjectBuilder, Serializable

Provides access to members that control the graphic project builder.

Description

The project builder interface's members let you define your schematic application components (diagram types, element types, behaviors...).

Product Availability

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

See Also:
INgProject, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgProjectBuilderProxy()
           
  INgProjectBuilderProxy(Object obj)
           
protected INgProjectBuilderProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 INgBehavior createBehavior(String evtName, int metaType, String objectType)
          Creates the behavior to respond to the event 'evtName' on the metatype 'metaType' for the object type named 'objectType'.
 INgDiagramType createDiagramType(String diagTypeName, INgDiagramType parent)
          Creates a new diagram type named 'diagTypeName'.
 INgElementType createElementType(String eltTypeName, int type, INgElementType parent, boolean createGroup)
          Creates a new element type named 'eltTypeName' whose type is 'Type'.
 INgFlagModel createFlagModel(String flagModelName)
          Creates a new flag mode named 'flagModelName' for the project.
 INgPatternModel createPatternModel(String patternModelName, int type, String text)
          Creates a new pattern model named 'patternModelName' for the project.
 void deleteAttributeSets()
          Deletes all the attribute sets associated with the project.
 void deleteDataSources()
          Deletes all the data sources associated with the project.
 void deleteProcedureSets()
          Deletes all the procedure sets associated with the project.
 INgBehaviors getBehaviors()
          List of the behaviors defined for the project.
 INgBehaviors getBehaviors2(int metaType, String objTypeName)
          Returns the list of the behaviors defined for the metatype 'metaType'.
 void getColorIndex(short red, short green, short blue, int[] colorIndex)
          Returns the color index corresponding to the specified RGB values in the project.
 void getFontIndex(String fontName, int[] fontIndex)
          Returns the font index corresponding to font named 'fontName' in the project.
 void readExternal(ObjectInput in)
           
 void reloadSymbol(String symbolName)
          Reloads the symbol named 'symbolName' in the project.
 void removeListener(String iidStr, Object theListener)
           
 void replaceDataSource(INgDataSource oldDataSource, INgDataSource newDataSource)
          Changes the specified old datasource by the specified new datasource in the project.
 void save(String projectFilePath, String projectFileName)
          Saves all the parameters that define the project.
 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

INgProjectBuilderProxy

public INgProjectBuilderProxy()

INgProjectBuilderProxy

public INgProjectBuilderProxy(Object obj)
                       throws IOException
Throws:
IOException

INgProjectBuilderProxy

protected INgProjectBuilderProxy(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

getBehaviors

public INgBehaviors getBehaviors()
                          throws IOException,
                                 AutomationException
List of the behaviors defined for the project.

Product Availability

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

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

createFlagModel

public INgFlagModel createFlagModel(String flagModelName)
                             throws IOException,
                                    AutomationException
Creates a new flag mode named 'flagModelName' for the project.

Product Availability

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

Specified by:
createFlagModel in interface INgProjectBuilder
Parameters:
flagModelName - The flagModelName (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgFlagModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getFlagModels()

createPatternModel

public INgPatternModel createPatternModel(String patternModelName,
                                          int type,
                                          String text)
                                   throws IOException,
                                          AutomationException
Creates a new pattern model named 'patternModelName' for the project. The 'type' parameter specifies the pattern type (see esriNgPatternType).

Product Availability

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

Specified by:
createPatternModel in interface INgProjectBuilder
Parameters:
patternModelName - The patternModelName (in)
type - A com.esri.arcgis.schematic.esriNgPatternType constant (in)
text - The text (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgPatternModel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getPatternModels()

createElementType

public INgElementType createElementType(String eltTypeName,
                                        int type,
                                        INgElementType parent,
                                        boolean createGroup)
                                 throws IOException,
                                        AutomationException
Creates a new element type named 'eltTypeName' whose type is 'Type'.

Description

This element type can inherit the ‘parent’ element type (optional parameter). The createGroup parameter specifies if the associated element group must be created or not. The default value for the createGroup parameter is True; that is by default, all newly created element type is directly related to its own graphic group.

Product Availability

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

Specified by:
createElementType in interface INgProjectBuilder
Parameters:
eltTypeName - The eltTypeName (in)
type - A com.esri.arcgis.schematic.esriNgElementTypeEnum constant (in)
parent - A reference to a com.esri.arcgis.schematic.INgElementType (in, optional, pass 0 if not required)
createGroup - The createGroup (in, optional, pass true if not required)
Returns:
A reference to a com.esri.arcgis.schematic.INgElementType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.getElementTypes()

createDiagramType

public INgDiagramType createDiagramType(String diagTypeName,
                                        INgDiagramType parent)
                                 throws IOException,
                                        AutomationException
Creates a new diagram type named 'diagTypeName'. This new diagram type can inherit from an existing 'parent' diagram type.

Product Availability

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

Specified by:
createDiagramType in interface INgProjectBuilder
Parameters:
diagTypeName - The diagTypeName (in)
parent - A reference to a com.esri.arcgis.schematic.INgDiagramType (in, optional, pass 0 if not required)
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:
INgProject.getDiagramTypes()

createBehavior

public INgBehavior createBehavior(String evtName,
                                  int metaType,
                                  String objectType)
                           throws IOException,
                                  AutomationException
Creates the behavior to respond to the event 'evtName' on the metatype 'metaType' for the object type named 'objectType'.

Product Availability

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

Specified by:
createBehavior in interface INgProjectBuilder
Parameters:
evtName - The evtName (in)
metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)
objectType - The objectType (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgBehavior
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectBuilder.getBehaviors()

save

public void save(String projectFilePath,
                 String projectFileName)
          throws IOException,
                 AutomationException
Saves all the parameters that define the project.

Description

The parameters projectFilePath and projectFileName are optional. By default if they are not specified, Schematics overwrites the current session's parameters file.

Note that the specified projectFilePath must already exist because Schematics does not create nonexistent folders.

Product Availability

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

Specified by:
save in interface INgProjectBuilder
Parameters:
projectFilePath - The projectFilePath (in, optional, pass if not required)
projectFileName - The projectFileName (in, optional, pass if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBehaviors2

public INgBehaviors getBehaviors2(int metaType,
                                  String objTypeName)
                           throws IOException,
                                  AutomationException
Returns the list of the behaviors defined for the metatype 'metaType'. To obtain the list of the behaviors defined for a given object type only, specify the name of that object type using the 'objTypeName' parameter.

Product Availability

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

Specified by:
getBehaviors2 in interface INgProjectBuilder
Parameters:
metaType - A com.esri.arcgis.schematic.esriNgMetaType constant (in)
objTypeName - The objTypeName (in, optional, pass if not required)
Returns:
A reference to a com.esri.arcgis.schematic.INgBehaviors
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteDataSources

public void deleteDataSources()
                       throws IOException,
                              AutomationException
Deletes all the data sources associated with the project.

Product Availability

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

Specified by:
deleteDataSources in interface INgProjectBuilder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProjectBuilder.replaceDataSource(com.esri.arcgis.schematic.INgDataSource, com.esri.arcgis.schematic.INgDataSource), INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource)

deleteAttributeSets

public void deleteAttributeSets()
                         throws IOException,
                                AutomationException
Deletes all the attribute sets associated with the project.

Product Availability

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

Specified by:
deleteAttributeSets in interface INgProjectBuilder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.addUserAttributes(java.lang.Object, String)

deleteProcedureSets

public void deleteProcedureSets()
                         throws IOException,
                                AutomationException
Deletes all the procedure sets associated with the project.

Product Availability

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

Specified by:
deleteProcedureSets in interface INgProjectBuilder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgProject.addUserProcedures(java.lang.Object, String)

replaceDataSource

public void replaceDataSource(INgDataSource oldDataSource,
                              INgDataSource newDataSource)
                       throws IOException,
                              AutomationException
Changes the specified old datasource by the specified new datasource in the project.

Product Availability

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

Specified by:
replaceDataSource in interface INgProjectBuilder
Parameters:
oldDataSource - A reference to a com.esri.arcgis.schematic.INgDataSource (in)
newDataSource - 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.
See Also:
INgProjectBuilder.deleteDataSources(), INgProject.addDataSource(com.esri.arcgis.schematic.INgDataSource)

getColorIndex

public void getColorIndex(short red,
                          short green,
                          short blue,
                          int[] colorIndex)
                   throws IOException,
                          AutomationException
Returns the color index corresponding to the specified RGB values in the project.

Product Availability

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

Specified by:
getColorIndex in interface INgProjectBuilder
Parameters:
red - The red (in)
green - The green (in)
blue - The blue (in)
colorIndex - The colorIndex (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontIndex

public void getFontIndex(String fontName,
                         int[] fontIndex)
                  throws IOException,
                         AutomationException
Returns the font index corresponding to font named 'fontName' in the project.

Product Availability

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

Specified by:
getFontIndex in interface INgProjectBuilder
Parameters:
fontName - The fontName (in)
fontIndex - The fontIndex (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reloadSymbol

public void reloadSymbol(String symbolName)
                  throws IOException,
                         AutomationException
Reloads the symbol named 'symbolName' in the project.

Product Availability

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

Specified by:
reloadSymbol in interface INgProjectBuilder
Parameters:
symbolName - The symbolName (in)
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