Package com.ensoftcorp.open.commons.analyzers

Class Analyzer

  • Direct Known Subclasses:
    Property
    public abstract class Analyzer
extends java.lang.Object
    A base class for implementing program analyzers
    Author:
    Ben Holland

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Analyzer.Result
      Just a pair class to hold a display name and the result Note: display name does not need to be unique

    • Constructor Summary

      Constructors 
      Constructor Description
      Analyzer()  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static com.ensoftcorp.atlas.core.query.Q getAllResults​(java.util.List<Analyzer.Result> results)
      Returns a union of all results
      java.lang.String[] getAssumptions()
      Returns an array of assumptions made when writing the analyzer
      abstract java.lang.String getCategory()
      A category to classify this analyzer under
      java.lang.String[] getCodemapStageDependencies()
      Optionally specifies a set of code map stage dependencies
      abstract java.lang.String getDescription()
      Returns a short description of the analyzer
      com.ensoftcorp.atlas.core.markup.Markup getMarkup()
      Returns markup for the analyzer result
      java.util.Map<java.awt.Color,​java.lang.String> getMarkupKey()
      Returns a color key legend to interpret the markup results
      java.lang.String getName()
      Returns a name of the analyzer
      java.util.Comparator<Analyzer.Result> getResultOrder()
      Defines the sorted ordering for the results (by label)
      abstract java.util.List<Analyzer.Result> getResults​(com.ensoftcorp.atlas.core.query.Q context)
      Return analyzer's labeled results Results are for results within a given context
      int hashCode()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Analyzer

        public Analyzer()

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getName

        public java.lang.String getName()
        Returns a name of the analyzer
        Returns:

      • getCategory

        public abstract java.lang.String getCategory()
        A category to classify this analyzer under
        Returns:

      • getDescription

        public abstract java.lang.String getDescription()
        Returns a short description of the analyzer
        Returns:

      • getCodemapStageDependencies

        public java.lang.String[] getCodemapStageDependencies()
        Optionally specifies a set of code map stage dependencies
        Returns:

      • getAssumptions

        public java.lang.String[] getAssumptions()
        Returns an array of assumptions made when writing the analyzer
        Returns:

      • getResults

        public abstract java.util.List<Analyzer.Result> getResults​(com.ensoftcorp.atlas.core.query.Q context)
        Return analyzer's labeled results Results are for results within a given context
        Returns:

      • getResultOrder

        public java.util.Comparator<Analyzer.Result> getResultOrder()
        Defines the sorted ordering for the results (by label)
        Returns:

      • getAllResults

        public static com.ensoftcorp.atlas.core.query.Q getAllResults​(java.util.List<Analyzer.Result> results)
        Returns a union of all results
        Returns:

      • getMarkup

        public com.ensoftcorp.atlas.core.markup.Markup getMarkup()
        Returns markup for the analyzer result
        Returns:

      • getMarkupKey

        public java.util.Map<java.awt.Color,​java.lang.String> getMarkupKey()
        Returns a color key legend to interpret the markup results
        Returns: