org.qtitools.qti.node.item.interaction
Class GapMatchInteraction

java.lang.Object
  org.qtitools.qti.node.AbstractNode
      org.qtitools.qti.node.AbstractObject
          org.qtitools.qti.node.content.BodyElement
              org.qtitools.qti.node.item.interaction.Interaction
                  org.qtitools.qti.node.item.interaction.BlockInteraction
                      org.qtitools.qti.node.item.interaction.GapMatchInteraction

All Implemented Interfaces:

java.io.Serializable, Block, Flow, ObjectFlow, ChoiceContainer, GapChoiceContainer, XmlNode, XmlObject, Validatable

public class GapMatchInteraction
extends BlockInteraction
implements GapChoiceContainer

A gap match interaction is a blockInteraction that contains a number gaps that the candidate can fill from an associated set of choices. The candidate must be able to review the content with the gaps filled in context, as indicated by their choices. The gapMatchInteraction must be bound to a response variable with base-type directedPair and either single or multiple cardinality, depending on the number of gaps. The choices represent the source of the pairing and gaps the targets. Each gap can have at most one choice associated with it. The maximum occurrence of the choices is controlled by the matchMax attribute of gapChoice. Attribute : shuffle [1]: boolean = false If the shuffle attribute is true then the delivery engine must randomize the order in which the choices are presented (not the gaps), subject to the fixed attribute of the choices themselves. Contains : gapChoice [1..*] An ordered list of choices for filling the gaps. There may be fewer choices than gaps if required. Contains : blockStatic [1..*] The content of the interaction is simply a piece of content that contains the gaps. If the block contains more than one gap then the interaction must be bound to a response with multiple cardinality.

Author:

Jonathon Hare

See Also:

Serialized Form

Field Summary

static boolean	ATTR_SHUFFLE_DEFAULT_VALUE Default value of shuffle attribute.
static java.lang.String	ATTR_SHUFFLE_NAME Name of shuffle attribute in xml schema.
static java.lang.String	CLASS_TAG Name of this class in xml schema.

Fields inherited from class org.qtitools.qti.node.item.interaction.Interaction

ATTR_RESPONSE_IDENTIFIER_NAME, CLASS_TAG_SUFFIX, DISPLAY_NAME

Fields inherited from class org.qtitools.qti.node.content.BodyElement

ATTR_CLASS_NAME, ATTR_ID_NAME, ATTR_LABEL_NAME, ATTR_LANG_NAME

Fields inherited from interface org.qtitools.qti.node.XmlNode

INDENT, NEW_LINE, SIMPLE_NAME_INNER_SEPARATOR, SIMPLE_NAMES_SEPARATOR

Fields inherited from interface org.qtitools.qti.node.content.basic.Block

DISPLAY_NAME

Fields inherited from interface org.qtitools.qti.node.content.basic.Flow

DISPLAY_NAME

Constructor Summary

GapMatchInteraction(XmlObject parent)
Construct new interaction.

Method Summary

java.util.List<BlockStatic>	getBlockStatics() Gets blockStatic children.
java.util.List<? extends XmlNode>	getChildren() Gets an unmodifiable list of the child elements.
java.lang.String	getClassTag() Gets QTI class name of this node.
GapChoice	getGapChoice(java.lang.String identifier) Gets gapChoice child with given identifier or null.
java.util.List<GapChoice>	getGapChoices() Gets gapChoice children.
java.lang.Boolean	getShuffle() Gets value of shuffle attribute.
java.util.List<java.lang.String>	getShuffledOrder() If the interaction supports shuffling, then this method should return an ordered list of the shuffled elements' identifiers.
void	initialize() Initialize the interaction.
void	setShuffle(java.lang.Boolean shuffle) Sets new value of shuffle attribute.
ValidationResult	validate() Validates this object.

Methods inherited from class org.qtitools.qti.node.item.interaction.BlockInteraction

getPrompt, setPrompt

Methods inherited from class org.qtitools.qti.node.item.interaction.Interaction

beforeProcessResponse, getResponseDeclaration, getResponseIdentifier, processResponse, processResponse, processResponse, setResponseIdentifier, validateResponse

