www.sdmetrics.com
A B C D E F G H I L M N O P R S T V X

A

AbstractProcedure - Class in com.sdmetrics.metrics
Base class for metric, set, and rule procedures as well as scalar, boolean, and set operations.
AbstractProcedure() - Constructor for class com.sdmetrics.metrics.AbstractProcedure
 
accept(String) - Method in class com.sdmetrics.output.ExportFormatter
Tests whether a file name matches this format's extension.
accept(File) - Method in class com.sdmetrics.output.ExportFormatter
Tests whether the name of a file matches this format's extension.
add(E) - Method in class com.sdmetrics.math.HashMultiSet
Adds the specified element to this set.
add(ModelElement, Variables) - Method in class com.sdmetrics.metrics.SetSummationHelper
Processes the cumulative or valueset expression for a model element and adds its contents to the result set.
add(Collection<?>) - Method in class com.sdmetrics.metrics.SetSummationHelper
Adds the contents of a collection to the result set.
add(ModelElement, Variables) - Method in class com.sdmetrics.metrics.SummationHelper
Processes the "sum" and "stat" attributes for a model element and updates the total accordingly.
add(float) - Method in class com.sdmetrics.metrics.SummationHelper
Adds a value to the current total.
applyFilters(ModelElement, ModelElement, Variables) - Method in class com.sdmetrics.metrics.FilterAttributeProcessor
Applies the filter attributes to a candidate element.
attributes - Variable in class com.sdmetrics.metrics.MetricEntry
Attributes of the calculation procedure for the entry.

B

BASE_ELEMENT - Static variable in class com.sdmetrics.model.MetaModel
The name of the base element type.
BooleanOperation - Class in com.sdmetrics.metrics
Base class for Boolean operations in expressions.
BooleanOperation() - Constructor for class com.sdmetrics.metrics.BooleanOperation
 

C

calculate(Matrix) - Method in class com.sdmetrics.metrics.MatrixEngine
Calculates a relation matrix.
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedure
Calculates the metric procedure.
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureAttributeValue
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureCompare
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureCompound
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureConnectedComponents
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureCount
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureFilterValue
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureNesting
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureProjection
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureSetOperation
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureSignature
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureSubelements
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureSubString
 
