org.assistments.domain.content.tutor

Class Manifest

java.lang.Object

org.assistments.domain.content.tutor.Persistable

org.assistments.domain.content.tutor.Manifest

All Implemented Interfaces:

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

Direct Known Subclasses:

TutorStrategies

public class Manifest
extends Persistable
implements IsManifest<Manifest,Manifest>

Manifest provides an implementation of IsManifest.

The following discusses how to associate and identify the content and tutoring with a Manifest:

Content

• When you have an existing content object, for example an AnswerableProblem, associate that content with a Manifest by calling setContentKey(Persistable).
• Calling getContentAttributes() returns a ContentType specifying the content represented by a Manifest instance.

Tutoring

• When you have an existing tutoring object, for example a TutorStrategies, associate that tutoring content with a Manifest by calling setTutoringKey(Manifest).
• Calling getTutoringType() returns a ContentType specifying the tutoring associated with a Manifest instance.
• ASSISTments provides much flexibility in how you can connect tutoring to a Manifest:
  • A single tutoring strategy, for example a single WorkedExample or a TutoringSet, can be connected to a Manifest.
  • A homogeneous collection of tutoring, for example a pair of alternate Hint Sets, can be connected to a Manifest by providing a nested set of tutoring. For a pair of Hint Sets bundle them together by making them the children of a parent Manifest. Call setTutoringType() passing in the parent Manifest. The navigator type associated with parent Manifest decides which Hint Set to use for a given student.
  • A heterogeneous collection of tutoring, for example a Hint Set, a WorkedExample, and Scaffolding, can be connected to a Manifest by inserting the individual tutoring into a TutorStrategies object. Call setTutoringType() passing in the TutorStrategies. The navigator type associated with parent Manifest decides which Hint Set to use for a given student.
  A single tutoring strategy, for example a single WorkedExample or a TutoringSet, can be connected to a Manifest, or a collection alternate tutoring strategies

The following diagram provides an example hierarchy of the Manifests describing a ProblemSet:

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Manifest>	childManifests
protected static java.util.List<java.lang.String>	propertyKeysForSimpleClassName

Constructor Summary

Constructors

Modifier	Constructor and Description
	Manifest(java.lang.String uid) Constructor
protected	Manifest(java.lang.String classType, java.lang.String uid) Constructor for use by subclasses only

Method Summary

