Block (SurveyMan 1.6.7 API)

java.lang.Object
- edu.umass.cs.surveyman.survey.SurveyObj
- - edu.umass.cs.surveyman.survey.Block

All Implemented Interfaces:

Serializable, Comparable
```
public class Block
extends SurveyObj
implements Comparable, Serializable
```
Blocks are the basic unit of state in the survey. They are used to specify control flow. Blocks may contain questions. The order of these questions within the block may be randomized. If the user does not want questions randomized within a block, they must place each question in its own, stationary (non-randomizable) block.

The order of blocks may be randomized.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Block.BranchParadigm
"Branching" refers to atypical control flow in the survey.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Block.BranchParadigm` "Branching" refers to atypical control flow in the survey.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Block.BranchParadigm`	`branchParadigm` The branch paradigm associated with this block.
`Question`	`branchQ` The branch question associated with this block.
`static String`	`NEXT` The next pointer.
`Block`	`parentBlock` The parent pointer for this block.
`List<Question>`	`questions` The questions that reside directly in this block (not in sub-blocks).
`List<Block>`	`subBlocks` The sub-blocks that this block contains.

Constructor Summary

Constructors
Constructor and Description

Block(String strId)
Constructs a block with the appropriate string id.

Constructors
Constructor and Description
`Block(String strId)` Constructs a block with the appropriate string id.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBlock(Block b)` Method to add a subblock to this block programmatically.
`void`	`addBranchQuestion(Question q)`
`void`	`addQuestion(Question q)`
`void`	`addQuestions(Question... questions)`
`boolean`	`before(Block that)` Compares this block to the input block.
`int`	`blockSize()` Counts the number of questions directly in this block and in all sub-blocks.
`int`	`compareTo(Object o)` DO NOT CALL COLLECTIONS.SORT IF YOU HAVE FLOATING BLOCKS -- compareTo is transitive and you may get out-of-order blocks.
`boolean`	`containsQuestion(Question question)`
`boolean`	`equals(Object o)` Two blocks are equal if their internal identifiers are equal.
`List<Question>`	`getAllQuestions()` Returns all of the questions for this block and all of its sub-blocks.
`int`	`getBlockDepth()` Returns the depth at which this block exists.
`int[]`	`getBlockId()` Returns the internal block identifier.
`Set<Block>`	`getBranchDestinations()`
`Block.BranchParadigm`	`getBranchParadigm()` Gets the branch paradigm type.
`Block`	`getFarthestContainingBlock()` Returns the topmost block of this block; if this block is top-level, it returns itself.
`String`	`getParentStrId()` Returns the parent block's source identifier string.
`static List<Block>`	`getSorted(List<Block> blockList)` Sorts the input block list.
`String`	`getStrId()` Returns the identifier for this block in the source file.
`boolean`	`hasBranchQuestion()`
`int`	`hashCode()` Hashed on the internal block identifier.
`static int[]`	`idToArray(String strId)` Returns a parsed, internal representation of the input identifier string.
`static String`	`idToString(int[] id, Map<String,Block> blockMap)` Converts an internal block identifier to the string block identifier, according to the language/format specified for CSVs.
`static boolean`	`isRandomizable(String strId)` Returns whether a block with the input id "float."
`boolean`	`isRandomized()` Returns whether this block may be shuffled along with other "floating" blocks and questions inside its containing block.
`boolean`	`isSubblockOf(Block b)` Compares this block with the input block and returns true if the input is a descendant of this block.
`boolean`	`isTopLevel()` Returns whether this block is at the top of the survey (has no parents).
`String`	`jsonize()`
`static String`	`jsonize(List<Block> blockList)`
`void`	`propagateBranchParadigm()` Sets the appropriate `Block.BranchParadigm` for all connected blocks.
`void`	`setIdArray(int[] id)` Sets this block's internal block identifier to the input internal block identifier.
`void`	`setParentPointer()` Sets the parent pointer of this block, according to its source string identifier.
`void`	`setStrId(String strId)` Sets the source identifier for this block.
`static Block[]`	`shuffle(List<Block> blockList)` Shuffles the input block list, respecting static vs floating blocks.
`String`	`toString()` Composed of the block identifier and the string representation of its containing questions and sub-blocks.
`void`	`updateBranchParadigm(Block.BranchParadigm branchParadigm)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NEXT
```
public static final String NEXT
```
    The next pointer.
    
    See Also:
    Constant Field Values
  - questions
