Class StudentGridPrintout

java.lang.Object

StudentGridPrintout

public class StudentGridPrintout
extends java.lang.Object

A class for encapsulating the printout a student gives us when they print their puzzle grid. Parses and recovers from all kinds of weird conditions including weird numbers of columns and rows, missing legends and hints. To use, just construct it from a String, and then use the getters.

Author:

Stephen

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	ORIGINAL_STRING

Constructor Summary

Constructors

Constructor and Description
StudentGridPrintout(java.lang.String str)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	didIncludeBottomLegend() Returns true iff we detected the presence of a bottom legend
boolean	didIncludeSideHint() Returns true iff we found a side hint
boolean	didIncludeSideLegend() Returns true iff we detected the presence of a side legend
boolean	didIncludeTopHint() Returns true iff we found a top hint
java.lang.String	getBottomLegend() Returns the string we detected as the bottom legend
char[][]	getGrid()
java.lang.String	getPrintableGrid()
java.lang.String[]	getSideHint()
java.lang.String[]	getSideLegend() If the side legend is present, this will return that legend as an array of Strings - one for each row
java.lang.String[]	getTopHint() Returns the array of numbers which comprise the top hint

Methods inherited from class java.lang.Object

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

Field Detail

ORIGINAL_STRING

public final java.lang.String ORIGINAL_STRING

Constructor Detail

StudentGridPrintout

public StudentGridPrintout(java.lang.String str)

Method Detail

didIncludeBottomLegend

public boolean didIncludeBottomLegend()

Returns true iff we detected the presence of a bottom legend

didIncludeSideLegend

public boolean didIncludeSideLegend()

Returns true iff we detected the presence of a side legend

didIncludeTopHint

public boolean didIncludeTopHint()

Returns true iff we found a top hint

didIncludeSideHint

public boolean didIncludeSideHint()

Returns true iff we found a side hint

getTopHint

public java.lang.String[] getTopHint()

Returns the array of numbers which comprise the top hint

getBottomLegend

public java.lang.String getBottomLegend()

Returns the string we detected as the bottom legend

getSideLegend

public java.lang.String[] getSideLegend()

If the side legend is present, this will return that legend as an array of Strings - one for each row

getSideHint

public java.lang.String[] getSideHint()

getPrintableGrid

public java.lang.String getPrintableGrid()

getGrid

public char[][] getGrid()