Modifier and Type	Method and Description
void	addChildManifest(Manifest child) Adds a child to this IsManifest.
java.lang.String	addProperty(java.lang.String key, boolean value)
java.lang.String	addProperty(java.lang.String key, int value)
java.lang.String	addProperty(java.lang.String key, long value)
java.lang.String	addProperty(java.lang.String key, java.lang.String value) Adds a property to this IsManifest
boolean	feedBackKeyExists() Indicates whether this object currently has a feedback key associated with it.
java.util.List<java.lang.String>	flatten() Returns a list of Persistence Keys for all of objects referenced by this manifest.
java.util.List<Manifest>	getAllDescendantProblemManifests()
java.util.List<Manifest>	getAllDescendants() Return all of the manifests that are a descendant of this one.
boolean	getBooleanProperty(java.lang.String property, boolean defaultValue)
int	getChildCount() Returns the number of children manifests
Manifest	getChildManifest(java.lang.String manKey) Return the child manifest with the given key, or none if it doesn't exist.
java.util.List<Manifest>	getChildManifests() Returns the children of this manifest.
java.util.List<java.lang.String>	getChildrenContentKeys() Returns a list of Persistence Keys for this manifest's direct children.
static java.lang.String	getClassName()
ContentTypeAttributes	getContentAttributes() Returns the attribute values corresponding to this manifest's assessment content.
java.lang.String	getContentKey() Returns the Persistence Key for the assessment content referenced by this manifest.
java.lang.String	getContentType() Returns the fully specified class name of the referenced assessment content.
Manifest	getDescendantManifest(java.lang.String manKey) If this manifest has a descendant with the given manifest key, return it, otherwise return null.
int	getDescendantProblemCount() Return the total number of problems in this Manifest.
java.lang.String	getFeedbackKey() Get the feedback key associated with this object (if it exists).
int	getIntProperty(java.lang.String property, int defaultValue)
java.lang.String	getNavigatorClass() Returns this Manifest's navigator class name, if any.
Manifest	getParent()
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns the properties assigned to this manifest.
static Manifest	getRoot(Manifest node)
java.util.List<java.lang.String>	getSkillIds() Take the string representation of the skill Ids property, and split it into a list of string ID's, returning a List.
java.lang.String	getStringProperty(java.lang.String property, java.lang.String defaultValue)
java.lang.String	getTerminatorClass() Returns this Manifest's terminator class name, if any.
ContentTypeAttributes	getTutoringAttributes() Returns the attribute values corresponding to this manifest's assistance content.
java.lang.String	getTutoringKey() Returns the Persistence Key for the assistance manifest associated with an object.
java.lang.String	getTutoringType() Returns the fully specified class name of the referenced assistance content.
boolean	hasChildManifestKey(java.lang.String childManifestKey) Returns whether this Manifest contains a particular child Manifest.
boolean	hasChildManifestWithTutoringKey(java.lang.String tutoringKey)
boolean	hasDescendant(Manifest manifest) Determines whether the specified manifest is a child of this manifest.
boolean	hasDescendant(java.lang.String manifestKey)
boolean	hasDescendantWithTutoringKey(java.lang.String tutoringKey) Return whether or not this manifest has a descendant manifest with the tutoring key equal to the given key.
boolean	isContentType(java.lang.String classType) Returns whether the referenced assessment content is of the specified type.
boolean	isNavigatorType(java.lang.String shortNameType) Returns whether this Manifest has a specific Navigator type by name.
boolean	isProblem() Returns whether this manifest represents some type of problem.
boolean	isProblemSet() Returns whether this manifest represents a problem set.
boolean	isScaffolding() Returns whether this Manifest has the property set to say it is a scaffolding manifest.
boolean	isSet() Returns whether this manifest represents any type of set - either a problem set or a tutoring set.
boolean	isSkillBuilderProblem() Returns whether this Manifest is a descendant problem of a Skill Builder
boolean	isTerminatorType(java.lang.String shortNameType) Returns whether this Manifest has a specific Terminator type by name.
boolean	isTutoringItem() Returns whether this manifest represents some type of assistance content.
boolean	isTutoringSet() Returns whether this manifest represents an assistance set.
boolean	isTutoringType(java.lang.String classType) Returns whether the referenced assistance content is of the specified type.
void	setChildManifests(java.util.List<Manifest> childManifests) Specifies a list of children manifests for this manifest.
void	setContentKey(Persistable content) Sets the Persistence Key for the assessment content associated with this manifest.
void	setContentKey(java.lang.String contentKey) Sets the Persistence Key for the assessment content associated with this manifest.
void	setFeedbackKey(java.lang.String feedbackKey) Set the feedback key associated with this object.
void	setParent(Manifest parent)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets caller-defined properties to associate with this manifest.
void	setTutoringKey(Manifest tutoring) Sets the Persistence Key for the assistance manifest associated with an object.
void	setTutoringKey(java.lang.String tutoringKey) Sets the Persistence Key for the assistance manifest associated with an object.
ManifestDTO	toDTO()
java.lang.String	toString() Returns a string representation of this object.
java.lang.String	toString(java.lang.String indent)
java.lang.String	toStringSummary()
java.lang.String	toStringSummary(java.lang.String indent)
java.lang.String	toStringSummary(java.lang.String indent, int childLimit)
void	validate() Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!

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

Field Detail

childManifests

protected java.util.List<Manifest> childManifests

propertyKeysForSimpleClassName

protected static final java.util.List<java.lang.String> propertyKeysForSimpleClassName

Constructor Detail

Manifest

public Manifest(java.lang.String uid)

Constructor

Parameters:

uid - Unique identifier for this Manifest.

See Also:

UIDGenerator

Manifest

protected Manifest(java.lang.String classType,
                   java.lang.String uid)

Constructor for use by subclasses only

Parameters:

classType - Fully specified name subclass name

uid - Unique identifier for this Manifest.

See Also:

UIDGenerator

Method Detail

getClassName

public static java.lang.String getClassName()

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Description copied from interface: IsManifest

Returns the properties assigned to this manifest.

Specified by:

getProperties in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.setProperties(Map)

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from interface: IsManifest

Sets caller-defined properties to associate with this manifest. Any existing properties are replaced by the new properties.

Specified by:

setProperties in interface IsManifest<Manifest,Manifest>

Parameters:

properties - A collection of user-defined (key,value) pairs.

See Also:

IsManifest.getProperties()

addProperty

public java.lang.String addProperty(java.lang.String key,
                                    int value)

Specified by:

addProperty in interface IsManifest<Manifest,Manifest>

addProperty

