org.assistments.domain.content.tutor

Class TutorStrategies

java.lang.Object

org.assistments.domain.content.tutor.Persistable

org.assistments.domain.content.tutor.Manifest

org.assistments.domain.content.tutor.TutorStrategies

All Implemented Interfaces:

HasFeedbackKey, HasTutoring, HasUID, IsManifest<Manifest,Manifest>, IsPersistable, SelfValidating

public class TutorStrategies
extends Manifest

TutorStrategies is a manifest containing tutoring assistance for a particular piece of assessment content.

Although TutorStrategies can be used when assessment content contains a single piece of assistance content, TutorStrategies is intended for associating multiple Tutoring Strategies (see Description here) with a piece of assessment content.

For example: If an AnswerableProblem has assistance in the form a Hints and Scaffolding, you would add them individually to a TutorStrategies by calling addChildManifest(Manifest) once for each strategy.

If there are multiple Tutoring Strategies of the same type - for example you have alternate hint sets for a single problem - you can add both sets to a single TutorStrategies.

In the case of multiple Tutoring Strategies, by default TutorStrategies randomly selects one of the strategy types. When a single strategy type has multiple alternatives (eg: multiple hint sets), by default TutorStrategies randomly selects one of the sets.

You can attach TutorStrategies to assessment content by calling setTutoringKey(tutorStrategiesInstance) on the Manifest representing that assessment content. For example the Manifest representing an AnswerableProblem, or perhaps the Manifest representing an ProblemSet (to make that tutoring the default for the Problem Set).

You can also attach assistance content directly to Answers by calling Answer#setTutoringKey(Manifest) or Answer#setTutoringKey(String). For an incorrect Answer, assistance content might be in the form of a FeedbackMessage. However you are free to attach any kind of assistance content, including a TutorStrategies instance, to an Answer.

The following diagram provides details the class hierarchy of TutorStrategies:

Field Summary

Fields inherited from class org.assistments.domain.content.tutor.Manifest

childManifests, propertyKeysForSimpleClassName

Constructor Summary

Constructors

Constructor and Description
TutorStrategies(java.lang.String uid)

Method Summary

Modifier and Type	Method and Description
void	addChildManifest(Manifest child) Adds a child to this TutorStrategy.
TutorStrategyType	discoverTutorStrategyType(Manifest tutoringSetManifest) Returns the type of tutoring contained in a Tutoring Set.
java.util.List<java.lang.String>	flatten() Returns a list of Persistence Keys for all of objects referenced by this manifest.
int	getChildCount() Returns the number of children manifests
java.util.List<Manifest>	getChildManifests() Returns the children of this manifest.
static java.lang.String	getClassName()
Manifest	getHints()
Manifest	getNextPreferredTutoring() Returns the next available preferred tutoring content.
Manifest	getScaffolding()
Manifest	getTutoringOfType(TutorStrategyType type)
java.util.List<TutorStrategyType>	getTutoringOrder()
Manifest	getURLLinks()
Manifest	getWorkedExamples()
void	setChildManifests(java.util.List<Manifest> childManifests) Specifies a list of children manifests for this manifest.
void	setTutoringOrder(java.util.List<TutorStrategyType> types)
void	setTutoringOrder(TutorStrategyType... types)
java.lang.String	toString() Returns a string representation of this object.
java.lang.String	toString(java.lang.String indent)

Methods inherited from class org.assistments.domain.content.tutor.Manifest

addProperty, addProperty, addProperty, addProperty, feedBackKeyExists, getAllDescendantProblemManifests, getAllDescendants, getBooleanProperty, getChildManifest, getChildrenContentKeys, getContentAttributes, getContentKey, getContentType, getDescendantManifest, getDescendantProblemCount, getFeedbackKey, getIntProperty, getNavigatorClass, getParent, getProperties, getRoot, getSkillIds, getStringProperty, getTerminatorClass, getTutoringAttributes, getTutoringKey, getTutoringType, hasChildManifestKey, hasChildManifestWithTutoringKey, hasDescendant, hasDescendant, hasDescendantWithTutoringKey, isContentType, isNavigatorType, isProblem, isProblemSet, isScaffolding, isSet, isSkillBuilderProblem, isTerminatorType, isTutoringItem, isTutoringSet, isTutoringType, setContentKey, setContentKey, setFeedbackKey, setParent, setProperties, setTutoringKey, setTutoringKey, toDTO, toStringSummary, toStringSummary, toStringSummary, validate

Methods inherited from class org.assistments.domain.content.tutor.Persistable

createKey, createKey, equals, extractType, extractUID, getKey, getShortKey, getShortKey, getType, getUID, getValidatorUtilities, setValidatorUtilities, validateKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TutorStrategies

