A C D E F G H I K L M N O P Q R S T U V W X

A

accept(File) - Method in interface sdmetrics.app.ExportFormatter

Test if a file is of the appropriate type based on its file extension.

accept(String) - Method in interface sdmetrics.app.ExportFormatter

Test if a file is of the appropriate type based on its file extension.

add(Object) - Method in class sdmetrics.app.TreeViewCycles.Node

Add a child node to the node.

ADDED - Static variable in class sdmetrics.app.DesignComparator

Constant indicating an added element/table row.

addListener(DiagKiviat.Listener) - Method in class sdmetrics.app.DiagKiviat

Add a listener for mouse click events on the diagram.

C

CalcRunner - class sdmetrics.app.CalcRunner.

Helper class to run a metric calculation in its own thread.

CalcRunner(Controller, ProjectSettings) - Constructor for class sdmetrics.app.CalcRunner

calculateMatrices(int, int) - Method in class sdmetrics.app.RelMatrixAdapter

Start the calculation of the relation matrices.

characters(char[], int, int) - Method in class sdmetrics.app.XMLPeeker

SAX parser handler: retrieve XMI exporter name and version from PCDATA.

characters(char[], int, int) - Method in class sdmetrics.model.XMIReader

SAX Parser handler: process PCDATA with the currently active "ctext" trigger.

characters(char[], int, int) - Method in class sdmetrics.model.MetaModel

SAX parser handler for XML PCDATA in metamodel definition file.

check(Attributes, String) - Static method in class sdmetrics.model.VersionChecker

Test the "version" attribute of an XML element.

checkFilterIdentifiers() - Method in class sdmetrics.app.RuleCheckAdapter

Check if there is an application area specified in the current rule filter that is not defined explicitely by at least one rule.

checkRules(int, int) - Method in class sdmetrics.app.RuleCheckAdapter

Start the rule checking.

CommandLineProcessor - class sdmetrics.app.CommandLineProcessor.

Class to process an SDMetrics command line, and initiate metrics calculation and data export as specified by the command line options.

CommandLineProcessor() - Constructor for class sdmetrics.app.CommandLineProcessor

compareDesigns(DataTable, DescStats, DataTable, DescStats) - Method in class sdmetrics.app.DesignComparator

Perform comparison of two designs.

CONTEXT - Static variable in class sdmetrics.model.MetaModel

The name of the attribute that stores the owner of the model element.

Controller - class sdmetrics.app.Controller.

An instance of Controller is used to start the metrics calculation and retrieve the metric data.

Controller(SDMessageHandler, AppParameters) - Constructor for class sdmetrics.app.Controller

createNewRuleCheckAdapter() - Method in class sdmetrics.app.RuleCheckAdapter

Create a new rule check adapter based on the same metrics engine.

D

DataExporter - class sdmetrics.app.DataExporter.

Class that implements the data export feature.

DataExporter(SDMessageHandler, AppParameters) - Constructor for class sdmetrics.app.DataExporter

Construct a data exporter that will overwrite existing files without prompting the user.

DataExporter(SDMessageHandler, AppParameters, OverwriteConfirmation) - Constructor for class sdmetrics.app.DataExporter

Construct a data exporter that will prompt the user before overwriting existing files.

DataTable - interface sdmetrics.app.DataTable.

This interface is used to access all kinds of measurement data (metrics, descriptive statistics, design rule violations, relation matrices).

DELETED - Static variable in class sdmetrics.app.DesignComparator

Constant indicating a deleted element/table row.

DescStats - class sdmetrics.app.DescStats.

Class to calculate and provide descriptive statistics for the metrics.

DescStats(DataTable, float[]) - Constructor for class sdmetrics.app.DescStats

DesignComparator - class sdmetrics.app.DesignComparator.

Compare the design metrics for two designs.

DesignComparator() - Constructor for class sdmetrics.app.DesignComparator

DiagHistogram - class sdmetrics.app.DiagHistogram.

Class to draw a histogram or cumulative distribution for a metric.

DiagHistogram() - Constructor for class sdmetrics.app.DiagHistogram

DiagKiviat - class sdmetrics.app.DiagKiviat.

Class to draw a kiviat diagram for a model element.

DiagKiviat.Listener - interface sdmetrics.app.DiagKiviat.Listener.

Listener for mouse events in the diagram.

DiagKiviat() - Constructor for class sdmetrics.app.DiagKiviat

doproject(ProjectSettings) - Method in class sdmetrics.app.Controller

Perform the metrics calculation: Read metamodel, XMI transformations, metric definitions, and XMI source file, calculate all metrics.

drawPercentiles(Boolean[]) - Method in class sdmetrics.app.DiagKiviat

Change the settings which percentiles to display on the kiviat diagram, and repain the graph accordingly.

E

ElementPool - class sdmetrics.model.ElementPool.

Class to store the model elements of the UML design to be analyzed.

ElementPool(MetaModel) - Constructor for class sdmetrics.model.ElementPool

ElementPoolAdapter - class sdmetrics.app.ElementPoolAdapter.

Provide a tabular view of the analyzed UML design.

ElementPoolAdapter(ElementPool, boolean) - Constructor for class sdmetrics.app.ElementPoolAdapter