public java.lang.String addProperty(java.lang.String key,
                                    boolean value)

Specified by:

addProperty in interface IsManifest<Manifest,Manifest>

addProperty

public java.lang.String addProperty(java.lang.String key,
                                    long value)

Specified by:

addProperty in interface IsManifest<Manifest,Manifest>

addProperty

public java.lang.String addProperty(java.lang.String key,
                                    java.lang.String value)

Description copied from interface: IsManifest

Adds a property to this IsManifest

Specified by:

addProperty in interface IsManifest<Manifest,Manifest>

Parameters:

key - Property's key name

value - Property's value

Returns:

If an entry already exists for key, the value being replaced. Otherwise, returns null if a value for key does not already exist.

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>

Returns:

A list of child manifests

getChildCount

public int getChildCount()

Description copied from interface: IsManifest

Returns the number of children manifests

Specified by:

getChildCount in interface IsManifest<Manifest,Manifest>

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>

Parameters:

childManifests - A list of child manifests

addChildManifest

public void addChildManifest(Manifest child)

Description copied from interface: IsManifest

Adds a child to this IsManifest.

Specified by:

addChildManifest in interface IsManifest<Manifest,Manifest>

Parameters:

child - Child manifest to add.

See Also:

IsManifest.setChildManifests(List)

getContentKey

public java.lang.String getContentKey()

Description copied from interface: IsManifest

Returns the Persistence Key for the assessment content referenced by this manifest.

Specified by:

getContentKey in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.setContentKey(String), IsManifest.setContentKey(Persistable), IsManifest.getContentType(), Persistable

setContentKey

public void setContentKey(java.lang.String contentKey)

Description copied from interface: IsManifest

Sets the Persistence Key for the assessment content associated with this manifest.

Specified by:

setContentKey in interface IsManifest<Manifest,Manifest>

Parameters:

contentKey - A Persistence Key

See Also:

IsManifest.setContentKey(Persistable), IsManifest.getContentKey(), IsManifest.getContentType(), Persistable

setContentKey

public void setContentKey(Persistable content)

Description copied from interface: IsManifest

Sets the Persistence Key for the assessment content associated with this manifest.

This is a convenience method providing an alternative to the following:

this.setContentKey(content.getContentKey()):

Specified by:

setContentKey in interface IsManifest<Manifest,Manifest>

Parameters:

content - A Persistable object

See Also:

IsManifest.setContentKey(String), IsManifest.getContentKey(), IsManifest.getContentType(), Persistable

getTutoringKey

public java.lang.String getTutoringKey()

Description copied from interface: HasTutoring

Returns the Persistence Key for the assistance manifest associated with an object.

Specified by:

getTutoringKey in interface HasTutoring

See Also:

HasTutoring.setTutoringKey(String), HasTutoring.setTutoringKey(Manifest), IsManifest, Persistable

setTutoringKey

public void setTutoringKey(java.lang.String tutoringKey)

Description copied from interface: HasTutoring

Sets the Persistence Key for the assistance manifest associated with an object.

Specified by:

setTutoringKey in interface HasTutoring

Parameters:

tutoringKey - A Persistence Key. It is expected this key references a a manifest containing assistance content. content.

See Also:

HasTutoring.setTutoringKey(Manifest), HasTutoring.getTutoringKey(), IsManifest, Persistable

setTutoringKey

public void setTutoringKey(Manifest tutoring)

Description copied from interface: HasTutoring

Sets the Persistence Key for the assistance manifest associated with an object.

This is a convenience method providing an alternative to the following:

this.setTutoringKey(tutoring.getKey()):

Specified by:

setTutoringKey in interface HasTutoring

Parameters:

tutoring - A Manifest object. It is expected this object is a Manifest or Manifest subclass containing assistance content.

See Also:

HasTutoring.setTutoringKey(String), HasTutoring.getTutoringKey(), IsManifest, Persistable

getChildrenContentKeys

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

Description copied from interface: IsManifest

Returns a list of Persistence Keys for this manifest's direct children.

Specified by:

getChildrenContentKeys in interface IsManifest<Manifest,Manifest>

Returns:

a list of Persistence keys.

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>

See Also:

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

getContentAttributes

public ContentTypeAttributes getContentAttributes()

Description copied from interface: IsManifest

Returns the attribute values corresponding to this manifest's assessment content.

Specified by:

getContentAttributes in interface IsManifest<Manifest,Manifest>

See Also:

ContentTypeAttributes, IsManifest.getTutoringAttributes()

getContentType

