Packages

package root

Definition Classes: root

package ch

Definition Classes: root

package usi

Definition Classes: ch

package inf

Definition Classes: usi

package reveal

Definition Classes: inf

package parsing

Definition Classes: reveal

package units

Provides classes representing information units (structured and textual units) and meta information (like tf vectors and type mentions).

Overview

Information units (implementing the trait InformationUnit) represent paragraphs in a given document, which can be narrative text (NaturalLanguageTaggedUnit) or structured fragments (CodeTaggedUnit). Each information unit exports a set of meta-information (implementing the MetaInformation trait), which are ready made semantic data for simple analyses. This version of StORMeD provides the following meta-information:

NaturalLanguageMetaInformation for a natural language view of the information unit (can be used also for code);
CodeTypesMetaInformation providing the mentioned types in the unit;
CodeVariablesMetaInformation providing the mentioned variables;
CodeInvocationMetaInformation providing the invoked methods in the unit.

In the case a meta information is not provided for a unit, a AbsentMetaInformation object can be also provided.

Tutorial

Suppose you want to get all the types mentioned in a question. First, you retrieve all its information units:

scala> val questionUnits = question.units
questionUnits: Seq[ch.usi.inf.reveal.parsing.units.InformationUnit] = ...

Instead of using the visitor to on all the HASTs, you can exploit the ready made data provided by the meta information. For example, to get all the meta information for units, you can use flatMap:

scala> import ch.usi.inf.reveal.parsing.units._
import ch.usi.inf.reveal.parsing.units._

scala> val questionMetaInfos = questionUnits.flatMap { _.metaInformation }
questionMetaInfos: Seq[ch.usi.inf.reveal.parsing.units.MetaInformation] = List(...)

You need now to filter to get only the CodeTypesMetaInformation, and then you can get, for example, the mentioned qualified Types:

scala> val codeTypesMetaInfos = questionMetaInfos.filter { _.isInstanceOf[CodeTypesMetaInformation] }.asInstanceOf[Seq[CodeTypesMetaInformation]]
codeTypesMetaInfos: Seq[ch.usi.inf.reveal.parsing.units.CodeTypesMetaInformation] = List(...)

scala> val types = codeTypesMetaInfos.flatMap { _.qualifiedTypes }.distinct
types: Seq[ch.usi.inf.reveal.parsing.model.java.ReferenceTypeNode] = List(...)

Definition Classes: parsing

package meta

Definition Classes: units

package similarity

Definition Classes: units

AbsentMetaInformation

CodeIdentifiersMetaInformation

CodeIdentifiersMetaInformationBuilder

CodeInvocationMetaInformation

CodeInvocationMetaInformationBuilder

CodeMethodDeclarationsMetaInformation

CodeMethodDeclarationsMetaInformationBuilder

CodeReadabilityMetaInformation

CodeReadabilityMetaInformationBuilder

CodeTaggedUnit

CodeTypeDeclarationsMetaInformation

CodeTypeDeclarationsMetaInformationBuilder

CodeTypesMetaInformation

CodeTypesMetaInformationBuilder

CodeVariablesMetaInformation

CodeVariablesMetaInformationBuilder

InformationUnit

InformationUnit2MetaInformationBuilder

JsonMembersMetaInformationBuilder

JsonMetaInformation

MetaInformation

MetaInformationBuilder

MetaInformationBuilderParameters

NaturalLanguageMetaInformation

NaturalLanguageMetaInformationBuilder

NaturalLanguageTaggedUnit

SentimentAnalysisMetaInformation

SentimentAnalysisMetaInformationBuilder

TextReadabilityMetaInformation

TextReadabilityMetaInformationBuilder

XmlTagsMetaInformation

XmlTagsMetaInformationBuilder

ch.usi.inf.reveal.parsing.units

InformationUnit

Companion object InformationUnit

sealed trait InformationUnit extends JsonSerializable

A generic trait for information units.

Linear Supertypes

JsonSerializable, AnyRef, Any

Known Subclasses

CodeTaggedUnit, NaturalLanguageTaggedUnit

Ordering

Alphabetic
By Inheritance

Inherited

InformationUnit
JsonSerializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract val astNode: HASTNode
The HASTNode for the unit.
abstract def bindMetaInformation(otherMetaInformation: Seq[MetaInformation[_]]): InformationUnit
Binds the meta informations for this unit.
abstract val id: String
A unique id for the information unit.
abstract val metaInformation: Seq[MetaInformation[_]]
The sequence of available MetaInformation for the unit.
abstract val rawText: String
The raw text of the unit.
abstract val source: SourceInfo
The source info for the unit.

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

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

Definition Classes
Any
lazy val metaInformationTypes: Seq[scala.reflect.api.JavaUniverse.TypeTag[_]]
The sequence of meta information types available for the unit.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
InformationUnit → AnyRef → Any
def type2metaInformation[T <: MetaInformation[T]](implicit tag: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]
Given a type of a meta information, returns the corresponding meta information object, if it exists.
Given a type of a meta information, returns the corresponding meta information object, if it exists.
T
the type of the meta information to retrieve.
returns
an optional meta information object of the given type.
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( ... )

Packages

Overview

Tutorial

InformationUnit

Companion object InformationUnit

sealed trait InformationUnit extends JsonSerializable

Abstract Value Members

Concrete Value Members

Inherited from JsonSerializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Overview

Tutorial

InformationUnit 

Companion object InformationUnit

sealed trait InformationUnit extends JsonSerializable

Abstract Value Members

Concrete Value Members

Inherited from JsonSerializable

Inherited from AnyRef

Inherited from Any

Ungrouped

InformationUnit