elementStatus(int, int) - Method in class sdmetrics.app.DesignComparator

Return status (added/deleted/matched) of a design element.

ElementTreeNode - class sdmetrics.app.ElementTreeNode.

Tree node that represents a model element in a Swing JTree.

ElementTreeNode() - Constructor for class sdmetrics.app.ElementTreeNode

endDocument() - Method in class sdmetrics.app.XMLPeeker

SAX parser handler: end of the document.

endDocument() - Method in class sdmetrics.model.XMITransformations

SAX parser handler: At the end of the document, calculate inherited triggers for inherited metamodel element attributes.

endDocument() - Method in class sdmetrics.model.XMIReader

SAX parser handler: end of the document.

endDocument() - Method in class sdmetrics.model.MetaModel

SAX parser handler: at the end of the document, calculate the set of inherited attributes of each metamodel element.

endElement(String, String, String) - Method in class sdmetrics.app.XMLPeeker

SAX parser handler: detect end of XMI documentation.

endElement(String, String, String) - Method in class sdmetrics.model.XMITransformations

SAX parser handler: end of a xmitransformation element, store the completed XMI transformation.

endElement(String, String, String) - Method in class sdmetrics.model.XMIReader

SAX Parser handler: end of an XML element.

endRow() - Method in interface sdmetrics.app.ExportFormatter

Print formatting to end a data table row.

endTable() - Method in interface sdmetrics.app.ExportFormatter

Print formatting to end a table.

error(String) - Method in interface sdmetrics.app.SDMessageHandler

Callback method to notify calling object that processing could not be completed successfully.

exit() - Method in interface sdmetrics.app.ExportFormatter

Perform any processing after an output file has been closed.

export(DataTable, String, String, boolean, boolean, ExportFormatter) - Method in class sdmetrics.app.DataExporter

Export data tables to external file(s).

ExportFormatter - interface sdmetrics.app.ExportFormatter.

Interface to provide file format specific text markup to export measurement data tables in a particular file format.

ExportFormatterFactory - class sdmetrics.app.ExportFormatterFactory.

Object that knows all available existing file export formats by their extensions.

ExportFormatterFactory(AppParameters) - Constructor for class sdmetrics.app.ExportFormatterFactory

Constructor, all known data export formats are registered here (hard-coded).

exportGraphs(ExportGraphSettings, DataTable, DescStats, Boolean[]) - Method in class sdmetrics.app.GraphExporter

Create graph files and optionally HTML pages.

F

fids - Static variable in class sdmetrics.app.DesignComparator

First line of a element mappings file, for file identification.

fileBegin(String, PrintWriter) - Method in interface sdmetrics.app.ExportFormatter

Print formatting required at the beginning of a new file.

fileEnd() - Method in interface sdmetrics.app.ExportFormatter

Print formatting to end a file.

finishedComputation() - Method in interface sdmetrics.app.SDMessageHandler

Callback method to notify calling object when processing is complete, and the metric data etc may be obtained from the controller object.

G

genSVGCode(int, int) - Method in class sdmetrics.app.DiagKiviat

genSVGCode(int, int) - Method in class sdmetrics.app.DiagHistogram

getAcceptedElements(int) - Method in class sdmetrics.model.ElementPool

Return a list of accepted elements of a given metamodel type.

getAttributeCount(int) - Method in class sdmetrics.model.MetaModel

Retrieve the number of attributes for a metamodel element.

getAttributeDescription(int, int) - Method in class sdmetrics.model.MetaModel

Retrieve the description of an attribute for a metamodel element.

getAttributeIndex(int, String) - Method in class sdmetrics.model.MetaModel

Find the index of an attributes for a metamodel element.

getAttributeName(int, int) - Method in class sdmetrics.model.MetaModel

Retrieve the name of an attribute for a metamodel element.

getCCDataTable() - Method in class sdmetrics.app.TreeViewCC

Obtain a data table with the values of the connected component metrics for all model elements.

getCCMetricsList() - Method in class sdmetrics.app.TreeViewCC

Get the descriptions of the available connected component metrics.

getChildAt(int) - Method in class sdmetrics.app.TreeViewCycles.Node

Get a child node of this node.

getChildCount() - Method in class sdmetrics.app.TreeViewCycles.Node

Get the number of children of the node.

getColumnDescription(int, int) - Method in class sdmetrics.app.TableView

Return a description for the metric at the specified column.

getColumnDescription(int, int) - Method in class sdmetrics.app.RuleCheckAdapter

Get a description of a specific property of a violated rule.

getColumnDescription(int, int) - Method in class sdmetrics.app.RelMatrixAdapter

Returns an empty string (descriptions of target design elements in the columns not supported).

getColumnDescription(int, int) - Method in class sdmetrics.app.MeasurementCatalog