Methods inherited from class org.qtitools.qti.node.content.BodyElement

appendChild, evaluate, getClassAttr, getFirstChild, getId, getLabel, getLang, getLastChild, insertBefore, removeChild, replaceChild, search, search, search, setId, setLabel, setLang

Methods inherited from class org.qtitools.qti.node.AbstractObject

getParent, getParentItem, getParentResult, getParentTest, setParent

Methods inherited from class org.qtitools.qti.node.AbstractNode

attrToXmlString, bodyToXmlString, getAttributes, getFullName, getIndent, getNode, getNode, getNode, getNodeGroups, getParentRoot, getSimpleName, getSourceFile, getSourceNode, getSourceString, getSourceUrl, hasChildNodes, load, load, load, load, loadAttributes, readChild, readChildren, setParent, setSourceFile, setSourceNode, setSourceString, setSourceUrl, toXmlString, toXmlString, validateAttributes, validateChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.qtitools.qti.node.XmlNode

getAttributes, getFullName, getNodeGroups, getParent, getParentRoot, getSimpleName, getSourceFile, getSourceNode, getSourceString, getSourceUrl, hasChildNodes, load, load, load, load, setSourceFile, setSourceNode, setSourceString, setSourceUrl, toXmlString, toXmlString

Field Detail

CLASS_TAG

public static java.lang.String CLASS_TAG

Name of this class in xml schema.

ATTR_SHUFFLE_NAME

public static java.lang.String ATTR_SHUFFLE_NAME

Name of shuffle attribute in xml schema.

ATTR_SHUFFLE_DEFAULT_VALUE

public static boolean ATTR_SHUFFLE_DEFAULT_VALUE

Default value of shuffle attribute.

Constructor Detail

GapMatchInteraction

public GapMatchInteraction(XmlObject parent)

Construct new interaction.

Parameters:

parent - Parent node

Method Detail

setShuffle

public void setShuffle(java.lang.Boolean shuffle)

Sets new value of shuffle attribute.

Parameters:

shuffle - new value of shuffle attribute

See Also:

getShuffle()

getShuffle

public java.lang.Boolean getShuffle()

Gets value of shuffle attribute.

Returns:

value of shuffle attribute

See Also:

setShuffle(java.lang.Boolean)

getGapChoices

public java.util.List<GapChoice> getGapChoices()

Gets gapChoice children.

Returns:

gapChoice children

getBlockStatics

public java.util.List<BlockStatic> getBlockStatics()

Gets blockStatic children.

Returns:

blockStatic children

getGapChoice

public GapChoice getGapChoice(java.lang.String identifier)

Gets gapChoice child with given identifier or null.

Parameters:

identifier - given identifier

Returns:

gapChoice with given identifier or null

validate

public ValidationResult validate()

Description copied from interface: Validatable

Validates this object.

Specified by:

validate in interface Validatable

Overrides:

validate in class Interaction

Returns:

validation result

getClassTag

public java.lang.String getClassTag()

Description copied from interface: XmlNode

Gets QTI class name of this node.

QTI class name has very important role during loading/saving nodes.

For example: Java class name is AssessmentTest; QTI class name is assessmentTest.

Specified by:

getClassTag in interface XmlNode

Specified by:

getClassTag in class AbstractNode

Returns:

QTI class name of this node

initialize

public void initialize()

Description copied from class: Interaction

Initialize the interaction. Subclasses should override this method as required.

Overrides:

initialize in class Interaction

getChildren

public java.util.List<? extends XmlNode> getChildren()

Gets an unmodifiable list of the child elements. Use the other methods on ChoiceInteraction to add children to the correct group.

Overrides:

getChildren in class BlockInteraction

Returns:

List of child nodes

getShuffledOrder

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

Description copied from class: Interaction

If the interaction supports shuffling, then this method should return an ordered list of the shuffled elements' identifiers.

Overrides:

getShuffledOrder in class Interaction

Returns:

Ordered list of identifiers, or null if the interaction doesn't support shuffling