public TutorStrategies(java.lang.String uid)

Method Detail

getClassName

public static java.lang.String getClassName()

getChildCount

public int getChildCount()

Description copied from interface: IsManifest

Returns the number of children manifests

Specified by:

getChildCount in interface IsManifest<Manifest,Manifest>

Overrides:

getChildCount in class Manifest

getChildManifests

public java.util.List<Manifest> getChildManifests()

Description copied from interface: IsManifest

Returns the children of this manifest.

Specified by:

getChildManifests in interface IsManifest<Manifest,Manifest>

Overrides:

getChildManifests in class Manifest

Returns:

A list of child manifests

setChildManifests

public void setChildManifests(java.util.List<Manifest> childManifests)

Description copied from interface: IsManifest

Specifies a list of children manifests for this manifest. setChildManifests() replaces any existing children.

The implementing class may choose to manipulate childManifests in such a way that requires the creation of additional persistable data. For example: An IsManifest class might choose to group the children based on the type of skill represented by each referenced assessment content. In that scenario, the setChildManifests() implementation might further choose to create a new manifest for each skill and insert into that new manifest the subset of childManifests containing that skill. In this case, setChildManifests() needs to alert the caller to the presence of generated objects through the return value.

Specified by:

setChildManifests in interface IsManifest<Manifest,Manifest>

Overrides:

setChildManifests in class Manifest

Parameters:

childManifests - A list of child manifests

addChildManifest

public void addChildManifest(Manifest child)

Adds a child to this TutorStrategy.

You may add at most one child Manifest of each TutorStrategyType. For example: if you have two Manifests representing alternate Hint Sets you cannot call addChildManifest() twice - once for each Manifest.

Instead, you must do the following to create a new parent Manifest representing a TutoringSet with two TutoringSet children:

1. Create a new parent TutoringSet.

2. Create a new parent Manifest.

3. Call Manifest.setContentKey() with the TutoringSet as the argument.

4. Call Manifest.addChildManifest() with the Manifest of alternate Hint Set 1.

5. Call Manifest.addChildManifest() with the Manifest of alternate Hint Set 2.

The newly created parent Manifest can now be added to this TutorStrategies manifest by calling this method.

Specified by:

addChildManifest in interface IsManifest<Manifest,Manifest>

Overrides:

addChildManifest in class Manifest

Parameters:

child - Child Manifest to add. Expected to be assistance content.

See Also:

IsManifest.setChildManifests(List)

discoverTutorStrategyType

public TutorStrategyType discoverTutorStrategyType(Manifest tutoringSetManifest)
                                            throws java.lang.IllegalArgumentException

Returns the type of tutoring contained in a Tutoring Set.

Parameters:

tutoringSetManifest - Manifest with a TutoringSet content type.

Returns:

The tutor strategy type of the Tutoring Set

Throws:

java.lang.IllegalArgumentException - If tutoringSetManifest does not represent a TutoringSet

java.lang.IllegalArgumentException

getTutoringOfType

public Manifest getTutoringOfType(TutorStrategyType type)

getHints

public Manifest getHints()

getScaffolding

public Manifest getScaffolding()

getWorkedExamples

public Manifest getWorkedExamples()

getURLLinks

public Manifest getURLLinks()

setTutoringOrder

public void setTutoringOrder(TutorStrategyType... types)

setTutoringOrder

public void setTutoringOrder(java.util.List<TutorStrategyType> types)

getTutoringOrder

public java.util.List<TutorStrategyType> getTutoringOrder()

getNextPreferredTutoring

public Manifest getNextPreferredTutoring()

Returns the next available preferred tutoring content.

Returns:

The next preferred tutoring content, or null if none exists.

See Also:

setTutoringOrder(TutorStrategyType...), setTutoringOrder(List), getTutoringOrder()

flatten

public java.util.List<java.lang.String> flatten()

Description copied from interface: IsManifest

Returns a list of Persistence Keys for all of objects referenced by this manifest. This includes referenced assessment objects, assistance objects, and child manifest objects.

Specified by:

flatten in interface IsManifest<Manifest,Manifest>

Overrides:

flatten in class Manifest

See Also:

Persistable, IsManifest.getContentKey(), HasTutoring.getTutoringKey(), IsManifest.getChildManifests()

toString

public java.lang.String toString()

Description copied from class: Persistable

Returns a string representation of this object.

Specified by:

toString in interface IsManifest<Manifest,Manifest>

Specified by:

toString in interface IsPersistable

Overrides:

toString in class Manifest

toString

public java.lang.String toString(java.lang.String indent)

Overrides:

toString in class Manifest