```
public List<Question> questions
```
    The questions that reside directly in this block (not in sub-blocks).
  - branchQ
```
public Question branchQ
```
    The branch question associated with this block. If the branch question is derived from an ALL block, this is just set to an arbitrary question within that block. It is used for debugging purposes.
  - branchParadigm
```
protected Block.BranchParadigm branchParadigm
```
    The branch paradigm associated with this block.
  - subBlocks
```
public List<Block> subBlocks
```
    The sub-blocks that this block contains.
  - parentBlock
```
public Block parentBlock
```
    The parent pointer for this block. This is null if the block is top-level.
- Constructor Detail
  - Block
```
public Block(String strId)
```
    Constructs a block with the appropriate string id.
    
    Parameters:
    strId - The source identifier string.
- Method Detail
  - getStrId
```
public String getStrId()
```
    Returns the identifier for this block in the source file.
    
    Returns:
    The String representation of the source identifier.
  - setStrId
```
public void setStrId(String strId)
```
    Sets the source identifier for this block.
    
    Parameters:
    strId - The source identifier string.
  - isRandomizable
```
public static boolean isRandomizable(String strId)
```
    Returns whether a block with the input id "float."
    
    Parameters:
    strId - The source identifier string.
    
    Returns:
    boolean indicating whether this is a floating block..
  - idToArray
```
public static int[] idToArray(String strId)
```
    Returns a parsed, internal representation of the input identifier string.
    
    Parameters:
    strId - The source identifier string.
    
    Returns:
    array representation of the block id, where length is the depth of the block, and randomization flags removed.
  - getParentStrId
```
public String getParentStrId()
```
    Returns the parent block's source identifier string.
    
    Returns:
    The source identifier string of the parent.
  - idToString
```
public static String idToString(int[] id,
                Map<String,Block> blockMap)
```
    Converts an internal block identifier to the string block identifier, according to the language/format specified for CSVs.
    
    Parameters:
    id - A SurveyMan internal block identifier.
    
    Returns:
    A String of that identifier.
  - setParentPointer
```
public void setParentPointer()
```
    Sets the parent pointer of this block, according to its source string identifier.
  - updateBranchParadigm
```
public void updateBranchParadigm(Block.BranchParadigm branchParadigm)
```
  - getBranchParadigm
```
public Block.BranchParadigm getBranchParadigm()
```
    Gets the branch paradigm type.
    
    Returns:
    BranchParadigm enum, corresponding to this block's branching type.
  - propagateBranchParadigm
```
public void propagateBranchParadigm()
                             throws SurveyException
```
    Sets the appropriate Block.BranchParadigm for all connected blocks.
    
    Throws:
    
    SurveyException
  - isRandomized
```
public boolean isRandomized()
```
    Returns whether this block may be shuffled along with other "floating" blocks and questions inside its containing block.
    
    Returns:
    Boolean indicating whether this block "floats".
  - isTopLevel
```
public boolean isTopLevel()
```
    Returns whether this block is at the top of the survey (has no parents).
    
    Returns:
    Boolean for whether this block is top-level.
  - before
```
public boolean before(Block that)
```
    Compares this block to the input block. Only static blocks that are not directly related to each other (neither ancestors nor descendants) can be compared. All other blocks return false (conflation of false and bottom).
    
    Parameters:
    that - The block to compare.
    
    Returns:
    Boolean indicating whether the input precedes this block.
  - isSubblockOf
```
public boolean isSubblockOf(Block b)
```
    Compares this block with the input block and returns true if the input is a descendant of this block.
    
    Parameters:
    b - The block to compare.
    
    Returns:
    Boolean indicating whether the input is a descendant (not direct sub-block).
  - setIdArray