public java.lang.String getContentType()

Description copied from interface: IsManifest

Returns the fully specified class name of the referenced assessment content. This is a convenience method equivalent to calling:

Persistable.extractType(this.getContentKey()):

Specified by:

getContentType in interface IsManifest<Manifest,Manifest>

Returns:

A fully specified class name.

See Also:

IsManifest.getContentKey(), IsManifest.isContentType(String)

isContentType

public boolean isContentType(java.lang.String classType)

Description copied from interface: IsManifest

Returns whether the referenced assessment content is of the specified type.

Specified by:

isContentType in interface IsManifest<Manifest,Manifest>

Parameters:

classType - The fully specified name of a Content subclass.

Returns:

true if the value returned from IsManifest.getContentType() is identical to classType; otherwise false.

See Also:

IsManifest.getContentType()

isTutoringType

public boolean isTutoringType(java.lang.String classType)

Description copied from interface: IsManifest

Returns whether the referenced assistance content is of the specified type.

Specified by:

isTutoringType in interface IsManifest<Manifest,Manifest>

Parameters:

classType - The fully specified name of a Persistable subclass.

Returns:

true if the value returned from HasTutoring.getTutoringKey() is identical to classType; otherwise false.

See Also:

HasTutoring.getTutoringKey()

getTutoringAttributes

public ContentTypeAttributes getTutoringAttributes()

Description copied from interface: IsManifest

Returns the attribute values corresponding to this manifest's assistance content.

Specified by:

getTutoringAttributes in interface IsManifest<Manifest,Manifest>

See Also:

ContentTypeAttributes, IsManifest.getContentAttributes()

getTutoringType

public java.lang.String getTutoringType()

Description copied from interface: IsManifest

Returns the fully specified class name of the referenced assistance content. This is a convenience method equivalent to calling:

Persistable.extractType(getTutoringKey()):

Specified by:

getTutoringType in interface IsManifest<Manifest,Manifest>

Returns:

A fully specified class name.

See Also:

HasTutoring.getTutoringKey(), IsManifest.isTutoringType(String)

isProblem

public boolean isProblem()

Description copied from interface: IsManifest

Returns whether this manifest represents some type of problem.

Specified by:

isProblem in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.isProblemSet(), IsManifest.isContentType(String), IsManifest.isTutoringType(String)

isProblemSet

public boolean isProblemSet()

Description copied from interface: IsManifest

Returns whether this manifest represents a problem set.

Specified by:

isProblemSet in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.isProblem(), IsManifest.isContentType(String), IsManifest.isTutoringType(String)

isSet

public boolean isSet()

Description copied from interface: IsManifest

Returns whether this manifest represents any type of set - either a problem set or a tutoring set.

Specified by:

isSet in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.isProblemSet(), IsManifest.isTutoringSet()

isTutoringItem

public boolean isTutoringItem()

Description copied from interface: IsManifest

Returns whether this manifest represents some type of assistance content.

Specified by:

isTutoringItem in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.isTutoringSet(), IsManifest.isProblem(), IsManifest.isProblemSet(), IsManifest.isContentType(String), IsManifest.isTutoringType(String)

isTutoringSet

public boolean isTutoringSet()

Description copied from interface: IsManifest

Returns whether this manifest represents an assistance set.

Specified by:

isTutoringSet in interface IsManifest<Manifest,Manifest>

See Also:

IsManifest.isTutoringItem(), IsManifest.isProblem(), IsManifest.isProblemSet(), IsManifest.isContentType(String), IsManifest.isTutoringType(String)

hasDescendant

public boolean hasDescendant(Manifest manifest)

Description copied from interface: IsManifest

Determines whether the specified manifest is a child of this manifest.

Specified by:

hasDescendant in interface IsManifest<Manifest,Manifest>

Parameters:

manifest - Manifest to check as a child.

Returns:

true if manifest is a child of this manifest; otherwise false

getAllDescendants

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

Return all of the manifests that are a descendant of this one.

Returns:

getAllDescendantProblemManifests

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

getDescendantProblemCount

public int getDescendantProblemCount()

Return the total number of problems in this Manifest. Includes the count of all descendant problems.

Returns:

getDescendantManifest

public Manifest getDescendantManifest(java.lang.String manKey)

If this manifest has a descendant with the given manifest key, return it, otherwise return null.

Parameters:

manKey -

Returns:

getChildManifest

public Manifest getChildManifest(java.lang.String manKey)

Return the child manifest with the given key, or none if it doesn't exist.

Parameters:

manKey -

Returns:

hasDescendantWithTutoringKey

public boolean hasDescendantWithTutoringKey(java.lang.String tutoringKey)

Return whether or not this manifest has a descendant manifest with the tutoring key equal to the given key.

Parameters:

tutoringKey -

Returns:

hasDescendant

public boolean hasDescendant(java.lang.String manifestKey)

hasChildManifestWithTutoringKey

public boolean hasChildManifestWithTutoringKey(java.lang.String tutoringKey)

hasChildManifestKey

public boolean hasChildManifestKey(java.lang.String childManifestKey)

Returns whether this Manifest contains a particular child Manifest.

Parameters:

childManifestKey - Persistence key of the Manifest to look for as a child of this Manifest.

Returns:

true if childManifestKey can be found as a child of this Manifest.

getSkillIds

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

Take the string representation of the skill Ids property, and split it into a list of string ID's, returning a List.

Returns:

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 Persistable

toString

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

toStringSummary

public java.lang.String toStringSummary()

toStringSummary

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

toStringSummary

public java.lang.String toStringSummary(java.lang.String indent,
                                        int childLimit)

getIntProperty

public int getIntProperty(java.lang.String property,
                          int defaultValue)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String property,
                                  boolean defaultValue)

getStringProperty

public java.lang.String getStringProperty(java.lang.String property,
                                          java.lang.String defaultValue)

validate

public void validate()
              throws ValidationException

Description copied from interface: SelfValidating

Check this object's data for inconsistencies Subclasses must (by informal contract) implement this method!

Specified by:

validate in interface SelfValidating

Overrides:

validate in class Persistable

Throws:

ValidationException - if the data is invalid

getFeedbackKey

public java.lang.String getFeedbackKey()

Description copied from interface: HasFeedbackKey

Get the feedback key associated with this object (if it exists).

Specified by:

getFeedbackKey in interface HasFeedbackKey

Returns:

feedback key

setFeedbackKey

public void setFeedbackKey(java.lang.String feedbackKey)

Description copied from interface: HasFeedbackKey

Set the feedback key associated with this object. Side-effect: Subsequent calls to HasFeedbackKey.feedBackKeyExists() will return true

Specified by:

setFeedbackKey in interface HasFeedbackKey

Parameters:

feedbackKey - the new feedback key

feedBackKeyExists

public boolean feedBackKeyExists()

Description copied from interface: HasFeedbackKey

Indicates whether this object currently has a feedback key associated with it.

Specified by:

feedBackKeyExists in interface HasFeedbackKey

Returns:

a boolean

isScaffolding

public boolean isScaffolding()

Returns whether this Manifest has the property set to say it is a scaffolding manifest.

getNavigatorClass

public java.lang.String getNavigatorClass()

Description copied from interface: IsManifest

Returns this Manifest's navigator class name, if any.

Specified by:

getNavigatorClass in interface IsManifest<Manifest,Manifest>

Returns:

The navigator class name or null, if not applicable to this Manifest.

getTerminatorClass

public java.lang.String getTerminatorClass()

Description copied from interface: IsManifest

Returns this Manifest's terminator class name, if any.

Specified by:

getTerminatorClass in interface IsManifest<Manifest,Manifest>

Returns:

The terminator class name or null, if not applicable to this Manifest.

isNavigatorType

public boolean isNavigatorType(java.lang.String shortNameType)

Description copied from interface: IsManifest

Returns whether this Manifest has a specific Navigator type by name.

Specified by:

isNavigatorType in interface IsManifest<Manifest,Manifest>

Parameters:

shortNameType - The (not fully specified) Navigator class name. Ex: "LinearNavigator"

Returns:

true if this Manifest has a Navigator of the provided name; otherwise false.

isTerminatorType

public boolean isTerminatorType(java.lang.String shortNameType)

Description copied from interface: IsManifest

Returns whether this Manifest has a specific Terminator type by name.

Specified by:

isTerminatorType in interface IsManifest<Manifest,Manifest>

Parameters:

shortNameType - The (not fully specified) Terminator class name. Ex: "CompleteNTerminator"

Returns:

true if this Manifest has a Terminator of the provided name; otherwise false.

getParent

public Manifest getParent()

setParent

public void setParent(Manifest parent)

getRoot

public static Manifest getRoot(Manifest node)

isSkillBuilderProblem

public boolean isSkillBuilderProblem()

Returns whether this Manifest is a descendant problem of a Skill Builder

toDTO

public ManifestDTO toDTO()