Up Previous Next Title Page Index Contents

8.1.2 Methods

The methods and their arguments are documented in the WSDL file, which the API Tool can generate. They are listed and categorised here for convenience. First is the return value, then the command name, then the arguments (the first argument is always called 'receiver', like "this" in Java or "self" in Smalltalk).

Types, instances and strings

MEOopArray allGoodInstances (METype receiver)

Returns a set of all instances of this Graph type in currently open projects.

MEOopArray allSimilarInstances (METype receiver)

Returns a set of all instances of this Graph type or its subtypes in currently open projects.

METype subTypeNamed (METype receiver, string subTypeNamed)

Looks at subtypes of the METype receiver argument, and returns the METype of the first subtype whose name matches the wildcard string in the second argument. If none are found, returns the same METype as the receiver argument.

MEOopArray findString (MEOop receiver, string findString)

Returns the set of NonProperties from this Graph whose id property value matches the specified string, which can contain ? and * as wildcards. Case insensitive.

MEOopArray instancesNamed (METype receiver, string instancesNamed, string ofSubTypesNamed)

Returns a sorted collection of all loaded matching instances of matching types. Types may be the METype receiver argument or its subtypes. Matching is case insensitive with wildcards. Note that only graph instances in open projects are guaranteed to be loaded.

string typeName (METype receiver)

Returns the user-visible string name of the receiver argument, an METype.

METype type (MEOop receiver)

Returns an METype, the type of the receiver argument. The receiver argument must be the MEOop of a GOPRR instance.

string userPrintString (MEOop receiver)

Returns the simple string representation of the receiver argument, an MEOop representing any conceptual or representational element.

Non-Properties and Properties

MEAny valueAt (MEOop receiver, int valueAt)

Returns an MEAny representing the nth property value of the receiver argument, a NonProperty MEOop. The second argument must be an integer, starting with 1 for the first property.

MEAny setValueAt (MEOop receiver, int valueAt, MEAny put)

