class Helper[P, R] extends StrictLogging
Manages the ongoing state for a task with a particular HIT type; keeps track of HITs and assignments that are active, saved, etc. and gives convenience methods for interfacing with Turk.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Helper
- StrictLogging
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new Helper(taskSpec: TaskSpecification { ... /* 2 definitions in type refinement */ })(implicit promptReader: upickle.default.Reader[P], responseReader: upickle.default.Reader[R], responseWriter: upickle.default.Writer[R], config: TaskConfig)
Type Members
-
class
AssignmentInReview extends AnyRef
Represents an assignment waiting for a reviewing result.
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
- def activeHITInfos(p: Prompt): List[HITInfo[Prompt, Response]]
- def activeHITInfosByPromptIterator: Iterator[(Prompt, List[HITInfo[Prompt, Response]])]
- def allCurrentHITInfos(p: Prompt): List[HITInfo[Prompt, Response]]
- def allCurrentHITInfosByPromptIterator: Iterator[(Prompt, List[HITInfo[Prompt, Response]])]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- implicit val config: TaskConfig
-
def
createHIT(prompt: Prompt, numAssignments: Int): Try[HIT[Prompt]]
Create a HIT with the specific parameters.
Create a HIT with the specific parameters. This should be used in order to ensure the helper has a consistent state.
- def deleteAll: Unit
-
def
deleteHIT(hit: HIT[Prompt]): Unit
Deletes a HIT (if possible) and takes care of bookkeeping.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
evaluateAssignment(hit: HIT[Prompt], aInRev: AssignmentInReview, evaluation: AssignmentEvaluation): Unit
Process and record the result of reviewing an assignment.
- def expireAll: Unit
- def expireHIT(hit: HIT[Prompt]): Unit
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def finishedHITInfos(p: Prompt): List[HITInfo[Prompt, Response]]
- def finishedHITInfosByPromptIterator: Iterator[(Prompt, List[HITInfo[Prompt, Response]])]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getInReview(assignmentId: String): Option[AssignmentInReview]
- def getInReview(assignment: Assignment[Response]): Option[AssignmentInReview]
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isActive(hitId: String): Boolean
- def isActive(hit: HIT[Prompt]): Boolean
- def isActive(prompt: Prompt): Boolean
- def isInReview(assignmentId: String): Boolean
- def isInReview(assignment: Assignment[Response]): Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
logger: Logger
- Attributes
- protected
- Definition Classes
- StrictLogging
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def numActiveHITs: Int
- def numAssignmentsInReview: Int
- implicit val promptReader: upickle.default.Reader[P]
- implicit val responseReader: upickle.default.Reader[R]
- implicit val responseWriter: upickle.default.Writer[R]
-
def
startReviewing(assignment: Assignment[Response]): AssignmentInReview
Mark an assignment as under review.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val taskSpec: TaskSpecification { ... /* 2 definitions in type refinement */ }
-
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
- @native() @throws( ... )
- object Message