< Back

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 artifact
Provides classes for dealing with Stack Overflow artifacts.
Provides classes for dealing with Stack Overflow artifacts.
It also provides means to serialize and deserialize them from JSON files.
Tutorial
The main class to consider is ch.usi.inf.reveal.parsing.artifact.StackOverflowArtifact, representing a Stack Overflow discussion.
The main way to obtain a Stack Overflow discussion is to deserialize it froma JSON file, using ArtifactSerializer.
```
import ch.usi.inf.reveal.parsing.artifact._
val jsonFilePath = /*path to json file*/
val serializer = new ArtifactSerializer()
val discussion = serializer.deserializeFromFile(jsonFilePath)
```
You can now inspect the discussion, for example by getting the question (a StackOverflowQuestion object) or answers (a seq of StackOverflowAnswer):
```
scala> val question = discussion.question
question: ch.usi.inf.reveal.parsing.artifact.StackOverflowQuestion = ...

scala> val answers = discussion.answers
answers: Seq[ch.usi.inf.reveal.parsing.artifact.StackOverflowAnswer] = ...
```
The way to get the object representing the poster of the question (a StackOverflowUser) is the following:
```
scala> val posterUser = question.owner
posterUser: Option[ch.usi.inf.reveal.parsing.artifact.StackOverflowUser] = Some(StackOverflowUser(...))
```
You can also easily get the comments (objects of StackOverflowComment), for example the ones posted for the question:
```
scala> val questionComments = question.comments
questionComments: Seq[ch.usi.inf.reveal.parsing.artifact.StackOverflowComment] = ...
```
The easy way to get all information units (ch.usi.inf.reveal.parsing.units.InformationUnit) and the HASTs (classes implementing the ch.usi.inf.reveal.parsing.model.HASTNode trait) for an element (question or answer or comment) is:
```
scala> val allUnits = discussion.units
allUnits: Seq[ch.usi.inf.reveal.parsing.units.InformationUnit] = List(...)

scala> val astNodes = allUnits.map { _.astNode }
astNodes: Seq[ch.usi.inf.reveal.parsing.model.ASTNode] =
```
For further information about the information units, the HAST and the model, please check the documentation of ch.usi.inf.reveal.parsing.model and ch.usi.inf.reveal.parsing.units.
Definition Classes
parsing
Artifact
ArtifactSerializer
DateSerializer
SourceInfo
StackOverflowAnswer
StackOverflowArtifact
StackOverflowComment
StackOverflowElement
StackOverflowPost
StackOverflowQuestion
StackOverflowUser
XmlSourceInfo

c

ch.usi.inf.reveal.parsing.artifact

StackOverflowUser

case class StackOverflowUser(id: Int, acceptRate: Option[Int], displayName: String, link: Option[String], profileImage: Option[String], reputation: Int, userType: Option[String]) extends JsonSerializable with Product with Serializable

A Stack Overflow user as present in the dump.

id: the id of the user as present in the dump.
acceptRate: the rate of accepted answers for this user.
displayName: the display name for the user.
link: an optional URL for the user page.
profileImage: an optional profile image URL for the user
reputation: the user reputation.
userType: an optional string representing the user type (one of unregistered, registered, moderator, or does_not_exist, if defined).

See also: Stack Overflow User API documentation

Linear Supertypes

Serializable, Serializable, Product, Equals, JsonSerializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

StackOverflowUser
Serializable
Serializable
Product
Equals
JsonSerializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new StackOverflowUser(id: Int, acceptRate: Option[Int], displayName: String, link: Option[String], profileImage: Option[String], reputation: Int, userType: Option[String])
Constructs a new Stack Overflow user.
Constructs a new Stack Overflow user.
id
the id of the user as present in the dump.
acceptRate
the rate of accepted answers for this user.
displayName
the display name for the user.
link
an optional URL for the user page.
profileImage
an optional profile image URL for the user
reputation
the user reputation.
userType
an optional string representing the user type (one of unregistered, registered, moderator, or does_not_exist, if defined).

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 acceptRate: Option[Int]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val id: Int
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val link: Option[String]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val profileImage: Option[String]
val reputation: Int
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val userType: Option[String]
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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from JsonSerializable

Inherited from AnyRef

Inherited from Any

Ungrouped