A C E F G H I J L M N O P R S T U V W X Z

A

About - Class in cyvis.gui

A dialog to display the About for cyvis.

About(JFrame) - Constructor for class cyvis.gui.About

actionPerformed(ActionEvent) - Method in class cyvis.gui.charts.ChartPane

Overrides the actionPerformed.

actionPerformed(ActionEvent) - Method in class cyvis.gui.GUISetup

Override actionPerformed.

actionPerformed(ActionEvent) - Method in class cyvis.gui.PreferencesDialog

Overrides actionPerformed

actionPerformed(ActionEvent) - Method in class cyvis.gui.ProjectDialog

actualScale - Static variable in class cyvis.config.Settings

addClass(ClassMetric) - Method in class cyvis.metric.PackageMetric

addFileset(FileSet) - Method in class cyvis.ant.CyvisTask

addPackages(PackageMetric) - Method in class cyvis.metric.ProjectMetric

add a new packagemetric to the project

allFiles - Static variable in class cyvis.config.Settings

AntTaskUtil - Class in cyvis.ant

Ant Task Util is a util class that is used by the CyvisTask class.

AntTaskUtil() - Constructor for class cyvis.ant.AntTaskUtil

ArgChecker - Class in cyvis.util

ArgChecker uses apache's commons cli library to parse command line arguments.

ArgChecker() - Constructor for class cyvis.util.ArgChecker

Sets up all the valid command line options that could be given (while the program is started).

ArgCodes - Class in cyvis.config

A class to hold all the input parameter codes.

ArgCodes() - Constructor for class cyvis.config.ArgCodes

C

CANNOT_READ_FILES - Static variable in class cyvis.config.Warnings

CANNOT_READ_PROJECT_FILE - Static variable in class cyvis.config.ErrorMessages

CC_INTEGER - Static variable in class cyvis.config.Warnings

changedUpdate(DocumentEvent) - Method in class cyvis.gui.ProjectDialog

ChartPane - Class in cyvis.gui.charts

Does the visualization part of cyvis.

ChartPane() - Constructor for class cyvis.gui.charts.ChartPane

default constructor

chartPane - Variable in class cyvis.gui.GUISetup

CLASS_PROJECT_FILE - Static variable in class cyvis.config.InfoMessages

ClassChart - Class in cyvis.gui.charts

Visualises a class's metrics as a bar chart

ClassChart(ClassMetric, int, int, PackageMetric) - Constructor for class cyvis.gui.charts.ClassChart

Contsructor used in visualising a complete package (ie all the classes in a package)

ClassChart(ClassMetric, int, int) - Constructor for class cyvis.gui.charts.ClassChart

Contsructor used in visualising a class

classes - Variable in class cyvis.metric.ProjectMetric

ClassMetric - Class in cyvis.metric

This class stores the class's metrics.

ClassMetric(String, String, ArrayList<MethodMetric>) - Constructor for class cyvis.metric.ClassMetric

Constructs a ClassMetric object with the className, packageName and the methods specified.

className - Variable in class cyvis.metric.ClassMetric

clearHistory() - Method in class cyvis.gui.charts.ChartPane

Clears the history

collectMetric() - Method in class cyvis.core.TUI

Collects metrics and returns an projectMetric object.

collectMetrics() - Method in class cyvis.core.TUI

Collects metrics for the files specified.

ColorSelector - Class in cyvis.gui.charts

Holds the cyclomati complexity ranges and their respctive colors.

ColorSelector() - Constructor for class cyvis.gui.charts.ColorSelector

compareTo(Object) - Method in class cyvis.metric.ClassMetric

compareTo(Object) - Method in class cyvis.metric.MethodMetric

compares two methods metrics returns an int value

compareTo(Object) - Method in class cyvis.metric.PackageMetric

contains(String) - Method in class cyvis.metric.ProjectMetric

Checks if the project contains a particular package

CORRUPT_FILES - Static variable in class cyvis.config.Warnings

CORRUPT_XSL - Static variable in class cyvis.config.ErrorMessages

