de.cau.cs.kieler.kiml.grana
Class AbstractInfoAnalysis

java.lang.Object
  extended by de.cau.cs.kieler.kiml.grana.AbstractInfoAnalysis
All Implemented Interfaces:
IDepending<String>, IAnalysis
Direct Known Subclasses:
AbstractSimpleInfoAnalysis

public abstract class AbstractInfoAnalysis
extends Object
implements IAnalysis, IDepending<String>

Analyses that derive from this class are required to provide an id, name and description. A category, strong and weak dependencies are optional.

Rating red

Constructor Summary
AbstractInfoAnalysis()
           
 
Method Summary
 String getCategory()
          Returns the analysis category.
 List<Pair<String,String>> getComponents()
          Returns the components, in the form of name/abbreviation pairs, the results of this analysis consist of.
 List<Dependency<String>> getDependencies()
          Returns a list of dependencies.
abstract  String getDescription()
          Returns the analysis description.
abstract  String getId()
          Returns the analysis id.
abstract  String getName()
          Returns the analysis name.
 boolean isHelper()
          Returns whether this analysis is a helper analysis.
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.cau.cs.kieler.kiml.grana.IAnalysis
doAnalysis
 

Constructor Detail

AbstractInfoAnalysis

public AbstractInfoAnalysis()
Method Detail

getId

public abstract String getId()
Returns the analysis id. Has to be unique among all provided analyses.

Specified by:
getId in interface IDepending<String>
Returns:
the id

getName

public abstract String getName()
Returns the analysis name.

Returns:
the name

getDescription

public abstract String getDescription()
Returns the analysis description.

Returns:
the description

isHelper

public boolean isHelper()
Returns whether this analysis is a helper analysis.

Returns:
true if this analysis is a helper analysis

getCategory

public String getCategory()
Returns the analysis category.

Returns:
the category id

getComponents

public List<Pair<String,String>> getComponents()
Returns the components, in the form of name/abbreviation pairs, the results of this analysis consist of.

Returns:
the components

getDependencies

public List<Dependency<String>> getDependencies()
Returns a list of dependencies.

Specified by:
getDependencies in interface IDepending<String>
Returns:
the list of dependencies or null if the object has no dependencies

toString

public String toString()

Overrides:
toString in class Object