Sets the value of the the nth property value of the receiver argument, a NonProperty MEOop. The second argument must be an integer, starting with 1 for the first property. The third argument is an MEAny containing the value for the property. Returns an MEAny containing the MEOop of the property that was changed, or an MEAny containing an MENull if unsuccessful (e.g. if the value is not of the right type or fails the property type's regular expression rule).

MEAnyArray allPropertiesValues (MEOop receiver)

Returns an MEAnyArray of the values of the properties of the receiver argument, a NonProperty MEOop.

MEOopArray allProperties (MEOop receiver)

Returns an MEOopArray of the properties of the receiver argument, a NonProperty MEOop. (Note this returns the actual properties, not their values: if you want the values, use allPropertiesValues.) This can be useful when working with property sharing; note though that instProps requires an MEAnyArray, so each MEOop returned here would have to be wrapped in an MEAny. The method allPropertiesWrapped returns such an MEAnyArray.

MEAnyArray allPropertiesWrapped (MEOop receiver)

Returns an MEAnyArray of the properties of the receiver argument, a NonProperty MEOop. (Note this returns the actual properties, not their values.) This is useful for setting up property sharing, since instProps requires an MEAnyArray of properties. To get just the properties as an MEOopArray, use allProperties. To get just their values, use allPropertiesValues.

MEAny instProps (METype receiver, MEAnyArray propColl, MEAnyArray valueColl, MEAny np, MEAny inArea)

Creates or sets the properties of an instance of the METype argument, returning an MEAny with the MEOop of the instance, or MENull for an error. The first argument is the METype; propColl is an array of MEAnys, either MEOops of existing property instances or MENull to create a new property of the default type; valueColl is an array of MEAnys, the values of the properties; np is an MEAny, either the MEOop of an existing NonProperty of this type, or MENull to create a new one; inArea is an MEAny, either an integer corresponding to the project's area number, or MENull for the default (the same project as np if it exists already, else the current default project).

MEOop unsafeNew (METype receiver)

Create and return the MEOop of a new instance of the receiver argument, a NonProperty type METype. The result is created in the current default project. Properties are created with their default values, and the result is not checked against the metamodel rules.

Graph contents

MEOopArray objectSet (MEOop receiver)

Returns the set of all Objects in this Graph

MEOopArray relationshipSet (MEOop receiver)

Returns the set of all Relationships in this Graph.

MEOopArray roleSet (MEOop receiver)

Returns the set of all Roles in this Graph.

MEOopArray bindingSet (MEOop receiver)

Returns the set of all Binding MEOops in this Graph MEOop

Subgraphs

MEOopArray explodeGraphs (MEOop receiver)

Returns the set of Graphs that are explosions of objects in the receiver argument, a Graph MEOop.

MEOopArray decompGraphs (MEOop receiver)

Returns the set of Graphs that are decompositions of objects in the receiver argument, a Graph MEOop.

MEOopArray subgraphs (MEOop receiver)

Returns the set of Graphs that are subgraphs (i.e. either explosions or decompositions) of the receiver argument, a Graph MEOop.

MEOop addExplode (MEOop receiver, MEOop addExplode, MEOop for)

In the receiver argument, a Graph MEOop, add a new explosion to the second argument, a Graph MEOop, for the final argument, an Object MEOop.

MEOopArray getExplodeGraphsForNP (MEOop receiver, MEOop getExplodeGraphsForNP)

For this Graph and this NonProperty, returns the set of explosion subgraphs

MEOop removeExplode (MEOop receiver, MEOop removeExplode, MEOop for)

Removes the explosion link from the receiver argument, a Graph MEOop. The second argument is the target Graph MEOop of the explosion to remove. The third argument is the source Object, Role or Relationship MEOop of the explosion to remove. The result is the receiver Graph MEOop.

MEAny decompGraph (MEOop receiver)

Get the decomposition of the receiver argument, an Object MEOop. Returns an MEAny containing either a Graph MEOop or MENull.

MEAny setDecompGraph (MEOop receiver, MEAny decompGraph)

Set the decomposition of the receiver argument, an Object MEOop, to be the decompGraph argument, an MEAny containing either a Graph MEOop or MENull. Returns an MEAny containing either the receiver for success or MENull for failure.

Graph binding navigation

MEOopArray objsForObj (MEOop receiver, MEOop objsForObj, METype ofClass)

For this Graph and this Object, returns the set of Objects directly connected to it. The third argument restricts the type of the connected Objects: use NonProperty for no restriction.

MEOopArray objsForRel (MEOop receiver, MEOop objsForRel, METype ofClass)

For this Graph and this Relationship, returns the set of Objects directly connected to it. The third argument restricts the type of the connected Objects: use NonProperty for no restriction.

MEOopArray objsForRole (MEOop receiver, MEOop objsForRole, METype ofClass)

For this Graph and this Role, returns the set of Objects directly connected to it. The third argument restricts the type of the connected Objects: use NonProperty for no restriction.

MEOopArray relsForObj (MEOop receiver, MEOop relsForObj, METype ofClass)

For this Graph and this Object, returns the set of Relationships directly connected to it. The third argument restricts the type of the connected Relationships: use NonProperty for no restriction.

MEOopArray relsForRole (MEOop receiver, MEOop relsForRole, METype ofClass)

For this Graph and this Role, returns the set of Relationships directly connected to it. The third argument restricts the type of the connected Relationships: use NonProperty for no restriction.

MEOopArray rolesForObj (MEOop receiver, MEOop rolesForObj, METype ofClass)

For this Graph and this Object, returns the set of Roles directly connected to it. The third argument restricts the type of the connected Roles: use NonProperty for no restriction.

MEOopArray rolesForRel (MEOop receiver, MEOop rolesForRel, METype ofClass)

For this Graph and this Relationship, returns the set of Roles directly connected to it. The third argument restricts the type of the connected Roles: use NonProperty for no restriction.

MEOopArray rolesForRole (MEOop receiver, MEOop rolesForRole, METype ofClass)

For this Graph and this Roles, returns the set of Roles that belong to the same binding as the referred Role. The third argument restricts the type of the connected Roles: use NonProperty for no restriction.

Control

MENull open (MEOop receiver)

Opens the receiver argument in a graph representation. Will prompt with a list dialog in MetaEdit+ if there is more than one possibility.

MENull animate (MEOop receiver, MEOop animate)

Opens the specified graph and highlights the specified NonProperty. The receiver argument is the MEOop of the graph, the second is the MEOop of the NonProperty. This will never prompt.

MENull refresh (MEOop receiver)

Refreshes the display of the receiver argument, which is an MEOop of any conceptual or representational instance.

MEOopArray copiedObjects (MENull receiver)

Returns the MEOops of objects currently in the copy buffer. Bindings in the copy buffer are ignored. This is a useful way of allowing users to select an object in MetaEdit+, and have your application know which object was selected: rather than just selecting the object, they can select and copy it.

Graphs and bindings

MENull delete (MEOop receiver)

Delete the receiver argument, a Graph MEOop, and all its representations. Note this does not delete links from other graphs etc. to this graph.

MENull addToGraph (MEOop receiver, MEOop addToGraph)

Adds the receiver argument, an Object MEOop, to the second argument, a Graph MEOop. No type checking is performed.

MEOop createBinding (MEOop receiver, METype relType, METypeArray roleTypes, MEOopArray objects)

Creates a new binding into the receiver argument, a Graph MEOop. The second argument is the METype of the relationship to create. The third argument is an METypeArray of the types of Roles to create. The final argument is an MEOopArray of the existing Objects that this binding connects, in the same order as the third argument. The return value is the newly created binding MEOop.

MEOop relationship (MEOop receiver)

Returns the relationship MEOop of this binding MEOop

MEOopArray roles (MEOop receiver)

Returns an MEOopArray of the roles in this binding MEOop in order

MEOopArray objects (MEOop receiver)

Returns an MEOopArray of the objects in this binding MEOop in order

Representations and concepts

MEOopArray diagrams (MEOop receiver)

Returns an MEOopArray containing the set of diagram representations of the receiver argument, a Graph MEOop.

MEOopArray matrices (MEOop receiver)

Returns an MEOopArray containing the set of matrix representations of the receiver argument, a Graph MEOop.

MEOopArray tables (MEOop receiver)

Returns an MEOopArray containing the set of table representations of the receiver argument, a Graph MEOop.

MEOop newDiagram (MEOop receiver)

Creates a new diagram representation for the receiver argument, a Graph MEOop, and returns the MEOop for the new representation.

MEOop newMatrix (MEOop receiver)

Creates a new matrix representation for the receiver argument, a Graph MEOop, and returns the MEOop for the new representation.

MEOop newTable (MEOop receiver)

Creates a new table representation for the receiver argument, a Graph MEOop, and returns the MEOop for the new representation.

MEOop inst (MEOop receiver)

Returns the NonProperty MEOop represented by the receiver argument, an MEOop of a representation element.

MEOopArray repSet (MEOop receiver)

Returns an MEOopArray containing all representation elements of the receiver argument, a NonProperty MEOop.

MEOop reprGraph (MEOop receiver)

Returns the representation graph to which this representation element belongs. The receiver argument must be an MEOop of a representation element.

MEOop remove (MEOop receiver)

Removes the receiver argument, any representation MEOop. Returns the NonProperty MEOop the receiver used to represent.

dateTime timeStamp (MEOop receiver)

Returns the timestamp of the receiver argument, a representation graph MEOop.

MENull setTimeStamp (MEOop receiver, dateTime timeStamp)

Sets the timestamp of the receiver argument, a representation graph MEOop.

Diagram

MEOopArray objectReprs (MEOop receiver)

Returns an MEOopArray of the object representations in the receiver argument, a diagram MEOop. The result is in Z-order, backmost first.

MEOopArray bindingReprs (MEOop receiver)

Returns an MEOopArray of the binding representations in the receiver argument, a diagram MEOop. The result is in Z-order, backmost first.

MEAny grid (MEOop receiver)

Returns an MEAny containing a point specifying the size of the grid in the receiver argument, a diagram MEOop.

MENull setGrid (MEOop receiver, MEAny grid)

Sets the size of the grid in the receiver argument, a diagram MEOop. The value is an MEAny containing a point specifying the size of the grid.

boolean displayGrid (MEOop receiver)

Returns a Boolean indicating whether the grid is displayed in the receiver argument, a diagram MEOop.

MENull setDisplayGrid (MEOop receiver, boolean displayGrid)

Sets a Boolean indicating whether the grid is displayed in the receiver argument, a diagram MEOop.

boolean useGrid (MEOop receiver)

Returns a Boolean indicating whether Snap to Grid is on in the receiver argument, a diagram MEOop.

MENull setUseGrid (MEOop receiver, boolean useGrid)

Sets a Boolean indicating whether Snap to Grid is on in the receiver argument, a diagram MEOop.

MEAny place (MEOop receiver)

Returns the position of the receiver, an MEOop for an object or binding representation in a diagram argument. The result returned is an MEAny containing a point, where 1 represents 1 pixel at 100% zoom.

MENull setPlace (MEOop receiver, MEAny place)

Sets the position of the receiver argument, an MEOop for an object or binding representation in a diagram. The value is an MEAny containing a point, where 1 represents 1 pixel at 100% zoom.

MEAny scale (MEOop receiver)

Returns the scale of the receiver argument, an MEOop for an object or binding representation in a diagram. The result returned is an MEAny containing a point, where 1 represents 100%.

MENull setScale (MEOop receiver, MEAny scale)

Sets the scale of the receiver argument, an MEOop for an object or binding representation in a diagram. The value is an MEAny containing a point, where 1 represents 100%.

boolean isStraight (MEOop receiver)

Returns a Boolean indicating whether the receiver argument, a diagram binding representation MEOop, is straight.

MENull straighten (MEOop receiver)

Straightens the receiver argument, a diagram binding representation MEOop. The receiver must be a binary binding. All breakpoints and target point offsets are removed from all connection representations, and the relationship position is set to the midpoint of the role lines.

MENull layout (MEOop receiver, METype layoutRelationship, METype fromRole, METype toRole, string direction, boolean manhattan)

Creates a new diagram representation with automatic layout for the graph denoted by the first MEOop argument. The auto-layout algorithm assumes a directed acyclic graph (DAG) as its input and therefore the user must provide the API call with rules according to which the DAG is built. Therefore, the following argument, relationship, defines the relationship type which instances appear as edges in the DAG. The two following arguments, parentRole and childRole, define the directivity according to which the DAG is build. The fifth argument, direction, provides the information how the layout is distributed and can have either 'vertical' or 'horizontal' as values. The final argument, manhattan, toggles the usage of orthogonal or diagonal lines between DAG nodes.

MEOop addNewObjectRepFor (MEOop receiver, MEOop addNewObjectRepFor, int beforeIndex, MEAny place)

Adds a new object representation to the receiver argument, a diagram MEOop. The second argument is the MEOop of the object to represent. The third argument is a 1-based integer before which to insert the new binding representation in the Z-ordered collection of binding representations: 1 is the backmost element. The fourth argument is an MEAny containing the point position of the new object representation. The return value is the MEOop of the new object representation.

MEOop addNewBindingRepFor (MEOop receiver, MEOop addNewBindingRepFor, int beforeIndex, MEAny place)

Adds a new binding representation to the receiver argument, a diagram MEOop. The second argument is the MEOop of the binding to represent. The third argument is a 1-based integer before which to insert the new binding representation in the Z-ordered collection of binding representations: 1 is the backmost element. The fourth argument is an MEAny containg the point position of the relationship representation. The return value is the MEOop of the new binding representation.

MEAnyArray connectionReprIds (MEOop receiver)

Returns an MEAnyArray containing the integer ids of the connections represented in the receiver argument, a diagram binding representation MEOop.

MENull addPoint (MEOop receiver, MEAny addPoint, int index, int id)

Adds a new breakpoint to a role representation in the receiver argument, a diagram binding representation MEOop. The second argument is an MEAny containing the breakpoint coordinate. The third argument is the 1-based integer index before which to insert the new breakpoint, counting from the object. The fourth argument is the integer id of the connection within this binding.

MENull putPointAtIndex (MEOop receiver, int at, MEAny putPoint, int id)

Moves the position of a breakpoint in a role representation in the receiver argument, a diagram binding representation MEOop. The second argument is the 1-based integer index of the breakpoint, counting from the object. The third argument is an MEAny containing the new coordinate for the breakpoint. The fourth argument is the integer id of the connection within this binding.

MENull breakpoints (MEOop receiver, MEAnyArray breakpoints, int id)

Sets the breakpoints of a role representation in the receiver argument, a diagram binding representation MEOop. The second argument is an MEAnyArray containing the coordinates of the breakpoints. The third argument is the integer id of the connection within this binding.

MENull objTargetOffset (MEOop receiver, MEAny objTargetOffset, int id)

Sets the target point offset for a role representation in the receiver argument, a diagram binding representation MEOop. The second argument is an MEAny containing the offset coordinate. The third argument is the integer id of the connection within this binding.

MEAny removePoint (MEOop receiver, MEAny removePoint, int id)

Removes a breakpoint from a role representation in the receiver argument, a diagram binding representation MEOop. The second argument is an MEAny containing the breakpoint coordinate. The third argument is the integer id of the connection within this binding.

Matrix

MEOopArray hAxis (MEOop receiver)

Returns an MEOopArray of the axis elements on the horizontal axis of the receiver argument, a matrix MEOop.

MEOopArray vAxis (MEOop receiver)

Returns an MEOopArray of the axis elements on the vertical axis of the receiver argument, a matrix MEOop.

string bindSelect (MEOop receiver)

Returns the element to select from a binding for display in a cell of the receiver argument, a matrix MEOop. The result returned is a string corresponding to the choice in the View menu: firstRole for the Row Role, secondRole for the Column Role, and relationship for the Relationship.

MENull setBindSelect (MEOop receiver, string bindSelect)

Sets the element to select from a binding for display in a cell of the receiver argument, a matrix MEOop. The value is a string corresponding to the choice in the View menu: firstRole for the Row Role, secondRole for the Column Role, and relationship for the Relationship.

string cellDisplayMode (MEOop receiver)

Returns the cell display mode of the receiver argument, a matrix MEOop. The result returned is a string corresponding to the choice in the Cell menu: displayText, displaySymbol, or displayTextAndSymbol.

MENull setCellDisplayMode (MEOop receiver, string cellDisplayMode)

Sets the cell display mode of the receiver argument, a matrix MEOop. The value is a string corresponding to the choice in the Cell menu: displayText, displaySymbol, or displayTextAndSymbol.

string displayStringSelector (MEOop receiver)

Returns the cell text display function of the receiver argument, a matrix MEOop. The result returned is a string corresponding to the choice in the Cell | Text Display dialog: userPrintStringWithType, userPrintString, typeName, letter, justX.

MENull setDisplayStringSelector (MEOop receiver, string displayStringSelector)

Sets the cell text display function of the receiver argument, a matrix MEOop. The value is a string corresponding to the choice in the Cell | Text Display dialog: userPrintStringWithType, userPrintString, typeName, letter, justX.

string axisDisplayMode (MEOop receiver)

Returns the axis display mode of the receiver argument, a matrix MEOop. The result returned is a string corresponding to the choice in the Axis menu: axesDisplayText, axesDisplaySymbol, or axesDisplayTextAndSymbol.

MENull setAxisDisplayMode (MEOop receiver, string axisDisplayMode)

Sets the axis display mode of the receiver argument, a matrix MEOop. The value is a string corresponding to the choice in the Axis menu: axesDisplayText, axesDisplaySymbol, or axesDisplayTextAndSymbol.

boolean showFirst (MEOop receiver)

Returns whether the receiver argument, a matrix MEOop, only shows bindings in cells corresponding to the first role, i.e. whether the View | Directed? menu item is chosen.

MENull setShowFirst (MEOop receiver, boolean showFirst)

Sets whether the receiver argument, a matrix MEOop, only shows bindings in cells corresponding to the first role, i.e. whether the View | Directed? menu item is chosen.

int rowLabelsWidth (MEOop receiver)

Returns the width in pixels of the row labels in the receiver argument, a matrix MEOop.

MENull setRowLabelsWidth (MEOop receiver, int rowLabelsWidth)

Sets the width in pixels of the row labels in the receiver argument, a matrix MEOop.

string textStyleSymbol (MEOop receiver)

Returns the text style used by the receiver argument, a matrix MEOop. The result returned is one of the styles shown in Format | Font...

MENull setTextStyleSymbol (MEOop receiver, string textStyleSymbol)

Sets the text style used by the receiver argument, a matrix MEOop. The value is one of the styles shown in Format | Font...

MEOop addNewAxisEltFor (MEOop receiver, MEOop addNewRepFor, string toAxis, int beforeIndex)

Add to the receiver argument, a matrix MEOop, a new representation for the Object MEOop. The representation is added to the horizontal or vertical axis, depending on the toAxis argument, before the specified index (1-based). Returns the MEOop of the resulting axis element.

int getWidth (MEOop receiver)

Returns the width in pixels of the receiver argument, a matrix axis element MEOop.

MENull setWidth (MEOop receiver, int setWidth)

Sets the width in pixels of the receiver argument, a matrix axis element MEOop.

Table

METype oT (MEOop receiver)

Returns the METype of the object type whose instances are shown in the receiver argument, a table MEOop.

MEOopArray baseCollection (MEOop receiver)

Returns an MEOopArray containing the object representations in the receiver, a table MEOop.

string font (MEOop receiver)

Returns the text style used by the receiver argument, a table MEOop. The result returned is one of the styles shown in Format | Font...

MENull setFont (MEOop receiver, string font)

Sets the text style used by the receiver argument, a table MEOop. The value is one of the styles shown in Format | Font...

MEAnyArray gxlWidths (MEOop receiver)

Returns an MEAnyArray containing the column widths in pixels in the receiver, a table MEOop.

MENull setGxlWidths (MEOop receiver, MEAnyArray gxlWidths)

Sets the column widths in pixels of the receiver, a table MEOop. The value is an MEAnyArray containing either one MEAny integer, which will become the default width for all columns, or as many MEAny integers as there are properties in this table's object type.

MENull addNewTableEltFor (MEOop receiver, MEOop addNewRepFor, int beforeIndex)

Adds a new object representation to the receiver argument, a table MEOop. The second argument is the MEOop of the object to represent. The third argument is a 1-based integer index of the row before which to insert the new object representation. The return value is the MEOop of the new object representation.

Up Previous Next Title Page Index Contents