getColumnDescription(int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the description of the an attribute.

getColumnDescription(int, int) - Method in class sdmetrics.app.DesignComparator

Get the description for a metric in the table.

getColumnDescription(int, int) - Method in interface sdmetrics.app.DataTable

Return a short description of a column.

getColumnName(int, int) - Method in class sdmetrics.app.TableView

Return the name of the metric at the specified column.

getColumnName(int, int) - Method in class sdmetrics.app.RuleCheckAdapter

Get the name of a property for a specific design rule violation.

getColumnName(int, int) - Method in class sdmetrics.app.RelMatrixAdapter

Get the fully qualified name for a target element in specific column.

getColumnName(int, int) - Method in class sdmetrics.app.MeasurementCatalog

getColumnName(int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the name of the attribute in a column.

getColumnName(int, int) - Method in class sdmetrics.app.DesignComparator

Get the name of a specific metric in the table.

getColumnName(int, int) - Method in interface sdmetrics.app.DataTable

Return the name of the object a column represents (column header).

getConnCompView() - Method in class sdmetrics.app.Controller

Provide access to the connected component graph structures.

getConnectedComponents(int, int) - Method in class sdmetrics.app.TreeViewCC

Obtain a tree showing the connected components for a particual metric and element.

getCustomProjectFileConfig() - Method in class sdmetrics.app.ProjectSettings

Return the name of the custom project file configuration to use.

getCycleRuleList() - Method in class sdmetrics.app.TreeViewCycles

Get the descriptions of the available cycle rules.

getCycleTree(int, boolean) - Method in class sdmetrics.app.TreeViewCycles

Get the cycle tree for a rule.

getCycleTreeView() - Method in class sdmetrics.app.Controller

Provide access to the cycle graph structures.

getDataArray(int, int) - Method in class sdmetrics.app.DescStats

Access the numeric metric values for a metric, in ascending order.

getDataTable() - Method in class sdmetrics.app.DescStats

Get an object to access the descriptive statistics via the DataTable interface.

getDeltaDescStats() - Method in class sdmetrics.app.DesignComparator

Provide access to descriptive statistics deltas.

getDescription() - Method in interface sdmetrics.app.ExportFormatter

Get a description string of the file format.

getDescriptionHeader(int, int) - Method in class sdmetrics.app.MeasurementCatalog

Get the description header of an object in the catalog.

getDescStats() - Method in class sdmetrics.app.Controller

Provide access to the descriptive statistics.

getElements(int) - Method in class sdmetrics.model.ElementPool

Return a list of all elements of a given metamodel type.

getErrorMsg() - Method in class sdmetrics.app.XMLPeeker

Get an error message describing what error occurred parsing the XML file.

getErrorMsg() - Method in class sdmetrics.app.DesignComparator

Obtain an error description when design comparison has failed.

getExportFormatter(String) - Method in class sdmetrics.app.ExportFormatterFactory

Retrieve export formatting object for a given file extension.

getExportFormatters() - Method in class sdmetrics.app.ExportFormatterFactory

Retrieve a list of all known export formats.

getExtension() - Method in interface sdmetrics.app.ExportFormatter

Retrieve the extension for the file format.

getFilters() - Method in class sdmetrics.app.ProjectSettings

Return the list of design element filters.

getFullDescription(int, int) - Method in class sdmetrics.app.MeasurementCatalog

Get the full description of an object in the catalog.

getFullName() - Method in class sdmetrics.model.ModelElement

Return the fully qualified name of this model element.

getIndex() - Method in class sdmetrics.app.ElementTreeNode

Get the index of the model element represented by this node.

getIndexOfChild(Object) - Method in class sdmetrics.app.TreeViewCycles.Node

Get the index for a child node of this node.

getLinksIgnored() - Method in class sdmetrics.model.ModelElement

Test if cross-references to this element should be ignored according to the filter settings.

getLocatorForMatrix(String) - Method in class sdmetrics.app.MeasurementCatalog

Get the locator string for a matrix.

getLocatorForMetric(int, String) - Method in class sdmetrics.app.MeasurementCatalog

Get the locator string for a metric.

getLocatorForRule(int, String) - Method in class sdmetrics.app.MeasurementCatalog

Get the locator string for a rule.

getLog() - Method in class sdmetrics.app.Controller

Get a copy of the messages sent to the message handler during the last calculation run.

getMatrixDescription(int) - Method in class sdmetrics.app.RelMatrixAdapter

Get a description string for a matrix.

getMax(int, int) - Method in class sdmetrics.app.DescStats

Return the maximum value for a metric.

getMean(int, int) - Method in class sdmetrics.app.DescStats

Return the average value for a metric.

getMetaModel() - Method in class sdmetrics.app.ProjectSettings

Return the URI of the metamodel definition file to use.

getMetaModel() - Method in class sdmetrics.model.ElementPool

Retrieve metamodel on which this element pool is based.

getMetricCatalog() - Method in class sdmetrics.app.Controller

Provide access to the measurement catalog.

getMetricData() - Method in class sdmetrics.app.Controller

Provide access to the metric data.

getMetricName(int) - Method in class sdmetrics.app.TreeViewCC

Get the name of a connected component metric.

getMetricsFile() - Method in class sdmetrics.app.ProjectSettings

Return the URI of the metrics definition file to use.

getMetricStore() - Method in class sdmetrics.app.MeasurementCatalog

Get the metric store on which this measurement catalog is based.

getMetricType(int) - Method in class sdmetrics.app.TreeViewCC

Get the model element type for which a connected component metric is defined.

getMetricValue(int, int, int) - Method in class sdmetrics.app.TableView

Return the metric value for a particular design element and metric in a table, throwing an exception if the calculation failed.

getMin(int, int) - Method in class sdmetrics.app.DescStats

Return the minimum value for a metric.

getModel() - Method in class sdmetrics.app.Controller

Provide access to the UML model (for the "Dump UML model" feature).

getName() - Method in class sdmetrics.model.ModelElement

Get the name of this model element.

getNodeForIndex(int, int) - Method in class sdmetrics.app.TreeView

Retrieve a node for a specific model element.

getNumberOfColumns(int) - Method in class sdmetrics.app.TableView

Return the number of metrics for a table.

getNumberOfColumns(int) - Method in class sdmetrics.app.RuleCheckAdapter

The number of columns (5: name, value, category, severity, and description of the violated rule).

getNumberOfColumns(int) - Method in class sdmetrics.app.RelMatrixAdapter

Get the number of target design elements (columns) in a table.

getNumberOfColumns(int) - Method in class sdmetrics.app.MeasurementCatalog

getNumberOfColumns(int) - Method in class sdmetrics.app.ElementPoolAdapter

Return the number of attributes (columns) in a table.

getNumberOfColumns(int) - Method in class sdmetrics.app.DesignComparator

Get the number of metrics for a metric delta table.

getNumberOfColumns(int) - Method in interface sdmetrics.app.DataTable

Return the number of columns in a table.

getNumberOfElements() - Method in class sdmetrics.model.ElementPool

Get the total number of elements in the pool.

getNumberOfRows(int) - Method in class sdmetrics.app.TableView

Return the number of design elements for a table.

getNumberOfRows(int) - Method in class sdmetrics.app.RuleCheckAdapter

Get the number of design rule violations for a table.

getNumberOfRows(int) - Method in class sdmetrics.app.RelMatrixAdapter

Get the number of source design elements (rows) in a table.

getNumberOfRows(int) - Method in class sdmetrics.app.MeasurementCatalog

getNumberOfRows(int) - Method in class sdmetrics.app.ElementPoolAdapter

Return the number of model elements (rows) in a table.

getNumberOfRows(int) - Method in class sdmetrics.app.DesignComparator

Get the number of design elements (rows) on display in a specified table.

getNumberOfRows(int) - Method in interface sdmetrics.app.DataTable

Return the number of rows in a table.

getNumberOfTables() - Method in class sdmetrics.app.TableView

getNumberOfTables() - Method in class sdmetrics.app.RuleCheckAdapter

getNumberOfTables() - Method in class sdmetrics.app.RelMatrixAdapter

getNumberOfTables() - Method in class sdmetrics.app.MeasurementCatalog

getNumberOfTables() - Method in class sdmetrics.app.ElementPoolAdapter

getNumberOfTables() - Method in class sdmetrics.app.DesignComparator

getNumberOfTables() - Method in interface sdmetrics.app.DataTable

Returns the number of available tables.

getNumberOfTypes() - Method in class sdmetrics.app.TreeView

Get the number of available trees (model element types).

getNumberOfTypes() - Method in class sdmetrics.model.MetaModel

Retrieve the number of elements in the metamodel.

getNumPercentiles() - Method in class sdmetrics.app.DescStats

Retrieve the number of percentiles that are to be calculated.

getNumVal(int, int) - Method in class sdmetrics.app.DescStats

Return the number of valid numerical values for a metric.

getOwnedElements() - Method in class sdmetrics.model.ModelElement

Get the model elements owned by this element.

getOwner() - Method in class sdmetrics.model.ModelElement

Get the owner of this model element.

getPercentile(int) - Method in class sdmetrics.app.DescStats

Retrieve a particular percentile threshold.

getPercentile(int, int, int) - Method in class sdmetrics.app.DescStats

Return a percentile of the metric.

getRefAttribute(int) - Method in class sdmetrics.model.ModelElement

Retrieve the model element referenced by a cross-reference attribute.

getReferencedIds(int, int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the set of model element IDs referenced by a (multivalued) crossreference attribute.

getRelationMatrixAdapter() - Method in class sdmetrics.app.Controller

Provide access to the relation matrices.

getRelations(String) - Method in class sdmetrics.model.ModelElement

Return the set of model elements that have a certain cross-reference attribute pointing to this model element.

getRoot(int) - Method in class sdmetrics.app.TreeView

Get the root node of a specified tree.

getRow(String) - Method in class sdmetrics.app.MeasurementCatalog

Get the row number of an object specified by the locator string.

getRowName(int, int) - Method in class sdmetrics.app.TableView

Return the name of the design element at the specified row.

getRowName(int, int) - Method in class sdmetrics.app.RuleCheckAdapter

Get the fully qualified name of the violating model element in a specific row.

getRowName(int, int) - Method in class sdmetrics.app.RelMatrixAdapter

Get the fully qualified name for a source element in specific row.

getRowName(int, int) - Method in class sdmetrics.app.MeasurementCatalog

getRowName(int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the fully qualified name of a model element in a specific row.

getRowName(int, int) - Method in class sdmetrics.app.DesignComparator

Get the name of the model element at a specific row.

getRowName(int, int) - Method in interface sdmetrics.app.DataTable

Return the name of the object a row represents (row header).

getRuleCheckAdapter() - Method in class sdmetrics.app.Controller

Provide access to the design rule checker.

getRuleFilterString() - Method in class sdmetrics.app.ProjectSettings

Obtain the design rule filter string for design rule checking.

getRuleName(int) - Method in class sdmetrics.app.TreeViewCycles

Get the name of a cycle rule.

getRuleType(int) - Method in class sdmetrics.app.TreeViewCycles

Get the model element type for which a cycle rule is defined.

getRunningID() - Method in class sdmetrics.model.ModelElement

Return the running ID of the model element.

getSetAttribute(int) - Method in class sdmetrics.model.ModelElement

Retrieve the set stored by a multi-valued attribute.

getStdDev(int, int) - Method in class sdmetrics.app.DescStats

Return the standard deviation of a metric's distribution.

getSum(int, int) - Method in class sdmetrics.app.DescStats

Return the sum of metric values across all design elements for a metric.

getTable(String) - Method in class sdmetrics.app.MeasurementCatalog

Get the table with the objects that a locator refers to.

getTableName(int) - Method in class sdmetrics.app.TableView

getTableName(int) - Method in class sdmetrics.app.RuleCheckAdapter

getTableName(int) - Method in class sdmetrics.app.RelMatrixAdapter

Returns the names of a relation matrix.

getTableName(int) - Method in class sdmetrics.app.MeasurementCatalog

getTableName(int) - Method in class sdmetrics.app.ElementPoolAdapter

getTableName(int) - Method in class sdmetrics.app.DesignComparator

getTableName(int) - Method in interface sdmetrics.app.DataTable

Returns the name of a table.

getTopLevelXMLElementName() - Method in class sdmetrics.app.XMLPeeker

Get the name of the top-level XML element of the XML file.

getTreeView() - Method in class sdmetrics.app.Controller

Provide access to the UML model elements in a Swing tree.

getType() - Method in class sdmetrics.model.ModelElement

Return the ID of the metamodel element of which this element is an instance.

getTypeID(int) - Method in class sdmetrics.app.TableView

Return the metamodel type id for a table.

getTypeID(int) - Method in class sdmetrics.app.RuleCheckAdapter

getTypeID(int) - Method in class sdmetrics.app.RelMatrixAdapter

This method is not meaningful for relation matrices.

getTypeID(int) - Method in class sdmetrics.app.MeasurementCatalog

This method is not applicable for the measurement catalog.

getTypeID(int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the metamodel element type for a table.

getTypeID(int) - Method in class sdmetrics.app.DesignComparator

getTypeID(int) - Method in interface sdmetrics.app.DataTable

Return the metamodel type ID of the elements of a table.

getTypeId(String) - Method in class sdmetrics.model.MetaModel

Retrieve the ID of a metamodel element from its name.

getTypeName(int) - Method in class sdmetrics.model.MetaModel

Retrieve the name of a metamodel element from its ID.

getValueAt(int, int, int) - Method in class sdmetrics.app.TableView

Return the metric value for a particular design element and metric in a table.

getValueAt(int, int, int) - Method in class sdmetrics.app.RuleCheckAdapter

Get the value of a specific property of a violated rule.

getValueAt(int, int, int) - Method in class sdmetrics.app.RelMatrixAdapter

Get the number of relationships from a specific source element to a target element.

getValueAt(int, int, int) - Method in class sdmetrics.app.MeasurementCatalog

getValueAt(int, int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the value of an attribute for a specific model element.

getValueAt(int, int, int) - Method in class sdmetrics.app.DesignComparator

Return the metric delta for a particular design element and metric.

getValueAt(int, int, int) - Method in interface sdmetrics.app.DataTable

Return the table cell value at a particular coordinate.

getXMIExporter() - Method in class sdmetrics.app.XMLPeeker

If the XML file checked was an XMI file, get the XMI exporter that created the file.

getXMIExporterVersion() - Method in class sdmetrics.app.XMLPeeker

If the XML file checked was an XMI file, get the version number of the XMI exporter that created the file.

getXMIID() - Method in class sdmetrics.model.ModelElement

Get the XMI ID of this model element.

getXMIID(int, int) - Method in class sdmetrics.app.ElementPoolAdapter

Get the XMI ID of a model element.

getXMISource() - Method in class sdmetrics.app.ProjectSettings

Return the URI of the XMI source file to analyze.

getXMITrans() - Method in class sdmetrics.app.ProjectSettings

Return the URI of the XMI transformation file to use.

getXMIVersion() - Method in class sdmetrics.app.XMLPeeker

If the XML file checked was an XMI file, get the XMI version of the file.

getXMLAttribute(int) - Method in class sdmetrics.model.ModelElement

Retrieve the value of an attribute for this model element.

getXMLAttribute(String) - Method in class sdmetrics.model.ModelElement

Retrieve the value of an attribute for this model element.

GraphExporter - class sdmetrics.app.GraphExporter.

Class to export the JPEG, PNG, and SVG graphs and optionally create the HTML files showing the graphs.

GraphExporter(SDMessageHandler, AppParameters) - Constructor for class sdmetrics.app.GraphExporter

Construct a graph exporter that will overwrite existing files without prompting the user.

GraphExporter(SDMessageHandler, AppParameters, OverwriteConfirmation) - Constructor for class sdmetrics.app.GraphExporter

Construct a graph exporter that will prompt the user before overwriting existing files.

H

hasCycle() - Method in class sdmetrics.app.TreeViewCycles.Node

Test if this node is part of a cycle.

hasMatrices() - Method in class sdmetrics.app.RelMatrixAdapter

Check if there are relation matrices defined in the metric definition file at all.

I

inCalculation() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if links to rejected elements (not shown in the output) should be taken into account during metric calculation.

inCalculation(boolean) - Method in class sdmetrics.app.ProjectSettings

Set the flag indicating if links to rejected elements (not shown in the output) should be taken into account during metric calculation.

init(String, DataTable, boolean, OverwriteConfirmation) - Method in interface sdmetrics.app.ExportFormatter

Perform any up-front activities before the individual data files are created, such as creating an index to the files or tables.

initGrayShades(int) - Static method in class sdmetrics.app.DiagKiviat

Calculate a set of increasingly lighter shades of gray.

isFilterEnabled() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if the filter mechanism is enabled or disabled.

isMetaModelFile() - Method in class sdmetrics.app.XMLPeeker

Check if the XML file is a metamodel definition file.

isMetricDefinitionFile() - Method in class sdmetrics.app.XMLPeeker

Check if the XML file is a metric definition file.

isRefAttribute(int, int) - Method in class sdmetrics.model.MetaModel

Test if an attribute of a metamodel element is a cross-reference attribute.

isSetAttribute(int, int) - Method in class sdmetrics.model.MetaModel

Test if an attribute of a metamodel element is multi-valued.

isXMIFile() - Method in class sdmetrics.app.XMLPeeker

Check if the XML file is an XMI file.

isXMITransformationFile() - Method in class sdmetrics.app.XMLPeeker

Check if the XML file is an XMI transformation file.

K

keepMatching() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if elements matching a filter should be kept in the data output, or if only elements not matching any filters should be included in the output.

keepMatching(boolean) - Method in class sdmetrics.app.ProjectSettings

Determines which elements are to be included in the output.

L

leftMouseClicked(int, int, int) - Method in interface sdmetrics.app.DiagKiviat.Listener

Reports a "left mouse click" in the diagram.

loadFromFile(String) - Method in class sdmetrics.app.ProjectSettings

Load project settings from a file created with the SDMetrics GUI.

loadMappings(String, ArrayList, ArrayList) - Static method in class sdmetrics.app.DesignComparator

Load an element mapping file.

M

main(String[]) - Static method in class sdmetrics.SDMetrics

The main method launches the GUI if no command line arguments are specified, else the command line processor.

MeasurementCatalog - class sdmetrics.app.MeasurementCatalog.

Provide the information of the measurement catalog.

MeasurementCatalog(MetricStore) - Constructor for class sdmetrics.app.MeasurementCatalog

message(String, int) - Method in interface sdmetrics.app.SDMessageHandler

Callback method to report calculation progress messages to the user.

MetaModel - class sdmetrics.model.MetaModel.

Class to read the SDMetrics UML metamodel from the metamodel definition file, and store the model for retrieval.

MetaModel() - Constructor for class sdmetrics.model.MetaModel

ModelElement - class sdmetrics.model.ModelElement.

Represent a model element in a UML design.

ModelElement(MetaModelElement) - Constructor for class sdmetrics.model.ModelElement

N

needsCalculation() - Method in class sdmetrics.app.RelMatrixAdapter

Check if matrices still need to be calculated.

needsChecking() - Method in class sdmetrics.app.RuleCheckAdapter

Test if design rule checking is needed.

newData(DescStats, int, int) - Method in class sdmetrics.app.DiagHistogram

Register new data with this graph display.

newTable(String) - Method in interface sdmetrics.app.ExportFormatter

Print formatting required to start a new table.

O

okToOverwrite(String, boolean) - Method in interface sdmetrics.app.OverwriteConfirmation

Check if file to write exists, and ask user to confirm to overwrite.

OverwriteConfirmation - interface sdmetrics.app.OverwriteConfirmation.

Prompt user to confirm file overwrite.

P

paintComponent(Graphics) - Method in class sdmetrics.app.DiagKiviat

Draw the kiviat diagram based on the current data.

paintComponent(Graphics) - Method in class sdmetrics.app.DiagHistogram

Draw the histogram or cumulative distribution based on the current data.

peekIntoFile(String) - Method in class sdmetrics.app.XMLPeeker

Parse the head of an XML file to determine its type (XMI, metamodel definition, etc).

processCommandLine(String[]) - Method in class sdmetrics.app.CommandLineProcessor

Process the command line arguments, calculate design metrics accordingly, and export data as specified on the command line.

ProjectSettings - class sdmetrics.app.ProjectSettings.

Class to store project settings for XMI and XML source files, filter settings.

ProjectSettings() - Constructor for class sdmetrics.app.ProjectSettings

Constructor.

ProjectSettings(MyParameters) - Constructor for class sdmetrics.app.ProjectSettings

Read project settings from persistent application parameters.

Q

QualifierSep - Static variable in class sdmetrics.model.ModelElement

Seperator string used to build fully qualified element names.

R

RelMatrixAdapter - class sdmetrics.app.RelMatrixAdapter.

This class is an adapter to start the calculation of a set of relation matrices and present them via the DataTable interface.

RelMatrixAdapter(RelationMatrix) - Constructor for class sdmetrics.app.RelMatrixAdapter

reportXMIProgress(String) - Method in class sdmetrics.app.Controller

Callback function for the XMIReader to report its progress messages.

reportXMIProgress(String) - Method in interface sdmetrics.model.XMIReader.ProgressMessageHandler

Report a progress message to display to the user.

requireDesignRules() - Method in class sdmetrics.app.ProjectSettings

Request the design rules to be checked.

requireMetrics() - Method in class sdmetrics.app.ProjectSettings

Request the metrics to be pre-calculated.

requireRelMatrices() - Method in class sdmetrics.app.ProjectSettings

Request the relation matrices to be calculated.

requiresDesignRules() - Method in class sdmetrics.app.ProjectSettings

Determine if checking of design rules is required.

requiresMetrics() - Method in class sdmetrics.app.ProjectSettings

Determine if pre-calculation of metric is required.

requiresRelMatrices() - Method in class sdmetrics.app.ProjectSettings

Determine if calculation of the relation matrices is required.

resetMeasurementRequirements() - Method in class sdmetrics.app.ProjectSettings

Reset the measurement requirements.

rightMouseClicked(int, int, int) - Method in interface sdmetrics.app.DiagKiviat.Listener

Reports a "right mouse click" in the diagram.

RuleCheckAdapter - class sdmetrics.app.RuleCheckAdapter.

Class to start the rule checking and provide a tabular view of the design rule violations.

RuleCheckAdapter(RuleChecker) - Constructor for class sdmetrics.app.RuleCheckAdapter

run() - Method in class sdmetrics.app.CalcRunner

Starts the metrics calculation.

S

saveMappings(String, ArrayList, ArrayList) - Static method in class sdmetrics.app.DesignComparator

Save element mappings to a file.

saveToFile(String) - Method in class sdmetrics.app.ProjectSettings

Save project settings to a file.

SDMessageHandler - interface sdmetrics.app.SDMessageHandler.

Interface defining callback methods used to output messages about metrics calculation progress and errors, and notify the caller when calculation has completed.

sdmetrics - package sdmetrics

The top-level package only contains classes to launch the GUI, start the command line processing, or just display the help window.

SDMetrics - class sdmetrics.SDMetrics.

Provides the main method launching the application.

sdmetrics.app - package sdmetrics.app

This package contains classes to calculate a set of metrics for an XMI file, check design rules, compare two designs, calculate relation matrices, and access and export the data and graphs to external files.

sdmetrics.model - package sdmetrics.model

This package implements the UML model of SDMetrics, and provides the XMI import.

SDMetrics() - Constructor for class sdmetrics.SDMetrics

setCumulative(boolean) - Method in class sdmetrics.app.DiagHistogram

Determine whether to draw the cumulative distribution or histogram.

setDesignRuleFilter(String) - Method in class sdmetrics.app.ProjectSettings

Set the design rule filter for the design rule checking.

setFilter(String[], boolean, boolean, boolean) - Method in class sdmetrics.model.ElementPool

Apply filter settings to the elements in the pool.

setFilterEnabled(boolean) - Method in class sdmetrics.app.ProjectSettings

Set the flag indicating if the filter mechanism is enabled or disabled.

setFilters(String[]) - Method in class sdmetrics.app.ProjectSettings

Set the list of element filters to apply.

setMappings(ArrayList, ArrayList) - Method in class sdmetrics.app.DesignComparator

Set user defined element mappings to use for design comparison.

setMessageHandler(SDMessageHandler) - Method in class sdmetrics.app.RuleCheckAdapter

Register message handler for progress report.

setMessageHandler(SDMessageHandler) - Method in class sdmetrics.app.RelMatrixAdapter

Register message handler for progress report.

setMessageHandler(SDMessageHandler) - Method in class sdmetrics.app.Controller

Register a new message handler.

setMetaModel(String) - Method in class sdmetrics.app.ProjectSettings

Set the URI of the metamodel definition file to use.

setMetricsFile(String) - Method in class sdmetrics.app.ProjectSettings

Set the URI of the metrics definition file to use.

setProgressMessageHandler(XMIReader.ProgressMessageHandler) - Method in class sdmetrics.model.XMIReader

Set the message handler for the XMI reader to report progress to.

setProjectFileConfig(String) - Method in class sdmetrics.app.ProjectSettings

Set the name of the project file configuration entry to use.

setRelative(boolean) - Method in class sdmetrics.app.DesignComparator

Toggle whether to display absolute or relative metric deltas.

setRuleFilter(String) - Method in class sdmetrics.app.RuleCheckAdapter

Set the rule filter string that specifies the rules to apply.

setUseCustomProjectFiles(boolean) - Method in class sdmetrics.app.ProjectSettings

Set flag indicating if a custom project files entry should be used.

setXMIProgressHandler(SDMessageHandler) - Method in class sdmetrics.app.Controller

Register a message handler for progress messages of the XMI reader.

setXMISource(String) - Method in class sdmetrics.app.ProjectSettings

Set the URI of the XMI source file to analyze.

setXMITrans(String) - Method in class sdmetrics.app.ProjectSettings

Set the URI of the XMI transformation file to use.

showElement(DescStats, DataTable, int, int, Boolean[]) - Method in class sdmetrics.app.DiagKiviat

Draw the kiviat diagram for a model element.

startDocument() - Method in class sdmetrics.model.XMIReader

SAX Parser handler: prepare parser for new document.

startDocument() - Method in class sdmetrics.model.MetaModel

SAX parser handler: empty the metamodel at the beginning of the XML document.

startElement(String, String, String, Attributes) - Method in class sdmetrics.app.XMLPeeker

SAX parser handler: Scan XML elements for XMI header information and collect the relevant information for later retrieval.

startElement(String, String, String, Attributes) - Method in class sdmetrics.model.XMITransformations

SAX parser handler: Read the XML element in an XMI transformation file and build up the internal data structure to store XMI transformation information.

startElement(String, String, String, Attributes) - Method in class sdmetrics.model.XMIReader

SAX Parser handler: process an XML element in the XMI source file.

startElement(String, String, String, Attributes) - Method in class sdmetrics.model.MetaModel

SAX parser handler to read an XML element in the metamodel definition file.

startRow() - Method in interface sdmetrics.app.ExportFormatter

Print formatting to start a new table data row.

T

tableCell(Object) - Method in interface sdmetrics.app.ExportFormatter

Print a table data cell.

tableHeader() - Method in interface sdmetrics.app.ExportFormatter

Print formatting required to start the table header row.

tableHeaderCell(Object) - Method in interface sdmetrics.app.ExportFormatter

Print a table header cell.

TableView - class sdmetrics.app.TableView.

Class to provide a tabular view of the design measurement data.

TableView(MetricsEngine) - Constructor for class sdmetrics.app.TableView

Create a new TableView from the data provided by the Metrics engine.

TL_ELEMENT - Static variable in class sdmetrics.model.XMITransformations

The name of the top level XML element in the XMI transformation file.

TL_ELEMENT - Static variable in class sdmetrics.model.MetaModel

The name of the top level XML element in the metamodel definition file.

toString() - Method in class sdmetrics.app.TreeViewCycles.Node

toString() - Method in class sdmetrics.model.ModelElement

Return the XMI ID of the model element as its string representation.

TreeView - class sdmetrics.app.TreeView.

Class to generate a set of trees of ElementTreeNode that can be used to create a Swing JTree.

TreeView(ElementPool) - Constructor for class sdmetrics.app.TreeView

TreeViewCC - class sdmetrics.app.TreeViewCC.

Class to provide the tree representations of connected components.

TreeViewCC(MetricsEngine) - Constructor for class sdmetrics.app.TreeViewCC

Constructor.

TreeViewCycles - class sdmetrics.app.TreeViewCycles.

Class to provide the tree representations of cycles.

TreeViewCycles.Node - class sdmetrics.app.TreeViewCycles.Node.

Class to represent a node in a "cycle" tree.

TreeViewCycles.Node(String) - Constructor for class sdmetrics.app.TreeViewCycles.Node

TreeViewCycles(MetricsEngine) - Constructor for class sdmetrics.app.TreeViewCycles

Constructor.

U

UNCHANGED - Static variable in class sdmetrics.app.DesignComparator

Constant indicating matched element/table row present in both designs.

useCustomProjectFile() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if the default project file configuration

useMetaDefault() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if the default metamodel definition file should be used.

useMetaDefault(boolean) - Method in class sdmetrics.app.ProjectSettings

Set flag indicating if the default metamodel definition file should be used.

useMetricsDefault() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if the default metric definition file should be used.

useMetricsDefault(boolean) - Method in class sdmetrics.app.ProjectSettings

Set flag indicating if the default metrics definition file should be used.

useTransDefault() - Method in class sdmetrics.app.ProjectSettings

Return the flag indicating if the default XMI transformation file should be used.

useTransDefault(boolean) - Method in class sdmetrics.app.ProjectSettings

Set flag indicating if the default XMI transformation file should be used.

V

VersionChecker - class sdmetrics.model.VersionChecker.

Class to check the version attribute of an SDMetrics project file.

VersionChecker() - Constructor for class sdmetrics.model.VersionChecker

W

writeProjectSettings(MyParameters) - Method in class sdmetrics.app.ProjectSettings

Write project settings to persistent application parameters.

X

XMIReader - class sdmetrics.model.XMIReader.

Reads the XMI source file, processing it as specified by the XMI transformation file.

XMIReader.ProgressMessageHandler - interface sdmetrics.model.XMIReader.ProgressMessageHandler.

Interface with a callback method for the XMI reader to report progress to.

XMIReader(MetaModel, XMITransformations, ElementPool) - Constructor for class sdmetrics.model.XMIReader

XMITransformations - class sdmetrics.model.XMITransformations.

Reads the XMI transformation file and stores its contents, and provide access to the XMI transformations defined in the file.

XMITransformations(MetaModel) - Constructor for class sdmetrics.model.XMITransformations

XMLPeeker - class sdmetrics.app.XMLPeeker.

Peeks into an XML file to determine if it is an SDMetrics Project File, and if so, what type of file.

XMLPeeker(MyXMLParser) - Constructor for class sdmetrics.app.XMLPeeker

Initialize object, letting it use an existing XML parser.

A C D E F G H I K L M N O P Q R S T U V W X