```
public void setIdArray(int[] id)
```
    Sets this block's internal block identifier to the input internal block identifier.
    
    Parameters:
    id - The input block identifier.
  - getBlockDepth
```
public int getBlockDepth()
```
    Returns the depth at which this block exists. Equivalent to the number of ancestors, plus one.
    
    Returns:
    The number of ancestor blocks plus one.
  - getBlockId
```
public int[] getBlockId()
```
    Returns the internal block identifier.
    
    Returns:
    The internal block identifier.
  - getSorted
```
public static List<Block> getSorted(List<Block> blockList)
```
    Sorts the input block list. This must be used instead of Collections.getSorted, which will throw an error, due to inappropriate behavior in compareTo.
    
    Parameters:
    blockList - The block list to be sorted
    
    Returns:
    A sorted block list.
  - blockSize
```
public int blockSize()
```
    Counts the number of questions directly in this block and in all sub-blocks.
    
    Returns:
    The total number of questions in this block and all of its descendants.
  - equals
```
public boolean equals(Object o)
```
    Two blocks are equal if their internal identifiers are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The object to compare.
    
    Returns:
    The usual.
  - hashCode
```
public int hashCode()
```
    Hashed on the internal block identifier.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The usual.
  - getAllQuestions
```
public List<Question> getAllQuestions()
```
    Returns all of the questions for this block and all of its sub-blocks. The instance version of that other one.
    
    Returns:
    A list of all the questions this block and its descendants contain.
  - containsQuestion
```
public boolean containsQuestion(Question question)
```
  - shuffle
```
public static Block[] shuffle(List<Block> blockList)
```
    Shuffles the input block list, respecting static vs floating blocks.
    
    Parameters:
    blockList - The block list to be shuffled.
    
    Returns:
    A shuffled Block array.
  - jsonize
```
public String jsonize()
               throws SurveyException
```
    Throws:
    
    SurveyException
  - jsonize
```
public static String jsonize(List<Block> blockList)
                      throws SurveyException
```
    Throws:
    
    SurveyException
  - hasBranchQuestion
```
public boolean hasBranchQuestion()
```
  - getBranchDestinations
```
public Set<Block> getBranchDestinations()
```
  - addBranchQuestion
```
public void addBranchQuestion(Question q)
```
  - addQuestion
```
public void addQuestion(Question q)
                 throws SurveyException
```
    Throws:
    
    SurveyException
  - addQuestions
```
public void addQuestions(Question... questions)
                  throws SurveyException
```
    Throws:
    
    SurveyException
  - addBlock
```
public void addBlock(Block b)
              throws SurveyException
```
    Method to add a subblock to this block programmatically.
    
    Parameters:
    b - The block we want to add as a subblock.
    
    Throws:
    
    SurveyException
  - getFarthestContainingBlock
```
public Block getFarthestContainingBlock()
```
    Returns the topmost block of this block; if this block is top-level, it returns itself.
    
    Returns:
    Farthest containing block.
  - toString
```
public String toString()
```
    Composed of the block identifier and the string representation of its containing questions and sub-blocks.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this block.
  - compareTo
```
public int compareTo(Object o)
```
    DO NOT CALL COLLECTIONS.SORT IF YOU HAVE FLOATING BLOCKS -- compareTo is transitive and you may get out-of-order blocks. Call Block.getSorted instead.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    o - The object to compare.
    
    Returns:
    int if you're lucky, RuntimeException if you're not.

Class Block

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEXT

questions

branchQ

branchParadigm

subBlocks

parentBlock

Constructor Detail

Block

Method Detail

getStrId

setStrId

isRandomizable

idToArray

getParentStrId

idToString

setParentPointer

updateBranchParadigm

getBranchParadigm

propagateBranchParadigm

isRandomized

isTopLevel

before

isSubblockOf

setIdArray

getBlockDepth

getBlockId

getSorted

blockSize

equals

hashCode

getAllQuestions

containsQuestion

shuffle

jsonize

jsonize

hasBranchQuestion

getBranchDestinations

addBranchQuestion

addQuestion

addQuestions

addBlock

getFarthestContainingBlock

toString

compareTo