corruptFileFlag - Static variable in class cyvis.config.Settings

createReport() - Method in class cyvis.ant.CyvisTask

cyclomaticComplexity - Variable in class cyvis.metric.MethodMetric

Cyvis - Class in cyvis.core

This class starts the application.

Cyvis(String[]) - Constructor for class cyvis.core.Cyvis

The options that the user provides.

cyvis.ant - package cyvis.ant

cyvis.config - package cyvis.config

cyvis.core - package cyvis.core

cyvis.gui - package cyvis.gui

cyvis.gui.charts - package cyvis.gui.charts

cyvis.metric - package cyvis.metric

cyvis.util - package cyvis.util

CyvisConsoleFormatter - Class in cyvis.util

A Custom Formatter for the loggers's console output

CyvisConsoleFormatter() - Constructor for class cyvis.util.CyvisConsoleFormatter

CyvisListCellRenderer - Class in cyvis.gui

The CyvisListCellRenderer Extends the DefaultListCellRenderer.

CyvisListCellRenderer() - Constructor for class cyvis.gui.CyvisListCellRenderer

CyvisLogFormatter - Class in cyvis.util

A Custom Formatter for the loggers's file output

CyvisLogFormatter() - Constructor for class cyvis.util.CyvisLogFormatter

CyvisTask - Class in cyvis.ant

Extends the org.apache.tools.ant.Task.

CyvisTask() - Constructor for class cyvis.ant.CyvisTask

CyvisTask.Report - Class in cyvis.ant

A class to denote the nested element for the cyvis task.

CyvisTask.Report() - Constructor for class cyvis.ant.CyvisTask.Report

E

EMPTY_PROJECT_FILE - Static variable in class cyvis.config.ErrorMessages

emptyTable() - Method in class cyvis.gui.TablePane

Used to empty the table.

emptyTree() - Method in class cyvis.gui.TreeStructure

Enpties the tree structure

ErrorMessages - Class in cyvis.config

Contains all the Error Messages Used in Cyvis.

ErrorMessages() - Constructor for class cyvis.config.ErrorMessages

execute() - Method in class cyvis.ant.CyvisTask

Overrides the execute method in the org.apache.tools.ant.Task class and performs the required actions required to generate reports.

EXIT_WITH_ERR - Static variable in class cyvis.config.ErrorMessages

F

FileChooser - Class in cyvis.gui

The FileChooser class takes care of all the file dialog needs in cyvis.

FileChooser() - Constructor for class cyvis.gui.FileChooser

fileSeparator - Static variable in class cyvis.config.Settings

FileUtil - Class in cyvis.util

FileUtil() - Constructor for class cyvis.util.FileUtil

format(LogRecord) - Method in class cyvis.util.CyvisConsoleFormatter

format(LogRecord) - Method in class cyvis.util.CyvisLogFormatter

G

generateHTML() - Static method in class cyvis.core.ReportGenerator

Generates an html report for the ProjectMetric provided.

generateReports(ArrayList<CyvisTask.Report>, String) - Static method in class cyvis.ant.AntTaskUtil

Generates the reports as specified in the report object.

generateText(ProjectMetric) - Static method in class cyvis.core.ReportGenerator

Generates an txt report for the ProjectMetric provided.

generateXML(ProjectMetric) - Static method in class cyvis.core.ReportGenerator

Generates an xml report for the ProjectMetric provided.

getArgType(String[]) - Method in class cyvis.util.ArgChecker

Parses the options and returns an integer number representing the type of options.

getClasses() - Method in class cyvis.metric.PackageMetric

get all the classes in this package

getClassMetric(InputStream) - Method in class cyvis.core.MetricExtractor

Extracts the metrics of a class and returns an ClassMetric Object containing the metrics.

getClassMetric(String, String) - Method in class cyvis.metric.ProjectMetric

Finds and returns an ClassMetric Object given the package & class names.

getColor(int) - Static method in class cyvis.gui.charts.ColorSelector

returns a color for that cyclomatic complexity

getCurrentFile() - Method in class cyvis.core.TUI

