FanInFanOut

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val DEFAULT_faninCategories: Int
val DEFAULT_faninCategorySize: Double
val DEFAULT_fanoutCategories: Int
val DEFAULT_fanoutCategorySize: Double
val DEFAULT_ratioCategories: Int
val DEFAULT_ratioCategorySize: Double
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val configPrefix: String
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val faninCategories: String
val faninCategorySize: String
val faninFeatureName: String
val fanoutCategories: String
val fanoutCategorySize: String
val fanoutFeatureName: String
def featureIDs: Seq[String]

The unique ids of the extracted features.
The unique ids of the extracted features.

Definition Classes
FanInFanOut → FeatureQuery
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val ratioCategories: String
val ratioCategorySize: String
val ratioFeatureName: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package queries

object FanInFanOut extends FeatureQuery

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val DEFAULT_faninCategories: Int

val DEFAULT_faninCategorySize: Double

val DEFAULT_fanoutCategories: Int

val DEFAULT_fanoutCategorySize: Double

val DEFAULT_ratioCategories: Int

val DEFAULT_ratioCategorySize: Double

def apply[S](projectConfiguration: ProjectConfiguration, project: Project[S], rawClassFiles: Traversable[(ClassFile, S)]): TraversableOnce[Feature[S]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val configPrefix: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val faninCategories: String

val faninCategorySize: String

val faninFeatureName: String

val fanoutCategories: String

val fanoutCategorySize: String

val fanoutFeatureName: String

def featureIDs: Seq[String]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val htmlDescription: Either[String, URL]

val id: String

final def isInstanceOf[T0]: Boolean

final def isInterrupted(): Boolean

def mdDescription: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val ratioCategories: String

val ratioCategorySize: String

val ratioFeatureName: String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from FeatureQuery

Inherited from AnyRef

Inherited from Any

Ungrouped