Package ball.game.crossword

Class Puzzle

java.lang.Object

java.util.AbstractMap<K,V>

ball.util.MapView<Coordinate,V>

ball.util.CoordinateMap<Cell>

ball.game.crossword.Puzzle

All Implemented Interfaces:

Serializable, Cloneable, Map<Coordinate,Cell>, SortedMap<Coordinate,Cell>, TableModel

public class Puzzle
extends CoordinateMap<Cell>
implements Cloneable

Crossword Puzzle.

Author:

Allen D. Ball

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Puzzle.Solution	Puzzle Solution.

Nested classes/interfaces inherited from class ball.util.MapView

MapView.EntrySet

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from class ball.util.MapView

entrySet

Method Summary

Modifier and Type	Method	Description
Puzzle	clone()
Map<Label,String>	clues()
Map<String,String>	headers()
boolean	isSolved()	Method to determine if this Puzzle is solved.
static Puzzle	load(String path)	Static method to load an .xd resource or File into a Puzzle.
List<String>	notes()
Puzzle	parent()	Method to get the parent of this Puzzle.
Puzzle	seed()	Method to get the "seed" of this Puzzle.
void	setSolution(Coordinate coordinate, Character character)	Method to set the solution in a Puzzle.
Map<Label,Puzzle.Solution>	solutions()
Stream<Puzzle>	solve(Set<CharSequence> dictionary)	Method to solve a Puzzle.
void	writeTo(OutputStream out)	Method to write Puzzle to an OutputStream in .xd format.
void	writeTo(PrintWriter out)	Method to write Puzzle to a PrintWriter in .xd format.
void	writeTo(Writer out)	Method to write Puzzle to a Writer in .xd format.

Methods inherited from class ball.util.CoordinateMap

addTableModelListener, asList, clear, column, columns, comparator, containsKey, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, firstKey, get, getColumnClass, getColumnCount, getColumnName, getMax, getMaxX, getMaxY, getMin, getMinX, getMinY, getRowCount, getTableModelListeners, getType, getValueAt, headMap, includes, isCellEditable, lastKey, map, put, put, remove, removeTableModelListener, resize, resize, row, rows, setValueAt, subMap, subMap, tailMap

Methods inherited from class ball.util.MapView

entrySet, get

Methods inherited from class java.util.AbstractMap

containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, size

Methods inherited from interface java.util.SortedMap

entrySet, keySet, values

Method Detail

seed

public Puzzle seed()

Method to get the "seed" of this Puzzle.

Returns:

this if parent() is null; the ultimate (first) parent() otherwise.

parent

public Puzzle parent()

Method to get the parent of this Puzzle.

Returns:

The parent of this Puzzle (may be null).

headers

public Map<String,String> headers()

solutions

public Map<Label,Puzzle.Solution> solutions()

clues

public Map<Label,String> clues()

notes

public List<String> notes()

setSolution

public void setSolution(Coordinate coordinate,
                        Character character)

Method to set the solution in a Puzzle.

Parameters:

coordinate - The Coordinate of the Cell..

character - The solution Character.

Throws:

IllegalArgumentException - If any of the Cells are already with a different Character than specified in the String.

isSolved

public boolean isSolved()

Method to determine if this Puzzle is solved.

Returns:

true if the Puzzle is complete; false otherwise.

writeTo

public void writeTo(OutputStream out)
             throws IOException

Method to write Puzzle to an OutputStream in .xd format.

Parameters:

out - The OutputStream.

Throws:

IOException - If the Puzzle cannot be written.

writeTo

public void writeTo(Writer out)
             throws IOException

Method to write Puzzle to a Writer in .xd format.

Parameters:

out - The OutputStream.

Throws:

IOException - If the Puzzle cannot be written.

writeTo

public void writeTo(PrintWriter out)
             throws IOException

Method to write Puzzle to a PrintWriter in .xd format.

Parameters:

out - The OutputStream.

Throws:

IOException - If the Puzzle cannot be written.

solve

public Stream<Puzzle> solve(Set<CharSequence> dictionary)

Method to solve a Puzzle.

Parameters:

dictionary - The Set of possible solutions.

Returns:

A Stream of possible solutions.

clone

public Puzzle clone()
             throws CloneNotSupportedException

Overrides:

clone in class AbstractMap<Coordinate,Cell>

Throws:

CloneNotSupportedException

load

public static Puzzle load(String path)
                   throws IOException

Static method to load an .xd resource or File into a Puzzle.

Parameters:

path - The resource path.

Returns:

The Puzzle.

Throws:

IOException - If the path cannot be parsed.