getExtractionPercentage() - Method in class cyvis.core.TUI

getFile(int) - Method in class cyvis.util.ArgChecker

Returns the name of the file given the type of file.

getHome() - Method in class cyvis.ant.CyvisTask

getListCellRendererComponent(JList, Object, int, boolean, boolean) - Method in class cyvis.gui.CyvisListCellRenderer

getLogger(String) - Static method in class cyvis.util.LogFactory

getMaximumSize() - Method in class cyvis.gui.charts.ClassChart

getMethodMetric(String) - Method in class cyvis.metric.ClassMetric

Finds and returns an MethodMetric Object given the name of the method.

getMinimumSize() - Method in class cyvis.gui.charts.ClassChart

getMinimumSize() - Method in class cyvis.gui.charts.PackageChart

getOutFile() - Method in class cyvis.ant.CyvisTask.Report

getPackageMetric(String) - Method in class cyvis.metric.ProjectMetric

returns a package with the given name

getPackages() - Method in class cyvis.metric.ProjectMetric

getPane() - Method in class cyvis.gui.TablePane

returns the table in a scrollpane

getPreferredSize() - Method in class cyvis.gui.charts.ClassChart

getPreferredSize() - Method in class cyvis.gui.charts.PackageChart

getProcessingPercentage() - Method in class cyvis.core.TUI

getSuffix(String) - Static method in class cyvis.util.FileUtil

puturns the suffix of the file

getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class cyvis.gui.TreeRenderer

Overrides the parents method.

getTreeObj() - Method in class cyvis.gui.TreeStructure

getType() - Method in class cyvis.ant.CyvisTask.Report

getValidFiles(String, String) - Static method in class cyvis.ant.AntTaskUtil

Gets all the valid files to process from the fileNames String in the class path specified.

gui - Static variable in class cyvis.gui.GUISetup

GUISetup - Class in cyvis.gui

GUISetup as the name indicates sets up the GUI for cyvis.

GUISetup() - Constructor for class cyvis.gui.GUISetup

Sets up the screen.

H

HELP - Static variable in class cyvis.config.ArgCodes

high - Static variable in class cyvis.gui.charts.ColorSelector

highColor - Static variable in class cyvis.gui.charts.ColorSelector

HTML - Static variable in class cyvis.config.ArgCodes

HTML_CREATION_ERROR - Static variable in class cyvis.config.ErrorMessages

HTML_FILE_NAME - Static variable in class cyvis.config.Settings

HTML_FILE_SET - Static variable in class cyvis.config.InfoMessages

HTML_NOT_PROVIDED - Static variable in class cyvis.config.Warnings

HTML_REPORT_CREATED - Static variable in class cyvis.config.InfoMessages

HTML_TRANSFORMATION_ERROR - Static variable in class cyvis.config.Warnings

htmlFileName - Static variable in class cyvis.config.Settings

I

IMAGE_DIR - Static variable in class cyvis.config.Settings

InfoMessages - Class in cyvis.config

Contains information Messages the used in cyvis.

InfoMessages() - Constructor for class cyvis.config.InfoMessages

INNERCLASS_LEFTOUT - Static variable in class cyvis.config.Warnings

insertUpdate(DocumentEvent) - Method in class cyvis.gui.ProjectDialog

INVALID_ARGS - Static variable in class cyvis.config.ErrorMessages

INVALID_FILESET - Static variable in class cyvis.config.Warnings

INVALID_PREFERENCES - Static variable in class cyvis.config.Warnings

INVALID_PROJECT_FILE - Static variable in class cyvis.config.ErrorMessages

INVALID_PROJECT_FILES - Static variable in class cyvis.config.Warnings

isFileReadable(String) - Static method in class cyvis.util.FileUtil

checks is a file is readable

isValidFile(String) - Static method in class cyvis.util.FileUtil

checks if the given file is a class or a jar file

isValidProjectFile(String) - Static method in class cyvis.util.FileUtil

J

JAR_PROJECT_FILE - Static variable in class cyvis.config.InfoMessages

L

