c

org.opalj.hermes.queries

FanInFanOut

class FanInFanOut extends FeatureQuery

This metric computes the Fan-In and Fan-Out of a class.

Linear Supertypes
FeatureQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FanInFanOut
  2. FeatureQuery
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FanInFanOut()(implicit hermes: HermesConfig)

Type Members

  1. case class FeatureConfiguration(featureName: String, numCategories: Int, categorySize: Double, offset: Int) extends Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DEFAULT_faninCategories: Int
  5. val DEFAULT_faninCategorySize: Double
  6. val DEFAULT_fanoutCategories: Int
  7. val DEFAULT_fanoutCategorySize: Double
  8. val DEFAULT_ratioCategories: Int
  9. val DEFAULT_ratioCategorySize: Double
  10. final val FanInFanOutConfigPrefix: String("org.opalj.hermes.queries.FanInFanOut")
  11. def apply[S](projectConfiguration: ProjectConfiguration, project: Project[S], rawClassFiles: Traversable[(ClassFile, S)]): TraversableOnce[Feature[S]]

    The function which analyzes the project and extracts the feature information.

    The function which analyzes the project and extracts the feature information.

    project

    A representation of the project. To speed up queries, intermediate information that may also be required by other queries can/should be stored in the project using the org.opalj.fpcf.PropertyStore or using a org.opalj.br.analyses.ProjectInformationKey.

    rawClassFiles

    A direct 1:1 representation of the class files. This makes it possible to write queries that need to get an understanding of an unprocessed class file; e.g. that need to analyze the constant pool in detail.

    Definition Classes
    FanInFanOut → FeatureQuery
    Note

    Every query should regularly check that its thread is not interrupted using isInterrupted.

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. val faninCategories: String
  17. val faninCategorySize: String
  18. val faninFeatureName: String
  19. val fanoutCategories: String
  20. val fanoutCategorySize: String
  21. val fanoutFeatureName: String
  22. def featureIDs: Seq[String]

    The unique ids of the extracted features.

    The unique ids of the extracted features.

    Definition Classes
    FanInFanOut → FeatureQuery
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. val htmlDescription: Either[String, URL]

    Returns an HTML description of this feature query that is targeted at end users; by default it calls mdDescription to try to find a markdown document that describes this feature and then uses TxtMark to convert the document.

    Returns an HTML description of this feature query that is targeted at end users; by default it calls mdDescription to try to find a markdown document that describes this feature and then uses TxtMark to convert the document. If a document is returned the web engine's user style sheet is set to org.opalj.hermes.FeatureQueries.MDCSS; in case of an URL no stylesheet is set.

    returns

    An HTML document/a link to an HTML document that describes this query.

    Definition Classes
    FeatureQuery
  26. val id: String

    A short descriptive name; by default the simple name of this class.

    A short descriptive name; by default the simple name of this class.

    Definition Classes
    FeatureQuery
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def isInterrupted(): Boolean

    Queries should regularly check if they are interrupted using this method.

    Queries should regularly check if they are interrupted using this method.

    Definition Classes
    FeatureQuery
  29. def mdDescription: String

    Returns an explanation of the feature (group) using Markdown as its formatting language.

    Returns an explanation of the feature (group) using Markdown as its formatting language.

    By default the name of the class is used to lookup the resource "className.markdown" which is expected to be found along the extractor.

    Attributes
    protected
    Definition Classes
    FeatureQuery
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. val ratioCategories: String
  34. val ratioCategorySize: String
  35. val ratioFeatureName: String
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. object FeatureConfiguration extends Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from FeatureQuery

Inherited from AnyRef

Inherited from Any

Ungrouped