calculate(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureValuesetOperation
 
calculate(ModelElement, Set) - Method in class com.sdmetrics.metrics.SetProcedure
Calculates the set procedure.
calculate(ModelElement, Set) - Method in class com.sdmetrics.metrics.SetProcedureCompare
 
calculate(ModelElement, Set) - Method in class com.sdmetrics.metrics.SetProcedureCompound
 
calculate(ModelElement, Set) - Method in class com.sdmetrics.metrics.SetProcedureProjection
 
calculate(ModelElement, Set) - Method in class com.sdmetrics.metrics.SetProcedureSubelements
 
calculateConnectedComponents(StronglyConnectedComponents.Graph<T>, int, boolean) - Method in class com.sdmetrics.metrics.StronglyConnectedComponents
Calculates the strongly connected components for a graph.
calculateMatrices(MessageHandler, int, int) - Method in class com.sdmetrics.app.RelationMatrices
Calculates all relation matrices, reports any errors.
calculateValue(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.BooleanOperation
Calculates the value for the Boolean operation.
calculateValue(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.ScalarOperation
Calculates the value for the scalar operation.
calculateValue(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.SetOperation
Calculates the value for the set operations.
ChangeDirectionsAdapter<T> - Class in com.sdmetrics.metrics
Constructs a new graph from an existing one, reversing or removing the directions of the edges.
ChangeDirectionsAdapter(StronglyConnectedComponents.Graph<T>, boolean) - Constructor for class com.sdmetrics.metrics.ChangeDirectionsAdapter
 
characters(char[], int, int) - Method in class com.sdmetrics.model.XMIReader
Processes text between XML element tags.
checkFilterIdentifiers() - Method in class com.sdmetrics.app.RuleData
Checks the application areas of the rule filter for plausibility.
checkIdentifiers(MetricStore) - Method in class com.sdmetrics.metrics.RuleFilter
Checks the identifiers of the rule filter for plausibility.
checkRule(ModelElement, Rule) - Method in class com.sdmetrics.metrics.RuleEngine
Checks a design rule for a model element.
checkRule(ModelElement, Rule) - Method in class com.sdmetrics.metrics.RuleProcedure
Checks the rule for a model element.
checkRule(ModelElement, Rule) - Method in class com.sdmetrics.metrics.RuleProcedureCycle
 
checkRule(ModelElement, Rule) - Method in class com.sdmetrics.metrics.RuleProcedureSet
 
checkRule(ModelElement, Rule) - Method in class com.sdmetrics.metrics.RuleProcedureViolation
 
checkRules(MessageHandler, int, int) - Method in class com.sdmetrics.app.RuleData
Checks all design rules, reports any errors.
checkVersion(Attributes, String) - Method in class com.sdmetrics.util.SAXHandler
Tests if the indicated "version" number in an XML document is still supported.
clear() - Method in class com.sdmetrics.math.HashMultiSet
Removes all occurrences of all elements from this set.
clearValuesCache() - Method in class com.sdmetrics.metrics.RuleEngine
Clears the value cache for rule procedures.
collectExemptedRules(ModelElement) - Method in class com.sdmetrics.metrics.RuleEngine
Gets the names of the rules that a model element is allowed to violate.
com.sdmetrics.app - package com.sdmetrics.app
Supports the integration of SDMetrics' measurement capabilities into applications.
com.sdmetrics.cmdline - package com.sdmetrics.cmdline
Provides a simple command line tool for SDMetrics' core functionality.
com.sdmetrics.math - package com.sdmetrics.math
Hosts the expression parser for metric, set, and condition expressions, and some specialized container classes.
com.sdmetrics.metrics - package com.sdmetrics.metrics
Provides the core functionality of SDMetrics: calculating metrics, checking design rules.
com.sdmetrics.model - package com.sdmetrics.model
Provides the XMI import of UML models and access to the elements of the imported model.
com.sdmetrics.output - package com.sdmetrics.output
Provides data export to text files, HTML files, Excel, and OpenDocument Spreadsheets.
com.sdmetrics.util - package com.sdmetrics.util
Package with some general utility classes to provide simple XML parsing and version information.
config - Variable in class com.sdmetrics.output.ExportFormatter
The configuration parameters for this data export.
ConsoleMessageHandler - Class in com.sdmetrics.app
Message handler for console-based applications.
ConsoleMessageHandler() - Constructor for class com.sdmetrics.app.ConsoleMessageHandler
Creates a new handler that writes to the "standard out" and "standard err" streams of the process.
ConsoleMessageHandler(PrintStream) - Constructor for class com.sdmetrics.app.ConsoleMessageHandler
Creates a message handler writing all messages to a single stream.
ConsoleMessageHandler(PrintStream, PrintStream) - Constructor for class com.sdmetrics.app.ConsoleMessageHandler
Creates a message handler writing progress and error messages to separate streams.
contains(Object) - Method in class com.sdmetrics.math.HashMultiSet
Returns true if this set contains the specified element at least once.
COPYRIGHT - Static variable in class com.sdmetrics.util.VersionInfo
Copyright string, using unicode characters.
COPYRIGHTASCII - Static variable in class com.sdmetrics.util.VersionInfo
Copyright string, using only ASCII characters.
CoreCommandLineProcessor - Class in com.sdmetrics.cmdline
Processes the SDMetrics core command line, and initiates metrics calculation and data export as specified by the command line options.
CoreCommandLineProcessor() - Constructor for class com.sdmetrics.cmdline.CoreCommandLineProcessor
 
createHashSet(boolean) - Static method in class com.sdmetrics.metrics.MetricTools
Creates a new empty set or multiset.
createHashSet(boolean, Collection<?>) - Static method in class com.sdmetrics.metrics.MetricTools
Creates a new set or multiset with initial contents.
createOutputFile(String) - Method in class com.sdmetrics.output.ExportFormatter
Creates an output file with the configured encoding.

D

DataExportConfiguration - Class in com.sdmetrics.output
Encapsulates the output configuration settings for data export.
DataExportConfiguration() - Constructor for class com.sdmetrics.output.DataExportConfiguration
Constructs a default configuration, Uses the VMs default character encoding, unsanitized output into a single file, overwrites files without asking.
DataExportConfiguration.QuotingStrategy - Enum in com.sdmetrics.output
Enumerates the quoting strategies for text-based output file formats such as CSV.
DataExporter - Class in com.sdmetrics.output
Exports tabular data in various formats.
DataExporter(MessageHandler, DataExportConfiguration) - Constructor for class com.sdmetrics.output.DataExporter
 
DataTables - Interface in com.sdmetrics.app
Interface to access all kinds of measurement data (metrics, rule violations, relation matrices) in a tabular form.
description - Variable in class com.sdmetrics.metrics.MetricEntry
Description of the entry.
DescriptionLocator - Enum in com.sdmetrics.metrics
Enumerates the locators for metrics, rules, and so forth in descriptions in the metric definition files.

E

elementCount(Collection<?>, Object) - Static method in class com.sdmetrics.metrics.MetricTools
Counts the number of occurrences of an element in a set or multiset.
ElementGraph - Class in com.sdmetrics.metrics
A graph consisting of model elements.
ElementGraph(MetricsEngine, Collection<ModelElement>, ExpressionNode, Variables) - Constructor for class com.sdmetrics.metrics.ElementGraph
 
endDocument() - Method in class com.sdmetrics.model.XMIReader
Performs the post-processing after the entire XMI file has been read.
endElement(String, String, String) - Method in class com.sdmetrics.model.XMIReader
Processes the closing tag of an XML element.
endRow() - Method in class com.sdmetrics.output.ExportFormatter
Prints the formatting to end a table row.
endTable() - Method in class com.sdmetrics.output.ExportFormatter
Prints the formatting to end a table.
equals(Object) - Method in class com.sdmetrics.math.HashMultiSet
Compares the specified object with this set for equality.
err - Variable in class com.sdmetrics.app.ConsoleMessageHandler
Print stream for error messages.
evalBooleanExpression(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.AbstractProcedure
Calculates the value of a boolean expression for a model element.
evalElementSetExpression(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.AbstractProcedure
Calculates a set expression that returns a set of model elements.
evalExpression(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.AbstractProcedure
Calculates the value of a metric expression for a model element.
evalSetExpression(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.AbstractProcedure
Calculates a set expression for a model element.
excludeSelf(ModelElement) - Method in class com.sdmetrics.metrics.SetSummationHelper
Removes a model element from the result set if the "exclude_self" attribute is set to true.
exit(String) - Method in class com.sdmetrics.output.ExportFormatter
Performs any processing after an output file has been closed.
export(DataTables, String, ExportFormatter) - Method in class com.sdmetrics.output.DataExporter
Writes data tables to external file(s).
ExportFormatter - Class in com.sdmetrics.output
Base class for data export formatters.
ExportFormatter() - Constructor for class com.sdmetrics.output.ExportFormatter
 
ExportFormatterFactory - Class in com.sdmetrics.output
Knows all available file export formats by their extensions and creates formatters for them.
ExportFormatterFactory() - Constructor for class com.sdmetrics.output.ExportFormatterFactory
 
ExpressionNode - Class in com.sdmetrics.math
Represents a node in the operator tree for a math expression.
ExpressionNode(String) - Constructor for class com.sdmetrics.math.ExpressionNode
Creates a new node representing an identifier.
ExpressionParser - Class in com.sdmetrics.math
Parses metric, set, and condition expressions.
ExpressionParser() - Constructor for class com.sdmetrics.math.ExpressionParser
Creates a new parser instance without custom functions and relations.
ExpressionParser(Set<String>, Set<String>, Set<String>) - Constructor for class com.sdmetrics.math.ExpressionParser
Creates a new parser instance with custom functions and relations.

F

fileBegin(String) - Method in class com.sdmetrics.output.ExportFormatter
Prints formatting required at the beginning of a new file.
fileEnd() - Method in class com.sdmetrics.output.ExportFormatter
Prints the formatting to end a file.
FilterAttributeProcessor - Class in com.sdmetrics.metrics
Processes the standard filter attributes for individual model elements or entire sets.
FilterAttributeProcessor(MetricsEngine, ProcedureAttributes) - Constructor for class com.sdmetrics.metrics.FilterAttributeProcessor
 
finishedComputation() - Method in class com.sdmetrics.app.MessageHandler
Notifies the owner of handler that the operation has completed successfully.
flatSetSize() - Method in class com.sdmetrics.math.HashMultiSet
Gets the number of distinct elements in this set, ignoring the cardinality of the elements.
formatValue(Object) - Method in class com.sdmetrics.output.ExportFormatter
Formats a table cell value.
fullIteration(Collection<ModelElement>, Variables) - Method in class com.sdmetrics.metrics.FilterAttributeProcessor
Applies element filters and filter attributes to an element set and returns an iteration over the resulting elements.

G

get(int, int) - Method in class com.sdmetrics.math.IntegerMatrix
Retrieves the integer at the given coordinates.
getAcceptedElements(MetaModelElement) - Method in class com.sdmetrics.model.Model
Returns the list of accepted elements of a given type.
getApplicableAreas() - Method in class com.sdmetrics.metrics.Rule
Gets the application areas of the rule.
getAttributeDescription(String) - Method in class com.sdmetrics.model.MetaModelElement
Gets the description of an attribute.
getAttributeNames() - Method in class com.sdmetrics.model.MetaModelElement
Gets the attribute names of the metamodel element.
getAttributes() - Method in class com.sdmetrics.metrics.MetricEntry
Gets the calculation procedure attributes for this entry.
getBooleanValue(String, boolean) - Method in class com.sdmetrics.metrics.ProcedureAttributes
Retrieves the value of a boolean attribute.
getBriefDescription() - Method in class com.sdmetrics.metrics.MetricEntry
Gets the brief description for this entry.
getCategory() - Method in class com.sdmetrics.metrics.Metric
Gets the category (structural property) measured by the metric.
getCategory() - Method in class com.sdmetrics.metrics.Rule
Gets the category of this rule.
getColumnCondition() - Method in class com.sdmetrics.metrics.Matrix
Gets the condition expression for column elements to be included in the matrix.
getColumnDescription(int, int) - Method in interface com.sdmetrics.app.DataTables
Returns a short description of a column.
getColumnDescription(int, int) - Method in class com.sdmetrics.app.MetricData
Returns a description for the metric at the specified column.
getColumnDescription(int, int) - Method in class com.sdmetrics.app.ModelData
Gets the description of an attribute in a column.
getColumnDescription(int, int) - Method in class com.sdmetrics.app.RelationMatrices
 
getColumnDescription(int, int) - Method in class com.sdmetrics.app.RuleData
 
getColumnElement(int) - Method in class com.sdmetrics.metrics.MatrixData
Gets the target model element in a column of this relation matrix.
getColumnName(int, int) - Method in interface com.sdmetrics.app.DataTables
Returns the name of the object a column represents (column header).
getColumnName(int, int) - Method in class com.sdmetrics.app.MetricData
Returns the name of the metric at the specified column.
getColumnName(int, int) - Method in class com.sdmetrics.app.ModelData
Gets the name of the attribute in a column.
getColumnName(int, int) - Method in class com.sdmetrics.app.RelationMatrices
Gets the name of a target element in specific column.
getColumnName(int, int) - Method in class com.sdmetrics.app.RuleData
 
getColumnType() - Method in class com.sdmetrics.metrics.Matrix
Retrieves the element type of the target elements (columns).
getComparator() - Static method in class com.sdmetrics.model.ModelElement
Returns a comparator to sort model elements by the order in which they are defined in the XMI file.
getConnectedComponent(int) - Method in class com.sdmetrics.metrics.StronglyConnectedComponents
Gets the node set for a strongly connected component.
getConnectedComponentCount() - Method in class com.sdmetrics.metrics.StronglyConnectedComponents
Gets the number of strongly connected components found.
getConnectedComponents(MetricsEngine, ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricProcedureConnectedComponents
Calculates the connected components for a model element.
getCriticality() - Method in class com.sdmetrics.metrics.Rule
Gets the criticality of this rule.
getDescription() - Method in class com.sdmetrics.output.ExportFormatter
Gets a description string for this format.
getElement() - Method in exception com.sdmetrics.metrics.SDMetricsException
Gets the model element that caused the problem.
getElementCount(Object) - Method in class com.sdmetrics.math.HashMultiSet
Retrieves the cardinality of an element in this set.
getElements(MetaModelElement) - Method in class com.sdmetrics.model.Model
Returns the list of all elements of a given type.
getErrorInfo() - Method in class com.sdmetrics.math.ExpressionParser
Retrieves a string describing the syntax error that occurred during expression parsing.
getErrorMessage() - Method in class com.sdmetrics.util.XMLParser
Gets an enhanced error message when parsing of a file failed.
getErrorMessageText(List<Problem>, boolean) - Static method in class com.sdmetrics.app.ConsoleMessageHandler
Creates an error report for a list of problems.
getExportFormats() - Static method in class com.sdmetrics.output.ExportFormatterFactory
Retrieves the file extension names of all available export formats.
getExpression(String) - Method in class com.sdmetrics.metrics.ProcedureAttributes
Retrieves the operator tree for an optional attribute holding an expression.
getExtension() - Method in class com.sdmetrics.output.ExportFormatter
Gets the file extension for this format.
getExtensionReference() - Method in class com.sdmetrics.model.MetaModelElement
Gets the name of the extension reference attribute.
getFilterAttributeProcessor(ProcedureAttributes) - Method in class com.sdmetrics.metrics.AbstractProcedure
Creates a new filter attribute processing object.
getFlatIterator() - Method in class com.sdmetrics.math.HashMultiSet
Returns an iterator over the elements in the set, ignoring the cardinality.
getFlatIterator(Collection<T>) - Static method in class com.sdmetrics.metrics.MetricTools
Obtains an iterator over the unique elements of a set or multiset.
getFloatValue(ModelElement, ExpressionNode, Variables) - Method in class com.sdmetrics.metrics.ScalarOperation
Evaluates an expression that yields a float value.
getFloatValue(Object, ModelElement) - Method in class com.sdmetrics.metrics.ScalarOperation
Converts a number value to float.
getFormatter(String) - Static method in class com.sdmetrics.output.ExportFormatterFactory
Creates an export formatter for a given file extension.
getFullDescription() - Method in class com.sdmetrics.metrics.MetricEntry
Gets the full description for this entry.
getFullName() - Method in class com.sdmetrics.model.ModelElement
Gets the fully qualified name of this model element.
getGlossary() - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all glossary terms defined in the metric definition file.
getIndexFor(T) - Method in class com.sdmetrics.metrics.StronglyConnectedComponents
Gets the index of the strongly connected component of a node.
getLeftNode() - Method in class com.sdmetrics.math.ExpressionNode
Retrieves the node representing the left hand side of a binary operation, or the operand of a unary operation.
getLinksIgnored() - Method in class com.sdmetrics.model.ModelElement
Tests whether cross-references to this element should be ignored according to the element filter settings.
getLiteratureReferences() - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all literature references defined in the metric definition file.
getLocation() - Method in class com.sdmetrics.metrics.MetricEntry
Gets the line number of this entry in the metric definition file.
getMatrices() - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all relationship matrices defined in the metric definition file.
getMatrixDefinition() - Method in class com.sdmetrics.metrics.MatrixData
Gets the definition of the matrix.
getMessage() - Method in class com.sdmetrics.app.Problem
Gets the message of the problem.
getMetaModel() - Method in class com.sdmetrics.metrics.AbstractProcedure
Gets the metamodel for which this calculation takes place.
getMetaModel() - Method in class com.sdmetrics.metrics.MetricsEngine
Retrieves the metamodel on which this metrics engine is based.
getMetaModel() - Method in class com.sdmetrics.metrics.MetricStore
Gets the metamodel on which the metrics are based
getMetaModel() - Method in class com.sdmetrics.model.Model
Retrieves the metamodel on which this model is based.
getMetric(MetaModelElement, String) - Method in class com.sdmetrics.metrics.MetricStore
Gets the metric for a given element type by its name.
getMetricEntry() - Method in exception com.sdmetrics.metrics.SDMetricsException
Gets the metric, set, rule, or matrix that caused the problem.
getMetrics(MetaModelElement) - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all metrics for a given element type.
getMetricsEngine() - Method in class com.sdmetrics.metrics.AbstractProcedure
Gets the metrics engine to use for calculations.
getMetricsEngine() - Method in class com.sdmetrics.metrics.MatrixEngine
Returns the metrics engine that this matrix engine uses.
getMetricsEngine() - Method in class com.sdmetrics.metrics.RuleEngine
Returns the metrics engine that this rule engine uses.
getMetricStore() - Method in class com.sdmetrics.metrics.MetricsEngine
Retrieves the metric definitions used by this metrics engine.
getMetricValue(int, int, int) - Method in class com.sdmetrics.app.MetricData
Returns the metric value for a particular design element and metric in a table, throwing an exception if the calculation failed.
getMetricValue(ModelElement, Metric) - Method in class com.sdmetrics.metrics.MetricsEngine
Retrieves the value of a metric for a model element.
getMinExpressionValue(ModelElement, ProcedureAttributes, String, Variables) - Method in class com.sdmetrics.metrics.RuleProcedure
Evaluates the "minnodes" or "mincnt" expression of a rule.
getModel() - Method in class com.sdmetrics.metrics.AbstractProcedure
Gets the model for which this calculation takes place.
getModel() - Method in class com.sdmetrics.metrics.MetricsEngine
Retrieves the model on which this metrics engine operates.
getModelElement() - Method in class com.sdmetrics.metrics.RuleViolation
Gets the model element of this rule violation.
getName() - Method in class com.sdmetrics.metrics.MetricEntry
Retrieves the name of the entry.
getName() - Method in class com.sdmetrics.model.MetaModelElement
Gets the name of this element type.
getName() - Method in class com.sdmetrics.model.ModelElement
Gets the name of this model element.
getNeighbors(T) - Method in class com.sdmetrics.metrics.ChangeDirectionsAdapter
 
getNeighbors(ModelElement) - Method in class com.sdmetrics.metrics.ElementGraph
 
getNeighbors(T) - Method in interface com.sdmetrics.metrics.StronglyConnectedComponents.Graph
Obtains, for a node, the set of nodes to which it has an outgoing edge.
getNodes() - Method in class com.sdmetrics.metrics.ChangeDirectionsAdapter
 
getNodes() - Method in class com.sdmetrics.metrics.ElementGraph
 
getNodes() - Method in interface com.sdmetrics.metrics.StronglyConnectedComponents.Graph
Retrieves the set of nodes of the graph.
getNumber(float) - Static method in class com.sdmetrics.metrics.MetricTools
Optimizes a float return value for a metric.
getNumberOfColumns(int) - Method in interface com.sdmetrics.app.DataTables
Returns the number of columns of a table.
getNumberOfColumns(int) - Method in class com.sdmetrics.app.MetricData
Returns the number of metrics for a table.
getNumberOfColumns(int) - Method in class com.sdmetrics.app.ModelData
Returns the number of attributes (columns) in a table.
getNumberOfColumns(int) - Method in class com.sdmetrics.app.RelationMatrices
Gets the number of target design elements (columns) in a table.
getNumberOfColumns(int) - Method in class com.sdmetrics.app.RuleData
 
getNumberOfColumns() - Method in class com.sdmetrics.metrics.MatrixData
Gets the number of columns (target model elements) of this relation matrix.
getNumberOfElements() - Method in class com.sdmetrics.model.XMIReader
Gets the number of elements that have been extracted.
getNumberOfRows(int) - Method in interface com.sdmetrics.app.DataTables
Returns the number of rows of a table.
getNumberOfRows(int) - Method in class com.sdmetrics.app.MetricData
Returns the number of design elements for a table.
getNumberOfRows(int) - Method in class com.sdmetrics.app.ModelData
Returns the number of model elements (rows) in a table.
getNumberOfRows(int) - Method in class com.sdmetrics.app.RelationMatrices
Gets the number of source design elements (rows) in a table.
getNumberOfRows(int) - Method in class com.sdmetrics.app.RuleData
Gets the number of design rule violations for a table.
getNumberOfRows() - Method in class com.sdmetrics.metrics.MatrixData
Gets the number of rows (source model elements) of this relation matrix.
getNumberOfTables() - Method in interface com.sdmetrics.app.DataTables
Returns the number of available tables.
getNumberOfTables() - Method in class com.sdmetrics.app.MetricData
 
getNumberOfTables() - Method in class com.sdmetrics.app.ModelData
 
getNumberOfTables() - Method in class com.sdmetrics.app.RelationMatrices
 
getNumberOfTables() - Method in class com.sdmetrics.app.RuleData
 
getOperand(int) - Method in class com.sdmetrics.math.ExpressionNode
Gets an operand of the node.
getOperandCount() - Method in class com.sdmetrics.math.ExpressionNode
Gets the number of operands of this node.
getOwnedElements() - Method in class com.sdmetrics.model.ModelElement
Gets the model elements owned by this element.
getOwner() - Method in class com.sdmetrics.model.ModelElement
Gets the owner of this model element.
getParameterCount() - Method in enum com.sdmetrics.metrics.DescriptionLocator
Gets the number of parameters this locator expects following the prefix.
getParent() - Method in class com.sdmetrics.model.MetaModelElement
Gets the parent of this element type.
getPlainAttribute(String) - Method in class com.sdmetrics.model.ModelElement
Retrieves the value of a single-valued data attribute for this model element.
getPrefix() - Method in enum com.sdmetrics.metrics.DescriptionLocator
Gets the prefix of this locator.
getProcedureName() - Method in class com.sdmetrics.metrics.MetricEntry
Gets the name of the calculation procedure.
getRefAttribute(String) - Method in class com.sdmetrics.model.ModelElement
Retrieves the model element referenced by a single-valued cross-reference attribute.
getReferencedIds(int, int, int) - Method in class com.sdmetrics.app.ModelData
Gets the set of XMI IDs of model elements referenced by a (multi-valued) cross-reference attribute.
getRelationOrSet(ModelElement, ProcedureAttributes, Variables) - Method in class com.sdmetrics.metrics.AbstractProcedure
Gets the element set specified by a "relation" or "relset" attribute.
getRelations(String) - Method in class com.sdmetrics.model.ModelElement
Returns the set of model elements that point to this model element via a specified cross-reference attribute.
getRequiredExpression(String) - Method in class com.sdmetrics.metrics.ProcedureAttributes
Retrieves the operator tree for a required attribute holding an expression.
getRequiredStringValue(String) - Method in class com.sdmetrics.metrics.ProcedureAttributes
Retrieves the value of a required attribute holding a simple string.
getResultSet() - Method in class com.sdmetrics.metrics.SetSummationHelper
Gets the result set.
getRightNode() - Method in class com.sdmetrics.math.ExpressionNode
Retrieves the node representing the right hand side of a binary operation.
getRowCondition() - Method in class com.sdmetrics.metrics.Matrix
Gets the condition expression for row elements to be included in the matrix.
getRowElement(int) - Method in class com.sdmetrics.metrics.MatrixData
Gets the source element in a row of this relation matrix.
getRowName(int, int) - Method in interface com.sdmetrics.app.DataTables
Returns the name of the object a row represents (row header).
getRowName(int, int) - Method in class com.sdmetrics.app.MetricData
Returns the name of the design element at the specified row.
getRowName(int, int) - Method in class com.sdmetrics.app.ModelData
Gets the fully qualified name of a model element in a specific row.
getRowName(int, int) - Method in class com.sdmetrics.app.RelationMatrices
Gets the name of a source element in specific row.
getRowName(int, int) - Method in class com.sdmetrics.app.RuleData
Gets the fully qualified name of the violating model element in a specific row.
getRowType() - Method in class com.sdmetrics.metrics.Matrix
Retrieves the element type of the source elements (rows).
getRule(MetaModelElement, String) - Method in class com.sdmetrics.metrics.MetricStore
Gets the rule for a given element type by its name.
getRule() - Method in class com.sdmetrics.metrics.RuleViolation
Gets the rule of this rule violation.
getRuleEngine() - Method in class com.sdmetrics.metrics.RuleProcedure
Gets the rule engine for this rule procedure.
getRules(MetaModelElement) - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all rules for a given element type.
getRuleValue(ModelElement, ProcedureAttributes, Variables) - Method in class com.sdmetrics.metrics.RuleProcedure
Evaluates the "value" expression of a rule.
getSAXParserHandler() - Method in class com.sdmetrics.metrics.MetricStore
Gets a SAX handler to parse a metric definition file and store its contents with this object.
getSAXParserHandler() - Method in class com.sdmetrics.model.MetaModel
Gets a SAX handler to populate this metamodel with the contents of a metamodel definition file.
getSAXParserHandler() - Method in class com.sdmetrics.model.XMITransformations
Gets a SAX handler to parse an XMI transformation file and store the transformations with this object.
getSet(ModelElement, Set) - Method in class com.sdmetrics.metrics.MetricsEngine
Retrieves the contents of a set for a model element.
getSet(MetaModelElement, String) - Method in class com.sdmetrics.metrics.MetricStore
Gets the set for a given element type by its name.
getSetAttribute(String) - Method in class com.sdmetrics.model.ModelElement
Retrieves the set of values for a multi-valued attribute.
getSets(MetaModelElement) - Method in class com.sdmetrics.metrics.MetricStore
Gets the list of all sets for a given element type.
getStringValue(String) - Method in class com.sdmetrics.metrics.ProcedureAttributes
Retrieves the value of an optional attribute holding a simple string.
getTableName(int) - Method in interface com.sdmetrics.app.DataTables
Returns the name of a table.
getTableName(int) - Method in class com.sdmetrics.app.MetricData
 
getTableName(int) - Method in class com.sdmetrics.app.ModelData
 
getTableName(int) - Method in class com.sdmetrics.app.RelationMatrices
Returns the name of the relation matrix.
getTableName(int) - Method in class com.sdmetrics.app.RuleData
 
getTablesDescription() - Method in interface com.sdmetrics.app.DataTables
Returns a short description of the tables contents.
getTablesDescription() - Method in class com.sdmetrics.app.MetricData
 
getTablesDescription() - Method in class com.sdmetrics.app.ModelData
 
getTablesDescription() - Method in class com.sdmetrics.app.RelationMatrices
 
getTablesDescription() - Method in class com.sdmetrics.app.RuleData
 
getThrowable() - Method in class com.sdmetrics.app.Problem
Gets the exception/error that caused the problem.
getTotal() - Method in class com.sdmetrics.metrics.SummationHelper
Gets the current total.
getType() - Method in class com.sdmetrics.metrics.Metric
Retrieves the type of elements for which the metric is defined.
getType() - Method in class com.sdmetrics.metrics.Rule
Gets the element type for which this rule is defined.
getType() - Method in class com.sdmetrics.metrics.Set
Retrieves the type of elements for which the set is defined.
getType(String) - Method in class com.sdmetrics.model.MetaModel
Retrieves a metamodel element by its type name.
getType() - Method in class com.sdmetrics.model.ModelElement
Returns the metamodel element type of this model element.
getTypeName(int) - Method in interface com.sdmetrics.app.DataTables
Returns the metamodel type name of the elements of a table.
getTypeName(int) - Method in class com.sdmetrics.app.MetricData
 
getTypeName(int) - Method in class com.sdmetrics.app.ModelData
 
getTypeName(int) - Method in class com.sdmetrics.app.RelationMatrices
 
getTypeName(int) - Method in class com.sdmetrics.app.RuleData
 
getValue() - Method in class com.sdmetrics.math.ExpressionNode
Retrieves the value of this node.
getValue() - Method in class com.sdmetrics.metrics.RuleViolation
Gets the value for this rule violation.
getValueAt(int, int, int) - Method in interface com.sdmetrics.app.DataTables
Returns the value of a table cell.
getValueAt(int, int, int) - Method in class com.sdmetrics.app.MetricData
Returns the metric value for a particular design element and metric in a table.
getValueAt(int, int, int) - Method in class com.sdmetrics.app.ModelData
Gets the value of an attribute for a specific model element.
getValueAt(int, int, int) - Method in class com.sdmetrics.app.RelationMatrices
 
getValueAt(int, int, int) - Method in class com.sdmetrics.app.RuleData
Gets the detailed information about a rule violation in the specified column.
getValueAt(int, int) - Method in class com.sdmetrics.metrics.MatrixData
Gets the value of a cell of this relation matrix.
getValuesCache() - Method in class com.sdmetrics.metrics.RuleProcedure
Gets the cache to store data for reuse for subsequent checks of other model elements.
getVariable(String) - Method in class com.sdmetrics.metrics.Variables
Gets the value of a variable.
getXMIID(int, int) - Method in class com.sdmetrics.app.ModelData
Gets the XMI ID of a model element.
getXMIID() - Method in class com.sdmetrics.model.ModelElement
Gets the XMI ID of this model element.
Glossary - Class in com.sdmetrics.metrics
Represents a glossary term entry in the metric definition file.

H

hasAttribute(String) - Method in class com.sdmetrics.model.MetaModelElement
Tests if this element type has an attribute of a given name.
hashCode() - Method in class com.sdmetrics.math.HashMultiSet
Returns the hash code value for this set.
HashMultiSet<E> - Class in com.sdmetrics.math
A hash set that can contain the same element multiple times.
HashMultiSet(int) - Constructor for class com.sdmetrics.math.HashMultiSet
Creates an empty multiset with specified initial capacity.
HashMultiSet(Collection<? extends E>) - Constructor for class com.sdmetrics.math.HashMultiSet
Creates a new set containing all elements in the specified collection.
hasNext() - Method in class com.sdmetrics.math.MappedCollectionsIterator
 
hasVariable(String) - Method in class com.sdmetrics.metrics.Variables
Tests whether a variable of a specified name is defined in this set.

I

id - Variable in class com.sdmetrics.metrics.MetricEntry
Entry ID number (array index for efficient storage).
increment(int, int) - Method in class com.sdmetrics.math.IntegerMatrix
Increments the integer value at the given coordinates by one.
init(String, DataTables) - Method in class com.sdmetrics.output.ExportFormatter
Performs any up-front activities before the individual data files are created.
IntegerMatrix - Class in com.sdmetrics.math
Realizes a sparse matrix of integers.
IntegerMatrix() - Constructor for class com.sdmetrics.math.IntegerMatrix
Creates a new null matrix.
isCompatible(ModelElement, MetricEntry, ModelElement) - Method in class com.sdmetrics.metrics.AbstractProcedure
Checks if a metric or set can be applied to a related element.
isEmpty() - Method in class com.sdmetrics.math.IntegerMatrix
Tests whether this matrix is a null matrix.
isEmpty() - Method in class com.sdmetrics.metrics.MatrixData
Tests if this relation matrix is empty (a null matrix).
isEmptyElement(Object) - Static method in class com.sdmetrics.metrics.MetricTools
Checks if an object represents an empty model element reference.
isEnabled() - Method in class com.sdmetrics.metrics.Rule
Tests whether this rule is enabled to not.
isIdentifier() - Method in class com.sdmetrics.math.ExpressionNode
Tests whether this node represents an identifier.
isIdentifierCharacter(char) - Static method in class com.sdmetrics.math.ExpressionParser
Tests if a character is a valid identifier character.
isInternal() - Method in class com.sdmetrics.metrics.Metric
Tests if this metric is internal or externally visible in the output.
isMultiSet(Collection<?>) - Static method in class com.sdmetrics.metrics.MetricTools
Tests if a collection is a multiset.
isMultiSet() - Method in class com.sdmetrics.metrics.Set
Checks if this entry defines a regular set or a multiset.
isNumberConstant() - Method in class com.sdmetrics.math.ExpressionNode
Tests whether this node represents a number constant.
isOperation() - Method in class com.sdmetrics.math.ExpressionNode
Tests whether this node represents an operation.
isRefAttribute(String) - Method in class com.sdmetrics.model.MetaModelElement
Tests if an attribute is a cross-reference attribute.
isSetAttribute(String) - Method in class com.sdmetrics.model.MetaModelElement
Tests if an attribute is multi-valued.
isStringConstant() - Method in class com.sdmetrics.math.ExpressionNode
Tests whether this node represents a string constant.
isValid() - Method in class com.sdmetrics.metrics.FilterAttributeProcessor
Tests if the resulting model element from the most recent application of filter attributes fulfills all filter conditions.
iterator() - Method in class com.sdmetrics.math.HashMultiSet
Returns an iterator over the elements in the set.
iterator() - Method in class com.sdmetrics.model.MetaModel
Retrieves an iterator over the element types in this metamodel.
iterator() - Method in class com.sdmetrics.model.Model
Returns an iterator over all model elements of the model, ignoring any filters settings.

L

location - Variable in class com.sdmetrics.metrics.MetricEntry
Line number of the entry in the metric definition file.
locator - Variable in class com.sdmetrics.util.SAXHandler
Locator of the handler.

M

MappedCollectionsIterator<T> - Class in com.sdmetrics.math
Iterates over the elements contained in multiple collections, which are organized as values in a map.
MappedCollectionsIterator(Map<?, ? extends Collection<T>>) - Constructor for class com.sdmetrics.math.MappedCollectionsIterator
 
match(Rule) - Method in class com.sdmetrics.metrics.RuleFilter
Checks if the application area(s) of a design rule match this filter.
Matrix - Class in com.sdmetrics.metrics
Represents the definition of a relation matrix in the metric definition file.
Matrix(String, MetaModelElement, MetaModelElement) - Constructor for class com.sdmetrics.metrics.Matrix
Creates a new relation matrix definition.
MatrixData - Class in com.sdmetrics.metrics
Data structure to store the data for one matrix.
MatrixEngine - Class in com.sdmetrics.metrics
Calculates relation matrices.
MatrixEngine(MetricsEngine) - Constructor for class com.sdmetrics.metrics.MatrixEngine
Creates a new matrix engine.
message(String, int) - Method in class com.sdmetrics.app.ConsoleMessageHandler
 
message(String, int) - Method in class com.sdmetrics.app.MessageHandler
Reports a calculation progress message.
MessageHandler - Class in com.sdmetrics.app
Class to report progress messages and errors during (lengthy) operations such as metric calculations.
MessageHandler() - Constructor for class com.sdmetrics.app.MessageHandler
 
MetaModel - Class in com.sdmetrics.model
Represents an SDMetrics metamodel.
MetaModel() - Constructor for class com.sdmetrics.model.MetaModel
 
MetaModelElement - Class in com.sdmetrics.model
Represents an element type of the SDMetrics metamodel.
Metric - Class in com.sdmetrics.metrics
Represents the definition of metric in the metric definition file.
Metric(String, MetaModelElement, String) - Constructor for class com.sdmetrics.metrics.Metric
Creates a new metric definition.
MetricData - Class in com.sdmetrics.app
Provides a tabular view of the design measurement data.
MetricData(MetricsEngine) - Constructor for class com.sdmetrics.app.MetricData
 
MetricEntry - Class in com.sdmetrics.metrics
Base class for entries in the metric definition file (metrics, sets, rules, or matrices).
MetricEntry(String) - Constructor for class com.sdmetrics.metrics.MetricEntry
Constructor.
MetricProcedure - Class in com.sdmetrics.metrics
Base class for all metric procedures.
MetricProcedure() - Constructor for class com.sdmetrics.metrics.MetricProcedure
 
MetricProcedureAttributeValue - Class in com.sdmetrics.metrics
Calculates an "attributevalue" metric procedure.
MetricProcedureAttributeValue() - Constructor for class com.sdmetrics.metrics.MetricProcedureAttributeValue
 
MetricProcedureCompare - Class in com.sdmetrics.metrics
Calculates the deprecated "compare" metric procedure.
MetricProcedureCompare() - Constructor for class com.sdmetrics.metrics.MetricProcedureCompare
 
MetricProcedureCompound - Class in com.sdmetrics.metrics
Calculates a "compound" metric procedure.
MetricProcedureCompound() - Constructor for class com.sdmetrics.metrics.MetricProcedureCompound
 
MetricProcedureConnectedComponents - Class in com.sdmetrics.metrics
Calculates a "connectedcomponents" metric procedure.
MetricProcedureConnectedComponents() - Constructor for class com.sdmetrics.metrics.MetricProcedureConnectedComponents
 
MetricProcedureCount - Class in com.sdmetrics.metrics
Calculates the deprecated "count" metric procedure.
MetricProcedureCount() - Constructor for class com.sdmetrics.metrics.MetricProcedureCount
 
MetricProcedureFilterValue - Class in com.sdmetrics.metrics
Calculates a "filtervalue" metric procedure.
MetricProcedureFilterValue() - Constructor for class com.sdmetrics.metrics.MetricProcedureFilterValue
 
MetricProcedureNesting - Class in com.sdmetrics.metrics
Calculates a "nesting" metric procedure.
MetricProcedureNesting() - Constructor for class com.sdmetrics.metrics.MetricProcedureNesting
 
MetricProcedureProjection - Class in com.sdmetrics.metrics
Calculates a "projection" metric procedure.
MetricProcedureProjection() - Constructor for class com.sdmetrics.metrics.MetricProcedureProjection
 
MetricProcedureSetOperation - Class in com.sdmetrics.metrics
Calculates the deprecated "setoperation" metric procedure.
MetricProcedureSetOperation() - Constructor for class com.sdmetrics.metrics.MetricProcedureSetOperation
 
MetricProcedureSignature - Class in com.sdmetrics.metrics
Calculates a "signature" metric procedure.
MetricProcedureSignature() - Constructor for class com.sdmetrics.metrics.MetricProcedureSignature
 
MetricProcedureSubelements - Class in com.sdmetrics.metrics
Calculates a "subelements" metric procedure.
MetricProcedureSubelements() - Constructor for class com.sdmetrics.metrics.MetricProcedureSubelements
 
MetricProcedureSubString - Class in com.sdmetrics.metrics
Calculates the "substring" procedure to extract substrings from a string.
MetricProcedureSubString() - Constructor for class com.sdmetrics.metrics.MetricProcedureSubString
 
MetricProcedureValuesetOperation - Class in com.sdmetrics.metrics
Calculates the deprecated "valueset" metric procedure.
MetricProcedureValuesetOperation() - Constructor for class com.sdmetrics.metrics.MetricProcedureValuesetOperation
 
MetricsEngine - Class in com.sdmetrics.metrics
Calculates metrics and sets.
MetricsEngine(MetricStore, Model) - Constructor for class com.sdmetrics.metrics.MetricsEngine
Initializes a new metrics engine.
MetricStore - Class in com.sdmetrics.metrics
Reads a metric definition file and provides access to metrics, sets, and rules defined therein.
MetricStore(MetaModel) - Constructor for class com.sdmetrics.metrics.MetricStore
Creates a new metric store.
MetricTools - Class in com.sdmetrics.metrics
Collection of static helper methods that are useful for the implementation of calculation procedures.
MetricTools() - Constructor for class com.sdmetrics.metrics.MetricTools
 
Model - Class in com.sdmetrics.model
Container for the model elements of the UML design to be analyzed.
Model(MetaModel) - Constructor for class com.sdmetrics.model.Model
Creates a new, empty model.
ModelData - Class in com.sdmetrics.app
Provides a tabular view of the analyzed model.
ModelData(Model) - Constructor for class com.sdmetrics.app.ModelData
 
ModelElement - Class in com.sdmetrics.model
Represents a model element of a model.
ModelElement(MetaModelElement) - Constructor for class com.sdmetrics.model.ModelElement
Creates a new element.

N

name - Variable in class com.sdmetrics.metrics.MetricEntry
Name of the entry in the metric definition file.
newTable(String) - Method in class com.sdmetrics.output.ExportFormatter
Prints formatting required to start a new table.
next() - Method in class com.sdmetrics.math.MappedCollectionsIterator
 

O

okToOverwrite(String, boolean) - Method in class com.sdmetrics.output.OverwriteConfirmation
Checks if a file to write exists, and if so, if it can be overwritten.
out - Variable in class com.sdmetrics.app.ConsoleMessageHandler
Print stream for progress messages.
out - Variable in class com.sdmetrics.output.ExportFormatter
Output target for the formatter to write to.
outputXMLEscaped(String) - Method in class com.sdmetrics.output.ExportFormatter
Writes a string to the current output file, substituting XML and HTML special characters by their entity references.
OverwriteConfirmation - Class in com.sdmetrics.output
Confirmation to overwrite existing files.
OverwriteConfirmation() - Constructor for class com.sdmetrics.output.OverwriteConfirmation
 

P

parse(String, ContentHandler) - Method in class com.sdmetrics.util.XMLParser
Parses the XML file at the specified URI
parseExpression(String) - Method in class com.sdmetrics.math.ExpressionParser
Parses an expression and returns its operator tree.
precalculateMetrics(MessageHandler, int, int) - Method in class com.sdmetrics.app.MetricData
Calculates all externally visible metrics, reports any errors.
Problem - Class in com.sdmetrics.app
Stores the details of a problem encountered during metric calculation, rule checking, etc.
Problem(String) - Constructor for class com.sdmetrics.app.Problem
Creates a problem report with a message.
Problem(Throwable) - Constructor for class com.sdmetrics.app.Problem
Creates a problem report with an exception (or error).
Problem(String, Throwable) - Constructor for class com.sdmetrics.app.Problem
Creates a problem report with an exception and further explanations.
ProcedureAttributes - Class in com.sdmetrics.metrics
Stores the attributes of the calculation procedure definition of a metric, set, matrix, or rule in the metric definition file.
ProcedureAttributes() - Constructor for class com.sdmetrics.metrics.ProcedureAttributes
 
procedureName - Variable in class com.sdmetrics.metrics.MetricEntry
Name of the calculation procedure for the entry.
processCommandLine(String[]) - Method in class com.sdmetrics.cmdline.CoreCommandLineProcessor
Processes the command line arguments, calculates design metrics accordingly, and exports data as specified.
PROPERTIES_FILE - Static variable in class com.sdmetrics.util.VersionInfo
The current name of the file that stores the application properties.

R

raiseTo(float) - Method in class com.sdmetrics.metrics.SummationHelper
Raises the total to a specified value if it currently is below that value.
Reference - Class in com.sdmetrics.metrics
Represents a literature reference in the metric definition file.
RelationMatrices - Class in com.sdmetrics.app
Calculates all relation matrices and provides a tabular view of their contents.
RelationMatrices(MatrixEngine) - Constructor for class com.sdmetrics.app.RelationMatrices
 
remove(Object) - Method in class com.sdmetrics.math.HashMultiSet
Removes one occurrence of the specified element from this set.
remove() - Method in class com.sdmetrics.math.MappedCollectionsIterator
Throws an UnsupportedOperationException.
removeAll(Collection<?>) - Method in class com.sdmetrics.math.HashMultiSet
Removes elements in this set that are also contained in the specified collection.
removeAny(Object) - Method in class com.sdmetrics.math.HashMultiSet
Removes all occurrences of an element from this set.
removeAny(Collection<?>, Object) - Static method in class com.sdmetrics.metrics.MetricTools
Removes all occurrences of an element in a set or multiset.
reportError(List<Problem>) - Method in class com.sdmetrics.app.ConsoleMessageHandler
 
reportError(String) - Method in class com.sdmetrics.app.MessageHandler
Reports a single error.
reportError(String, Throwable) - Method in class com.sdmetrics.app.MessageHandler
Reports a single error caused by an exception.
reportError(List<Problem>) - Method in class com.sdmetrics.app.MessageHandler
Reports a list of errors.
reportError(String) - Method in class com.sdmetrics.util.SAXHandler
Reports a severe error that calls for a SAX Exception.
reportViolation(ModelElement, Rule, Object) - Method in class com.sdmetrics.metrics.RuleProcedure
Reports a rule violation.
reportXMIProgress(String) - Method in interface com.sdmetrics.model.XMIReader.ProgressMessageHandler
Report a progress message.
retainAll(Collection<?>) - Method in class com.sdmetrics.math.HashMultiSet
Retains only the elements in this collection that are also contained in the specified collection.
Rule - Class in com.sdmetrics.metrics
Represents a design rule.
Rule(String, MetaModelElement, String, String, Collection<String>, boolean) - Constructor for class com.sdmetrics.metrics.Rule
Creates a new rule.
RuleData - Class in com.sdmetrics.app
Checks the design rules for a model and provides a tabular view of the design rule violations.
RuleData(RuleEngine) - Constructor for class com.sdmetrics.app.RuleData
 
RuleEngine - Class in com.sdmetrics.metrics
Checks the design rules for a model and reports violations.
RuleEngine(MetricsEngine) - Constructor for class com.sdmetrics.metrics.RuleEngine
Creates a new rule engine.
RuleFilter - Class in com.sdmetrics.metrics
Represents and evaluates a design rule filter expression.
RuleFilter() - Constructor for class com.sdmetrics.metrics.RuleFilter
Constructs a new empty rule filter that accepts all application areas.
RuleFilter(String) - Constructor for class com.sdmetrics.metrics.RuleFilter
Construct a new rule filter from a filter string.
RuleProcedure - Class in com.sdmetrics.metrics
Base class for all rule procedures.
RuleProcedure() - Constructor for class com.sdmetrics.metrics.RuleProcedure
 
RuleProcedureCycle - Class in com.sdmetrics.metrics
Checks a "cycle" rule.
RuleProcedureCycle() - Constructor for class com.sdmetrics.metrics.RuleProcedureCycle
 
RuleProcedureSet - Class in com.sdmetrics.metrics
Checks rules based on set procedures.
RuleProcedureSet() - Constructor for class com.sdmetrics.metrics.RuleProcedureSet
 
RuleProcedureViolation - Class in com.sdmetrics.metrics
Checks a "violation" rule with a simple rule condition.
RuleProcedureViolation() - Constructor for class com.sdmetrics.metrics.RuleProcedureViolation
 
RuleViolation - Class in com.sdmetrics.metrics
Stores details about the violation of one specific rule by one specific model element.
RuleViolation(ModelElement, Rule, Object) - Constructor for class com.sdmetrics.metrics.RuleViolation
 

S

SAXHandler - Class in com.sdmetrics.util
Base class for SDMetrics' XML handlers.
SAXHandler() - Constructor for class com.sdmetrics.util.SAXHandler
 
ScalarOperation - Class in com.sdmetrics.metrics
Base class for scalar operations in expressions.
ScalarOperation() - Constructor for class com.sdmetrics.metrics.ScalarOperation
 
SDMetricsException - Exception in com.sdmetrics.metrics
Exception to deal with problems that can occur during metrics calculation.
SDMetricsException(ModelElement, MetricEntry, String) - Constructor for exception com.sdmetrics.metrics.SDMetricsException
Constructor with message.
SDMetricsException(ModelElement, MetricEntry, Exception) - Constructor for exception com.sdmetrics.metrics.SDMetricsException
Constructor with an exception to be chained.
Set - Class in com.sdmetrics.metrics
Represents the definition of a set in the metric definition file.
Set(String, MetaModelElement) - Constructor for class com.sdmetrics.metrics.Set
Creates a new set definition
setDocumentLocator(Locator) - Method in class com.sdmetrics.util.SAXHandler
 
setEncoding(String) - Method in class com.sdmetrics.output.DataExportConfiguration
Sets the character encoding for the output files.
setFilter(String[], boolean, boolean) - Method in class com.sdmetrics.model.Model
Applies filter settings to the elements of this model.
SetOperation - Class in com.sdmetrics.metrics
Base class for set operations in expressions.
SetOperation() - Constructor for class com.sdmetrics.metrics.SetOperation
 
setOverwriteConfirmer(OverwriteConfirmation) - Method in class com.sdmetrics.output.DataExportConfiguration
Sets the object to ask if a file can be overwritten.
setPreferredSeparator(String) - Method in class com.sdmetrics.output.DataExportConfiguration
Sets the column separator for text-based output formats such as CSV.
SetProcedure - Class in com.sdmetrics.metrics
Base class for all set procedures.
SetProcedure() - Constructor for class com.sdmetrics.metrics.SetProcedure
 
SetProcedureCompare - Class in com.sdmetrics.metrics
Calculates the deprecated "compare" set procedure.
SetProcedureCompare() - Constructor for class com.sdmetrics.metrics.SetProcedureCompare
 
SetProcedureCompound - Class in com.sdmetrics.metrics
Calculates the deprecated "compoundset" procedure for sets.
SetProcedureCompound() - Constructor for class com.sdmetrics.metrics.SetProcedureCompound
 
SetProcedureProjection - Class in com.sdmetrics.metrics
Calculates the "projection" set procedure.
SetProcedureProjection() - Constructor for class com.sdmetrics.metrics.SetProcedureProjection
 
SetProcedureSubelements - Class in com.sdmetrics.metrics
Calculates the "subelements" set procedure.
SetProcedureSubelements() - Constructor for class com.sdmetrics.metrics.SetProcedureSubelements
 
setProgressMessageHandler(XMIReader.ProgressMessageHandler) - Method in class com.sdmetrics.model.XMIReader
Registers a message handler for the XMI reader to report progress to.
setQuotingStrategy(DataExportConfiguration.QuotingStrategy) - Method in class com.sdmetrics.output.DataExportConfiguration
Sets the quoting strategy for text-based output formats.
setRuleFilter(MessageHandler, String) - Method in class com.sdmetrics.app.RuleData
Sets the rule filter that specifies the rules to apply.
setSanitizeOutput(boolean) - Method in class com.sdmetrics.output.DataExportConfiguration
Specifies whether or not to output the row header column.
setSingleOutputFile(boolean) - Method in class com.sdmetrics.output.DataExportConfiguration
Specifies whether or not to write all data tables to a single file.
SetSummationHelper - Class in com.sdmetrics.metrics
Helps set calculation procedures to build up their cumulative result sets.
SetSummationHelper(MetricsEngine, Set, String) - Constructor for class com.sdmetrics.metrics.SetSummationHelper
 
setVariable(String, Object) - Method in class com.sdmetrics.metrics.Variables
Sets the value of a variable.
setVerbose(boolean) - Method in class com.sdmetrics.app.ConsoleMessageHandler
Switch verbose output on or off.
size() - Method in class com.sdmetrics.math.HashMultiSet
Returns the number of elements in the set, respecting cardinality of the elements.
specializes(MetaModelElement) - Method in class com.sdmetrics.model.MetaModelElement
Checks if this type specializes another type.
startDocument() - Method in class com.sdmetrics.model.XMIReader
Prepare parser for new XMI file.
startElement(String, String, String, Attributes) - Method in class com.sdmetrics.model.XMIReader
Processes the opening tag of an XML element in the XMI source file.
startRow() - Method in class com.sdmetrics.output.ExportFormatter
Prints the formatting to start a new table row.
StronglyConnectedComponents<T> - Class in com.sdmetrics.metrics
Calculates the strongly connected components of a directed graph.
StronglyConnectedComponents() - Constructor for class com.sdmetrics.metrics.StronglyConnectedComponents
 
StronglyConnectedComponents.Graph<T> - Interface in com.sdmetrics.metrics
Provides the strongly connected components algorithm with the information it requires about the directed graph.
SummationHelper - Class in com.sdmetrics.metrics
Processes the "sum" and "stat" attributes of metric calculation procedures.
SummationHelper(MetricsEngine, ProcedureAttributes) - Constructor for class com.sdmetrics.metrics.SummationHelper
 

T

tableCell(Object) - Method in class com.sdmetrics.output.ExportFormatter
Prints a table body data cell.
tableHeaderCell(String) - Method in class com.sdmetrics.output.ExportFormatter
Prints the table header cell of a table column.
TL_ELEMENT - Static variable in class com.sdmetrics.metrics.MetricStore
The name of the top level XML element in the metric definition file.
TL_ELEMENT - Static variable in class com.sdmetrics.model.MetaModel
The name of the top level XML element in the metamodel definition file.
TL_ELEMENT - Static variable in class com.sdmetrics.model.XMITransformations
The name of the top level XML element in the XMI transformation file.
toString() - Method in class com.sdmetrics.metrics.Glossary
Returns a string representation of the glossary entry.
toString() - Method in class com.sdmetrics.metrics.Matrix
Returns a string representation of the matrix definition.
toString() - Method in class com.sdmetrics.metrics.Metric
Returns a string representation of the metric.
toString() - Method in class com.sdmetrics.metrics.Reference
Returns a string representation of the reference.
toString() - Method in class com.sdmetrics.metrics.Rule
Returns a string representation of the rule.
toString() - Method in class com.sdmetrics.metrics.Set
Returns a string representation of the set.
toString() - Method in class com.sdmetrics.model.ModelElement
Returns the XMI ID of the model element as its string representation.

V

validIteration(Collection<ModelElement>, Variables) - Method in class com.sdmetrics.metrics.FilterAttributeProcessor
Applies element filters and filter attributes to an element set and returns an iteration over the valid elements.
valueOf(String) - Static method in enum com.sdmetrics.metrics.DescriptionLocator
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.sdmetrics.output.DataExportConfiguration.QuotingStrategy
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sdmetrics.metrics.DescriptionLocator
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.sdmetrics.output.DataExportConfiguration.QuotingStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
Variables - Class in com.sdmetrics.metrics
Contains the names and values of variables to use when evaluating metric, set, or condition expressions.
Variables(ModelElement) - Constructor for class com.sdmetrics.metrics.Variables
Creates a new set of variables.
verbose - Variable in class com.sdmetrics.app.ConsoleMessageHandler
Indicates if stack traces for exceptions should be shown.
VERSION - Static variable in class com.sdmetrics.util.VersionInfo
Program name+version.
VERSION_NUMBER - Static variable in class com.sdmetrics.util.VersionInfo
Current version number
VersionInfo - Class in com.sdmetrics.util
Provides program version information to the application.
VersionInfo() - Constructor for class com.sdmetrics.util.VersionInfo
 

X

XMIReader - Class in com.sdmetrics.model
Reads an XMI source file, processing it as specified by an XMI transformation file.
XMIReader(XMITransformations, Model) - Constructor for class com.sdmetrics.model.XMIReader
 
XMIReader.ProgressMessageHandler - Interface in com.sdmetrics.model
Message handler for progress messages of the XMI parser.
XMITransformations - Class in com.sdmetrics.model
Container and XML parser for XMI transformations.
XMITransformations(MetaModel) - Constructor for class com.sdmetrics.model.XMITransformations
 
XML_FILE_VERSIONS - Static variable in class com.sdmetrics.util.VersionInfo
List of version numbers used in project files, in chronological ascending order.
XMLParser - Class in com.sdmetrics.util
Encapsulates access to the XML Parser.
XMLParser() - Constructor for class com.sdmetrics.util.XMLParser
Constructs a non-validating SAX parser.

A B C D E F G H I L M N O P R S T V X
www.sdmetrics.com