LegendDialog - Class in cyvis.gui

Displays the legend for cyvis's chart panel.

LegendDialog(JFrame) - Constructor for class cyvis.gui.LegendDialog

Sets up the dialog.

length - Variable in class cyvis.metric.MethodMetric

lineSeparator - Static variable in class cyvis.config.Settings

LOG_FILE_ERR - Static variable in class cyvis.config.Warnings

LogFactory - Class in cyvis.util

Takes care of the cyvis logging needs.All the logging is done through this object

logFileName - Static variable in class cyvis.config.Settings

logger - Static variable in class cyvis.config.Settings

low - Static variable in class cyvis.gui.charts.ColorSelector

lowColor - Static variable in class cyvis.gui.charts.ColorSelector

M

main(String[]) - Static method in class cyvis.core.Cyvis

The options that the user provides.

MethodMetric - Class in cyvis.metric

This class stores the methods metrics.

MethodMetric(String, int, int) - Constructor for class cyvis.metric.MethodMetric

Constructs a ClassMetric object with the name, length and cyclomaticcomplexity provided.

methods - Variable in class cyvis.metric.ClassMetric

MetricExtractor - Class in cyvis.core

Extraction of metrics is done here.

MetricExtractor() - Constructor for class cyvis.core.MetricExtractor

METRICS_COLLECTED - Static variable in class cyvis.config.InfoMessages

MISSING_XSL - Static variable in class cyvis.config.ErrorMessages

mod - Static variable in class cyvis.gui.charts.ColorSelector

modColor - Static variable in class cyvis.gui.charts.ColorSelector

