com.esri.arcgis.schematic
Interface INgProjectBuilder

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgProjectBuilderProxy, NgProject

public interface INgProjectBuilder
extends 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

Method Summary
 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 reloadSymbol(String symbolName)
          Reloads the symbol named 'symbolName' in the project.
 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.
 

Method Detail

getBehaviors

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

Product Availability

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

deleteProcedureSets

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.

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

replaceDataSource

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.

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

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.

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

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.

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

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.

Parameters:
symbolName - The symbolName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.