mouseClicked(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mouseClicked(MouseEvent) - Method in class cyvis.gui.charts.PackageChart

mouseDragged(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mouseEntered(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mouseEntered(MouseEvent) - Method in class cyvis.gui.charts.PackageChart

mouseExited(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mouseExited(MouseEvent) - Method in class cyvis.gui.charts.PackageChart

mouseMoved(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mousePressed(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mousePressed(MouseEvent) - Method in class cyvis.gui.charts.PackageChart

mouseReleased(MouseEvent) - Method in class cyvis.gui.charts.ClassChart

mouseReleased(MouseEvent) - Method in class cyvis.gui.charts.PackageChart

N

name - Variable in class cyvis.metric.MethodMetric

name - Variable in class cyvis.metric.PackageMetric

NO_PROJECT_FILE - Static variable in class cyvis.config.ErrorMessages

NO_PROJECT_FILE_SELECTED - Static variable in class cyvis.config.Warnings

NO_WRITE_PERMISSION - Static variable in class cyvis.config.Warnings

NOARGS - Static variable in class cyvis.config.ArgCodes

NOXML_NOHTML - Static variable in class cyvis.config.ErrorMessages

O

oneLevelUp() - Method in class cyvis.gui.TreeStructure

selects the current nodes' parent

P

PackageChart - Class in cyvis.gui.charts

Visualises the package as a series of bars.

PackageChart(PackageMetric, int, int) - Constructor for class cyvis.gui.charts.PackageChart

PackageMetric - Class in cyvis.metric

Holds a particular packages's metrics.

PackageMetric(String) - Constructor for class cyvis.metric.PackageMetric

Default constructor

packageName - Variable in class cyvis.metric.ClassMetric

paintComponent(Graphics) - Method in class cyvis.gui.charts.ClassChart

paintComponent(Graphics) - Method in class cyvis.gui.charts.PackageChart

parseTextFile(String) - Static method in class cyvis.util.FileUtil

pathSeparator - Static variable in class cyvis.config.Settings

PreferencesDialog - Class in cyvis.gui

The dialog that lets users change preferences.

PreferencesDialog(JFrame) - Constructor for class cyvis.gui.PreferencesDialog

Sets up the dialog.

printHelp() - Method in class cyvis.util.ArgChecker

Prints the Usage.

processMetrics(ProjectMetric) - Method in class cyvis.core.TUI

Processes the metrics collected.

ProgressBar - Class in cyvis.gui

Progress bar to show the percentage of metrics extraction and processed.

ProgressBar(TUI, JFrame) - Constructor for class cyvis.gui.ProgressBar

Sets up the extraction dialog

PROJ_FILENAME_VALID - Static variable in class cyvis.config.InfoMessages

PROJ_READABLE - Static variable in class cyvis.config.InfoMessages

PROJECT - Static variable in class cyvis.config.ArgCodes

project - Static variable in class cyvis.config.Settings

PROJECT_AND_HTML - Static variable in class cyvis.config.ArgCodes

PROJECT_AND_TXT - Static variable in class cyvis.config.ArgCodes

PROJECT_AND_VERBOSE - Static variable in class cyvis.config.ArgCodes

PROJECT_AND_XML - Static variable in class cyvis.config.ArgCodes

PROJECT_FILE_CORRUPT - Static variable in class cyvis.config.ErrorMessages

PROJECT_FILE_SET - Static variable in class cyvis.config.InfoMessages

PROJECT_HTML_VERBOSE - Static variable in class cyvis.config.ArgCodes

PROJECT_TXT_VERBOSE - Static variable in class cyvis.config.ArgCodes

PROJECT_XML_VERBOSE - Static variable in class cyvis.config.ArgCodes

ProjectDialog - Class in cyvis.gui

The dialog used to create a new project and edit an existing project.

ProjectDialog(String, JFrame) - Constructor for class cyvis.gui.ProjectDialog

The default constructor used to create a new project

ProjectDialog(File, JFrame) - Constructor for class cyvis.gui.ProjectDialog

This constructor is called in open/edit mode with the name of the project file to read.

projectFile - Static variable in class cyvis.config.Settings

projectFileName - Static variable in class cyvis.config.Settings

ProjectMetric - Class in cyvis.metric

This class stores a list of class's metrics.

ProjectMetric(ArrayList<ClassMetric>) - Constructor for class cyvis.metric.ProjectMetric

Constructs a ProjectMetric object with the list of ClassMetric provided.

projectName - Static variable in class cyvis.config.Settings

PROPER_EXIT - Static variable in class cyvis.config.InfoMessages

R

removeUpdate(DocumentEvent) - Method in class cyvis.gui.ProjectDialog

REPORT_CREATION_ERROR - Static variable in class cyvis.config.Warnings

reportDir - Static variable in class cyvis.config.Settings

ReportGenerator - Class in cyvis.core

This class generates the reports.

ReportGenerator() - Constructor for class cyvis.core.ReportGenerator

ReportThread - Class in cyvis.gui

A seperate class the generates the reports the user wants in a seperate thead.

ReportThread(String) - Constructor for class cyvis.gui.ReportThread

run() - Method in class cyvis.core.TUI

Start a tread and continues extracting the metrics followed by processing of the metrics collected.

run() - Method in class cyvis.gui.ReportThread

seperate thread to generate report.

S

SELECT_PROJECT_FILE - Static variable in class cyvis.config.Warnings

selectDirectory(JDialog) - Static method in class cyvis.gui.FileChooser

Enables users to select a directory.

selectFiles(JDialog) - Static method in class cyvis.gui.FileChooser

Enables to select class and jar files & returns an arraylist of the files selected.

selectProjectFile(JFrame) - Static method in class cyvis.gui.FileChooser

Enables users to select the project file.

selectRoot() - Method in class cyvis.gui.TreeStructure

Selects the root node

setFocus() - Method in class cyvis.gui.TreeStructure

Sets focus on the tree

setHome(String) - Method in class cyvis.ant.CyvisTask

setOutFile(String) - Method in class cyvis.ant.CyvisTask.Report

setSelected(PackageMetric) - Method in class cyvis.gui.TreeStructure

Selects the given package in the tree

setSelected(ClassMetric, PackageMetric) - Method in class cyvis.gui.TreeStructure

Selects the given class in the given package

Settings - Class in cyvis.config

A very important class, it holds all the runtime environment variables.

Settings() - Constructor for class cyvis.config.Settings

setType(String) - Method in class cyvis.ant.CyvisTask.Report

setUpScreen(boolean) - Method in class cyvis.gui.GUISetup

Sets up the default screen.Also sets up the tree, table and the chart panel if a project has been created.

setVerbose(boolean) - Static method in class cyvis.ant.AntTaskUtil

Sets the verbose on and off

setVerbose(boolean) - Method in class cyvis.ant.CyvisTask

size - Variable in class cyvis.metric.ClassMetric

sortPackages() - Method in class cyvis.metric.ProjectMetric

T

tablePane - Variable in class cyvis.gui.GUISetup

TablePane - Class in cyvis.gui

Generates a table that displays the metrics.

TablePane() - Constructor for class cyvis.gui.TablePane

TEXT_FILE_NAME - Static variable in class cyvis.config.Settings

textFileName - Static variable in class cyvis.config.Settings

TreeRenderer - Class in cyvis.gui

Renders the tree structure to change the default icons.

TreeRenderer() - Constructor for class cyvis.gui.TreeRenderer

Default constructor

treeStructure - Variable in class cyvis.gui.GUISetup

TreeStructure - Class in cyvis.gui

A Class that holds the tree structure, displaying the project's packages and classes.

TreeStructure() - Constructor for class cyvis.gui.TreeStructure

Default constructor, sets up the tree

TUI - Class in cyvis.core

This class takes care of the Command Line operations of CyVis.

TUI() - Constructor for class cyvis.core.TUI

TXT - Static variable in class cyvis.config.ArgCodes

TXT_FILE_SET - Static variable in class cyvis.config.InfoMessages

TXT_NOT_PROVIDED - Static variable in class cyvis.config.Warnings

TXT_PROJECT_FILE - Static variable in class cyvis.config.InfoMessages

TXT_REPORT_CREATED - Static variable in class cyvis.config.InfoMessages

U

UNABLE_TO_PROCESS - Static variable in class cyvis.config.Warnings

UNREADABLE_PROJECT_FILE - Static variable in class cyvis.config.ErrorMessages

updateChart(ProjectMetric) - Method in class cyvis.gui.charts.ChartPane

Updates the chart and displays the project level view

updateChart(PackageMetric) - Method in class cyvis.gui.charts.ChartPane

Updates the chart and displays the package level view

updateChart(ClassMetric) - Method in class cyvis.gui.charts.ChartPane

Displays the class level view for the given class.

updateTable(ProjectMetric) - Method in class cyvis.gui.TablePane

Updates the table to show the project level information

updateTable(PackageMetric) - Method in class cyvis.gui.TablePane

Updates the table to show the package level information

updateTable(ClassMetric) - Method in class cyvis.gui.TablePane

Updates the table to show the class level information

updateTree(ArrayList<PackageMetric>) - Method in class cyvis.gui.TreeStructure

Updates the tree

V

validFiles - Static variable in class cyvis.config.Settings

VERBOSE - Static variable in class cyvis.config.ArgCodes

verboseMode - Static variable in class cyvis.config.Settings

VERSION - Static variable in class cyvis.config.ArgCodes

VERSION - Static variable in class cyvis.config.Settings

W

Warnings - Class in cyvis.config

Contains all the warning messages used in cyvis.

Warnings() - Constructor for class cyvis.config.Warnings

writeFile(String, String) - Static method in class cyvis.core.ReportGenerator

X

XML - Static variable in class cyvis.config.ArgCodes

XML_FILE_NAME - Static variable in class cyvis.config.Settings

XML_FILE_SET - Static variable in class cyvis.config.InfoMessages

XML_NOT_PROVIDED - Static variable in class cyvis.config.Warnings

XML_REPORT_CREATED - Static variable in class cyvis.config.InfoMessages

xmlFileName - Static variable in class cyvis.config.Settings

XSL_FILE_NAME - Static variable in class cyvis.config.Settings

xslFileName - Static variable in class cyvis.config.Settings

Z

zoom() - Method in class cyvis.gui.TreeStructure

Triggers a selection change

A C E F G H I J L M N O P R S T U V W X Z